plaid 14.14.0 → 15.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (595) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +705 -185
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +1 -1
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +1 -1
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +1 -1
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_product_access.rb +1 -1
  19. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  20. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  21. data/lib/plaid/models/account_subtype.rb +1 -1
  22. data/lib/plaid/models/account_type.rb +1 -1
  23. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  24. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  25. data/lib/plaid/models/accounts_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_response.rb +1 -1
  28. data/lib/plaid/models/ach_class.rb +1 -1
  29. data/lib/plaid/models/address.rb +1 -1
  30. data/lib/plaid/models/address_data.rb +1 -1
  31. data/lib/plaid/models/address_data_nullable.rb +1 -1
  32. data/lib/plaid/models/address_nullable.rb +1 -1
  33. data/lib/plaid/models/application.rb +1 -1
  34. data/lib/plaid/models/application_get_request.rb +1 -1
  35. data/lib/plaid/models/application_get_response.rb +1 -1
  36. data/lib/plaid/models/apr.rb +1 -1
  37. data/lib/plaid/models/asset_report.rb +1 -1
  38. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  39. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  40. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  41. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  42. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  43. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  44. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  45. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  46. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  47. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  48. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_item.rb +1 -1
  51. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  53. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  54. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  55. data/lib/plaid/models/asset_report_relay_create_request.rb +271 -0
  56. data/lib/plaid/models/asset_report_relay_create_response.rb +240 -0
  57. data/lib/plaid/models/asset_report_relay_get_request.rb +245 -0
  58. data/lib/plaid/models/{income_verification_paystub_get_request.rb → asset_report_relay_refresh_request.rb} +25 -22
  59. data/lib/plaid/models/{income_verification_paystub_get_response.rb → asset_report_relay_refresh_response.rb} +15 -24
  60. data/lib/plaid/models/asset_report_relay_remove_request.rb +245 -0
  61. data/lib/plaid/models/asset_report_relay_remove_response.rb +240 -0
  62. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  63. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_transaction.rb +3 -3
  65. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  66. data/lib/plaid/models/asset_report_user.rb +1 -1
  67. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  68. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  69. data/lib/plaid/models/assets_relay_webhook.rb +299 -0
  70. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  71. data/lib/plaid/models/auth_get_request.rb +1 -1
  72. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  73. data/lib/plaid/models/auth_get_response.rb +1 -1
  74. data/lib/plaid/models/auth_metadata.rb +1 -1
  75. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  76. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  77. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  78. data/lib/plaid/models/bank_transfer.rb +1 -1
  79. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  80. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  81. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  82. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  83. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  84. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  85. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  86. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  87. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  88. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
  89. data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
  90. data/lib/plaid/models/bank_transfer_event_list_request.rb +3 -51
  91. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  92. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  93. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  111. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  112. data/lib/plaid/models/categories_get_response.rb +1 -1
  113. data/lib/plaid/models/category.rb +1 -1
  114. data/lib/plaid/models/cause.rb +1 -1
  115. data/lib/plaid/models/client_provided_enhanced_transaction.rb +284 -0
  116. data/lib/plaid/models/client_provided_raw_transaction.rb +270 -0
  117. data/lib/plaid/models/connected_application.rb +1 -1
  118. data/lib/plaid/models/country_code.rb +1 -1
  119. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  120. data/lib/plaid/models/credit_bank_income.rb +261 -0
  121. data/lib/plaid/models/credit_bank_income_account.rb +270 -0
  122. data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
  123. data/lib/plaid/models/credit_bank_income_category.rb +48 -0
  124. data/lib/plaid/models/{income_verification_summary_get_request.rb → credit_bank_income_get_request.rb} +18 -22
  125. data/lib/plaid/models/credit_bank_income_get_request_options.rb +222 -0
  126. data/lib/plaid/models/{income_verification_summary_get_response.rb → credit_bank_income_get_response.rb} +13 -28
  127. data/lib/plaid/models/credit_bank_income_historical_summary.rb +273 -0
  128. data/lib/plaid/models/credit_bank_income_item.rb +274 -0
  129. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +42 -0
  130. data/lib/plaid/models/credit_bank_income_source.rb +309 -0
  131. data/lib/plaid/models/credit_bank_income_summary.rb +303 -0
  132. data/lib/plaid/models/credit_bank_income_transaction.rb +304 -0
  133. data/lib/plaid/models/credit_card_liability.rb +6 -22
  134. data/lib/plaid/models/credit_filter.rb +1 -1
  135. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  136. data/lib/plaid/models/deductions.rb +1 -1
  137. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  138. data/lib/plaid/models/deductions_total.rb +1 -1
  139. data/lib/plaid/models/default_update_webhook.rb +1 -1
  140. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  141. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  142. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  143. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  144. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  145. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  146. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  147. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  148. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  149. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  150. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  151. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  152. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  153. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  154. data/lib/plaid/models/depository_filter.rb +1 -1
  155. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  156. data/lib/plaid/models/doc_type.rb +1 -1
  157. data/lib/plaid/models/document_metadata.rb +1 -1
  158. data/lib/plaid/models/earnings.rb +1 -1
  159. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  160. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  161. data/lib/plaid/models/earnings_total.rb +1 -1
  162. data/lib/plaid/models/email.rb +1 -1
  163. data/lib/plaid/models/employee.rb +1 -1
  164. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  165. data/lib/plaid/models/employer.rb +1 -1
  166. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  167. data/lib/plaid/models/employer_verification.rb +1 -1
  168. data/lib/plaid/models/employers_search_request.rb +1 -1
  169. data/lib/plaid/models/employers_search_response.rb +1 -1
  170. data/lib/plaid/models/employment_details.rb +1 -1
  171. data/lib/plaid/models/employment_verification.rb +1 -1
  172. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  173. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  174. data/lib/plaid/models/employment_verification_status.rb +1 -1
  175. data/lib/plaid/models/enhancements.rb +298 -0
  176. data/lib/plaid/models/error.rb +1 -1
  177. data/lib/plaid/models/external_payment_initiation_consent_options.rb +249 -0
  178. data/lib/plaid/models/external_payment_options.rb +1 -1
  179. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  180. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  181. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  182. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  183. data/lib/plaid/models/health_incident.rb +1 -1
  184. data/lib/plaid/models/historical_balance.rb +1 -1
  185. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  186. data/lib/plaid/models/holding.rb +1 -1
  187. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  188. data/lib/plaid/models/holdings_override.rb +1 -1
  189. data/lib/plaid/models/identity_default_update_webhook.rb +286 -0
  190. data/lib/plaid/models/identity_get_request.rb +1 -1
  191. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  192. data/lib/plaid/models/identity_get_response.rb +1 -1
  193. data/lib/plaid/models/identity_update_types.rb +41 -0
  194. data/lib/plaid/models/incident_update.rb +1 -1
  195. data/lib/plaid/models/income_breakdown.rb +1 -1
  196. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  197. data/lib/plaid/models/income_override.rb +1 -1
  198. data/lib/plaid/models/income_summary.rb +1 -1
  199. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  200. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  201. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  202. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  203. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  204. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  205. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  206. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  207. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  208. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  209. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  210. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  211. data/lib/plaid/models/income_verification_precheck_military_info.rb +2 -36
  212. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  213. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  214. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  215. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  216. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  217. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  218. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  219. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  220. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  221. data/lib/plaid/models/inflow_model.rb +2 -2
  222. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  223. data/lib/plaid/models/institution.rb +3 -3
  224. data/lib/plaid/models/institution_status.rb +1 -1
  225. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  226. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  227. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  228. data/lib/plaid/models/institutions_get_request.rb +2 -2
  229. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  230. data/lib/plaid/models/institutions_get_response.rb +1 -1
  231. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  232. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  233. data/lib/plaid/models/institutions_search_request.rb +1 -1
  234. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  235. data/lib/plaid/models/institutions_search_response.rb +1 -1
  236. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  237. data/lib/plaid/models/investment_filter.rb +2 -2
  238. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  239. data/lib/plaid/models/investment_transaction.rb +3 -51
  240. data/lib/plaid/models/investment_transaction_subtype.rb +82 -0
  241. data/lib/plaid/models/investment_transaction_type.rb +43 -0
  242. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  243. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  244. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  245. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  246. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  247. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  248. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  249. data/lib/plaid/models/item.rb +1 -1
  250. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  251. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  252. data/lib/plaid/models/item_application_list_request.rb +1 -1
  253. data/lib/plaid/models/item_application_list_response.rb +1 -1
  254. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  255. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  256. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  257. data/lib/plaid/models/item_error_webhook.rb +1 -1
  258. data/lib/plaid/models/item_get_request.rb +1 -1
  259. data/lib/plaid/models/item_get_response.rb +1 -1
  260. data/lib/plaid/models/item_import_request.rb +1 -1
  261. data/lib/plaid/models/item_import_request_options.rb +1 -1
  262. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  263. data/lib/plaid/models/item_import_response.rb +1 -1
  264. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  265. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  266. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  267. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  268. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  269. data/lib/plaid/models/item_remove_request.rb +1 -1
  270. data/lib/plaid/models/item_remove_response.rb +1 -1
  271. data/lib/plaid/models/item_status.rb +1 -1
  272. data/lib/plaid/models/item_status_investments.rb +1 -1
  273. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  274. data/lib/plaid/models/item_status_nullable.rb +1 -1
  275. data/lib/plaid/models/item_status_transactions.rb +1 -1
  276. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  277. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  278. data/lib/plaid/models/jwk_public_key.rb +1 -1
  279. data/lib/plaid/models/jwt_header.rb +1 -1
  280. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  281. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  282. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  283. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  284. data/lib/plaid/models/liabilities_object.rb +1 -1
  285. data/lib/plaid/models/liability_override.rb +1 -1
  286. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  287. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  288. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  289. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  290. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  291. data/lib/plaid/models/link_token_create_request.rb +1 -1
  292. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  293. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  294. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  295. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  296. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  297. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  298. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  299. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  300. data/lib/plaid/models/link_token_create_response.rb +1 -1
  301. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  302. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  303. data/lib/plaid/models/link_token_get_request.rb +1 -1
  304. data/lib/plaid/models/link_token_get_response.rb +1 -1
  305. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  306. data/lib/plaid/models/loan_filter.rb +1 -1
  307. data/lib/plaid/models/location.rb +1 -1
  308. data/lib/plaid/models/meta.rb +1 -1
  309. data/lib/plaid/models/mfa.rb +1 -1
  310. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  311. data/lib/plaid/models/mortgage_liability.rb +1 -1
  312. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  313. data/lib/plaid/models/net_pay.rb +1 -1
  314. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  315. data/lib/plaid/models/numbers.rb +1 -1
  316. data/lib/plaid/models/numbers_ach.rb +1 -1
  317. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  318. data/lib/plaid/models/numbers_bacs.rb +1 -1
  319. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  320. data/lib/plaid/models/numbers_eft.rb +1 -1
  321. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  322. data/lib/plaid/models/numbers_international.rb +1 -1
  323. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  324. data/lib/plaid/models/override_account_type.rb +1 -1
  325. data/lib/plaid/models/override_accounts.rb +1 -1
  326. data/lib/plaid/models/owner.rb +1 -1
  327. data/lib/plaid/models/owner_override.rb +1 -1
  328. data/lib/plaid/models/pay.rb +1 -1
  329. data/lib/plaid/models/pay_frequency.rb +1 -1
  330. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  331. data/lib/plaid/models/pay_period_details.rb +1 -1
  332. data/lib/plaid/models/payment_amount.rb +2 -48
  333. data/lib/plaid/models/payment_amount_currency.rb +39 -0
  334. data/lib/plaid/models/payment_channel.rb +40 -0
  335. data/lib/plaid/models/payment_consent_max_payment_amount.rb +246 -0
  336. data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
  337. data/lib/plaid/models/payment_consent_periodic_amount.rb +247 -0
  338. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +246 -0
  339. data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
  340. data/lib/plaid/models/payment_consent_valid_date_time.rb +230 -0
  341. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  342. data/lib/plaid/models/payment_initiation_consent.rb +357 -0
  343. data/lib/plaid/models/payment_initiation_consent_constraints.rb +240 -0
  344. data/lib/plaid/models/payment_initiation_consent_create_request.rb +373 -0
  345. data/lib/plaid/models/payment_initiation_consent_create_response.rb +254 -0
  346. data/lib/plaid/models/payment_initiation_consent_get_request.rb +266 -0
  347. data/lib/plaid/models/payment_initiation_consent_get_response.rb +380 -0
  348. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +325 -0
  349. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +254 -0
  350. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +266 -0
  351. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +220 -0
  352. data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
  353. data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
  354. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  355. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  356. data/lib/plaid/models/payment_initiation_payment.rb +16 -6
  357. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  358. data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -37
  359. data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
  360. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  361. data/lib/plaid/models/payment_initiation_payment_get_response.rb +12 -2
  362. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  363. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  364. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  365. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -37
  366. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  367. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  368. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  369. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  370. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  371. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  372. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  373. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  374. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  375. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  376. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  377. data/lib/plaid/models/payment_initiation_refund.rb +2 -37
  378. data/lib/plaid/models/payment_initiation_refund_status.rb +41 -0
  379. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  380. data/lib/plaid/models/payment_meta.rb +1 -1
  381. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  382. data/lib/plaid/models/payment_scheme.rb +1 -1
  383. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  384. data/lib/plaid/models/paystub.rb +1 -1
  385. data/lib/plaid/models/paystub_address.rb +1 -1
  386. data/lib/plaid/models/paystub_deduction.rb +1 -1
  387. data/lib/plaid/models/paystub_details.rb +1 -1
  388. data/lib/plaid/models/paystub_employer.rb +1 -1
  389. data/lib/plaid/models/paystub_override.rb +1 -1
  390. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  391. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  392. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  393. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  394. data/lib/plaid/models/paystub_verification.rb +1 -1
  395. data/lib/plaid/models/paystub_verification_status.rb +1 -1
  396. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  397. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  398. data/lib/plaid/models/personal_finance_category.rb +3 -3
  399. data/lib/plaid/models/phone_number.rb +1 -1
  400. data/lib/plaid/models/plaid_error.rb +1 -1
  401. data/lib/plaid/models/platform_ids.rb +1 -1
  402. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  403. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  404. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  405. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  406. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  407. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  408. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  409. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  410. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  411. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  412. data/lib/plaid/models/processor_number.rb +1 -1
  413. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  414. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  415. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  416. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  417. data/lib/plaid/models/product_access.rb +71 -6
  418. data/lib/plaid/models/product_status.rb +1 -1
  419. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  420. data/lib/plaid/models/products.rb +2 -1
  421. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  422. data/lib/plaid/models/pslf_status.rb +1 -1
  423. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  424. data/lib/plaid/models/recipient_bacs.rb +1 -1
  425. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  426. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  427. data/lib/plaid/models/relay_event.rb +40 -0
  428. data/lib/plaid/models/removed_transaction.rb +1 -1
  429. data/lib/plaid/models/requested_scopes.rb +1 -1
  430. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  431. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  432. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  433. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  434. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +2 -17
  435. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  436. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  437. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  438. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  439. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  440. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  441. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  442. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  443. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  444. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  445. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  446. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  447. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  448. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  449. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  450. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  451. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  452. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  453. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  454. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  455. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  456. data/lib/plaid/models/scopes.rb +1 -1
  457. data/lib/plaid/models/scopes_context.rb +1 -1
  458. data/lib/plaid/models/scopes_nullable.rb +1 -1
  459. data/lib/plaid/models/security.rb +1 -1
  460. data/lib/plaid/models/security_override.rb +1 -1
  461. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  462. data/lib/plaid/models/servicer_address_data.rb +1 -1
  463. data/lib/plaid/models/signal_address_data.rb +1 -1
  464. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  465. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  466. data/lib/plaid/models/signal_device.rb +1 -1
  467. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  468. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  469. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  470. data/lib/plaid/models/signal_person_name.rb +1 -1
  471. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  472. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  473. data/lib/plaid/models/signal_scores.rb +1 -1
  474. data/lib/plaid/models/signal_user.rb +1 -1
  475. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  476. data/lib/plaid/models/standalone_account_type.rb +1 -1
  477. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  478. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  479. data/lib/plaid/models/student_loan.rb +1 -1
  480. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  481. data/lib/plaid/models/student_loan_status.rb +1 -1
  482. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  483. data/lib/plaid/models/taxform.rb +1 -1
  484. data/lib/plaid/models/taxpayer_id.rb +1 -1
  485. data/lib/plaid/models/total.rb +1 -1
  486. data/lib/plaid/models/total_canonical_description.rb +1 -1
  487. data/lib/plaid/models/transaction.rb +3 -3
  488. data/lib/plaid/models/transaction_all_of.rb +1 -1
  489. data/lib/plaid/models/transaction_base.rb +3 -3
  490. data/lib/plaid/models/transaction_code.rb +1 -1
  491. data/lib/plaid/models/transaction_data.rb +1 -1
  492. data/lib/plaid/models/transaction_override.rb +2 -2
  493. data/lib/plaid/models/transaction_stream.rb +1 -1
  494. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  495. data/lib/plaid/models/transactions_enhance_get_request.rb +262 -0
  496. data/lib/plaid/models/transactions_enhance_get_response.rb +227 -0
  497. data/lib/plaid/models/transactions_get_request.rb +1 -1
  498. data/lib/plaid/models/transactions_get_request_options.rb +18 -6
  499. data/lib/plaid/models/transactions_get_response.rb +1 -1
  500. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  501. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  502. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  503. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  504. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  505. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  506. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  507. data/lib/plaid/models/transfer.rb +1 -1
  508. data/lib/plaid/models/transfer_authorization.rb +2 -37
  509. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  510. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  511. data/lib/plaid/models/transfer_authorization_decision.rb +40 -0
  512. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +2 -37
  513. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +42 -0
  514. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  515. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  516. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +2 -37
  517. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +41 -0
  518. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  519. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  520. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  521. data/lib/plaid/models/transfer_create_request.rb +1 -1
  522. data/lib/plaid/models/transfer_create_response.rb +1 -1
  523. data/lib/plaid/models/transfer_event.rb +1 -1
  524. data/lib/plaid/models/transfer_event_list_request.rb +2 -37
  525. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  526. data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
  527. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  528. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  529. data/lib/plaid/models/transfer_event_type.rb +1 -1
  530. data/lib/plaid/models/transfer_failure.rb +1 -1
  531. data/lib/plaid/models/transfer_get_request.rb +1 -1
  532. data/lib/plaid/models/transfer_get_response.rb +1 -1
  533. data/lib/plaid/models/transfer_intent_authorization_decision.rb +40 -0
  534. data/lib/plaid/models/transfer_intent_create.rb +2 -37
  535. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  536. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  537. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  538. data/lib/plaid/models/transfer_intent_get.rb +3 -51
  539. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  540. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  541. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  542. data/lib/plaid/models/transfer_intent_status.rb +40 -0
  543. data/lib/plaid/models/transfer_list_request.rb +1 -1
  544. data/lib/plaid/models/transfer_list_response.rb +1 -1
  545. data/lib/plaid/models/transfer_network.rb +1 -1
  546. data/lib/plaid/models/transfer_repayment.rb +1 -1
  547. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  548. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  549. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  550. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  551. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  552. data/lib/plaid/models/transfer_status.rb +1 -1
  553. data/lib/plaid/models/transfer_sweep.rb +1 -1
  554. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  555. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  556. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  557. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  558. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  559. data/lib/plaid/models/transfer_type.rb +1 -1
  560. data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
  561. data/lib/plaid/models/transfer_user_address_in_response.rb +2 -2
  562. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  563. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  564. data/lib/plaid/models/user_custom_password.rb +1 -1
  565. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  566. data/lib/plaid/models/verification_attribute.rb +1 -1
  567. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  568. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  569. data/lib/plaid/models/verification_status.rb +1 -1
  570. data/lib/plaid/models/w2.rb +1 -1
  571. data/lib/plaid/models/w2_box12.rb +1 -1
  572. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  573. data/lib/plaid/models/wallet_balance.rb +1 -1
  574. data/lib/plaid/models/wallet_get_request.rb +1 -1
  575. data/lib/plaid/models/wallet_get_response.rb +1 -1
  576. data/lib/plaid/models/wallet_transaction.rb +1 -1
  577. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  578. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  579. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  580. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  581. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  582. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  583. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  584. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  585. data/lib/plaid/models/wallet_transactions_list_response.rb +1 -1
  586. data/lib/plaid/models/warning.rb +1 -1
  587. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  588. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  589. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  590. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  591. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  592. data/lib/plaid/version.rb +2 -2
  593. data/lib/plaid.rb +63 -5
  594. data/plaid.gemspec +1 -1
  595. metadata +63 -5
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.78.2
6
+ The version of the OpenAPI document: 2020-09-14_1.79.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -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. 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. 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,6 +1904,71 @@ module Plaid
1644
1904
  return data, status_code, headers
1645
1905
  end
1646
1906
 
1907
+ # Get bank income report(s) for a user
1908
+ # This endpoint gets the bank income report(s) for a specified user.
1909
+ # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
1910
+ # @param [Hash] opts the optional parameters
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)
1914
+ data
1915
+ end
1916
+
1917
+ # Get bank income report(s) for a user
1918
+ # This endpoint gets the bank income report(s) for a specified user.
1919
+ # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
1920
+ # @param [Hash] opts the optional parameters
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 = {})
1923
+ if @api_client.config.debugging
1924
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_get ...'
1925
+ end
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"
1929
+ end
1930
+ # resource path
1931
+ local_var_path = '/credit/bank_income/get'
1932
+
1933
+ # query parameters
1934
+ query_params = opts[:query_params] || {}
1935
+
1936
+ # header parameters
1937
+ header_params = opts[:header_params] || {}
1938
+ # HTTP header 'Accept' (if needed)
1939
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1940
+ # HTTP header 'Content-Type'
1941
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1942
+
1943
+ # form parameters
1944
+ form_params = opts[:form_params] || {}
1945
+
1946
+ # http body (model)
1947
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_get_request)
1948
+
1949
+ # return_type
1950
+ return_type = opts[:debug_return_type] || 'CreditBankIncomeGetResponse'
1951
+
1952
+ # auth_names
1953
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1954
+
1955
+ new_options = opts.merge(
1956
+ :operation => :"PlaidApi.credit_bank_income_get",
1957
+ :header_params => header_params,
1958
+ :query_params => query_params,
1959
+ :form_params => form_params,
1960
+ :body => post_body,
1961
+ :auth_names => auth_names,
1962
+ :return_type => return_type
1963
+ )
1964
+
1965
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1966
+ if @api_client.config.debugging
1967
+ @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1968
+ end
1969
+ return data, status_code, headers
1970
+ end
1971
+
1647
1972
  # Create a deposit switch without using Plaid Exchange
1648
1973
  # 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
1974
  # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
@@ -2229,71 +2554,6 @@ module Plaid
2229
2554
  return data, status_code, headers
2230
2555
  end
2231
2556
 
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
2557
  # Retrieve information from the paystubs used for income verification
2298
2558
  # `/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.
2299
2559
  # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
@@ -2380,75 +2640,10 @@ module Plaid
2380
2640
  end
2381
2641
  # verify the required parameter 'income_verification_precheck_request' is set
2382
2642
  if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
2383
- fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
2384
- end
2385
- # resource path
2386
- local_var_path = '/income/verification/precheck'
2387
-
2388
- # query parameters
2389
- query_params = opts[:query_params] || {}
2390
-
2391
- # header parameters
2392
- header_params = opts[:header_params] || {}
2393
- # HTTP header 'Accept' (if needed)
2394
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2395
- # HTTP header 'Content-Type'
2396
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2397
-
2398
- # form parameters
2399
- form_params = opts[:form_params] || {}
2400
-
2401
- # http body (model)
2402
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_precheck_request)
2403
-
2404
- # return_type
2405
- return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'
2406
-
2407
- # auth_names
2408
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2409
-
2410
- new_options = opts.merge(
2411
- :operation => :"PlaidApi.income_verification_precheck",
2412
- :header_params => header_params,
2413
- :query_params => query_params,
2414
- :form_params => form_params,
2415
- :body => post_body,
2416
- :auth_names => auth_names,
2417
- :return_type => return_type
2418
- )
2419
-
2420
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2421
- if @api_client.config.debugging
2422
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2423
- end
2424
- return data, status_code, headers
2425
- end
2426
-
2427
- # Refresh an income verification
2428
- # `/income/verification/refresh` refreshes a given income verification.
2429
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2430
- # @param [Hash] opts the optional parameters
2431
- # @return [IncomeVerificationRefreshResponse]
2432
- def income_verification_refresh(income_verification_refresh_request, opts = {})
2433
- data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
2434
- data
2435
- end
2436
-
2437
- # Refresh an income verification
2438
- # &#x60;/income/verification/refresh&#x60; refreshes a given income verification.
2439
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2440
- # @param [Hash] opts the optional parameters
2441
- # @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
2442
- def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
2443
- if @api_client.config.debugging
2444
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
2445
- end
2446
- # verify the required parameter 'income_verification_refresh_request' is set
2447
- if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
2448
- fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
2643
+ fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
2449
2644
  end
2450
2645
  # resource path
2451
- local_var_path = '/income/verification/refresh'
2646
+ local_var_path = '/income/verification/precheck'
2452
2647
 
2453
2648
  # query parameters
2454
2649
  query_params = opts[:query_params] || {}
@@ -2464,16 +2659,16 @@ module Plaid
2464
2659
  form_params = opts[:form_params] || {}
2465
2660
 
2466
2661
  # http body (model)
2467
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
2662
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_precheck_request)
2468
2663
 
2469
2664
  # return_type
2470
- return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
2665
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'
2471
2666
 
2472
2667
  # auth_names
2473
2668
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2474
2669
 
2475
2670
  new_options = opts.merge(
2476
- :operation => :"PlaidApi.income_verification_refresh",
2671
+ :operation => :"PlaidApi.income_verification_precheck",
2477
2672
  :header_params => header_params,
2478
2673
  :query_params => query_params,
2479
2674
  :form_params => form_params,
@@ -2484,36 +2679,36 @@ module Plaid
2484
2679
 
2485
2680
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2486
2681
  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}"
2682
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2488
2683
  end
2489
2684
  return data, status_code, headers
2490
2685
  end
2491
2686
 
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]
2687
+ # Refresh an income verification
2688
+ # `/income/verification/refresh` refreshes a given income verification.
2689
+ # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2495
2690
  # @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)
2691
+ # @return [IncomeVerificationRefreshResponse]
2692
+ def income_verification_refresh(income_verification_refresh_request, opts = {})
2693
+ data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
2499
2694
  data
2500
2695
  end
2501
2696
 
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]
2697
+ # Refresh an income verification
2698
+ # &#x60;/income/verification/refresh&#x60; refreshes a given income verification.
2699
+ # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2505
2700
  # @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 = {})
2701
+ # @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
2702
+ def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
2508
2703
  if @api_client.config.debugging
2509
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
2704
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
2510
2705
  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"
2706
+ # verify the required parameter 'income_verification_refresh_request' is set
2707
+ if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
2708
+ fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
2514
2709
  end
2515
2710
  # resource path
2516
- local_var_path = '/income/verification/summary/get'
2711
+ local_var_path = '/income/verification/refresh'
2517
2712
 
2518
2713
  # query parameters
2519
2714
  query_params = opts[:query_params] || {}
@@ -2529,16 +2724,16 @@ module Plaid
2529
2724
  form_params = opts[:form_params] || {}
2530
2725
 
2531
2726
  # http body (model)
2532
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_summary_get_request)
2727
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
2533
2728
 
2534
2729
  # return_type
2535
- return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
2730
+ return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
2536
2731
 
2537
2732
  # auth_names
2538
2733
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2539
2734
 
2540
2735
  new_options = opts.merge(
2541
- :operation => :"PlaidApi.income_verification_summary_get",
2736
+ :operation => :"PlaidApi.income_verification_refresh",
2542
2737
  :header_params => header_params,
2543
2738
  :query_params => query_params,
2544
2739
  :form_params => form_params,
@@ -2549,7 +2744,7 @@ module Plaid
2549
2744
 
2550
2745
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2551
2746
  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}"
2747
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2553
2748
  end
2554
2749
  return data, status_code, headers
2555
2750
  end
@@ -2685,7 +2880,7 @@ module Plaid
2685
2880
  end
2686
2881
 
2687
2882
  # 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.
2883
+ # 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
2884
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2690
2885
  # @param [Hash] opts the optional parameters
2691
2886
  # @return [InstitutionsGetByIdResponse]
@@ -2695,7 +2890,7 @@ module Plaid
2695
2890
  end
2696
2891
 
2697
2892
  # 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.
2893
+ # 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
2894
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2700
2895
  # @param [Hash] opts the optional parameters
2701
2896
  # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
@@ -3335,7 +3530,7 @@ module Plaid
3335
3530
  end
3336
3531
 
3337
3532
  # 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.
3533
+ # 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
3534
  # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
3340
3535
  # @param [Hash] opts the optional parameters
3341
3536
  # @return [ItemPublicTokenExchangeResponse]
@@ -3345,7 +3540,7 @@ module Plaid
3345
3540
  end
3346
3541
 
3347
3542
  # 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.
3543
+ # 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.
3349
3544
  # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
3350
3545
  # @param [Hash] opts the optional parameters
3351
3546
  # @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
@@ -3400,7 +3595,7 @@ module Plaid
3400
3595
  end
3401
3596
 
3402
3597
  # 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.
3598
+ # 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.
3404
3599
  # @param item_remove_request [ItemRemoveRequest]
3405
3600
  # @param [Hash] opts the optional parameters
3406
3601
  # @return [ItemRemoveResponse]
@@ -3410,7 +3605,7 @@ module Plaid
3410
3605
  end
3411
3606
 
3412
3607
  # 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.
3608
+ # 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.
3414
3609
  # @param item_remove_request [ItemRemoveRequest]
3415
3610
  # @param [Hash] opts the optional parameters
3416
3611
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -3465,7 +3660,7 @@ module Plaid
3465
3660
  end
3466
3661
 
3467
3662
  # 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.
3663
+ # 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.
3469
3664
  # @param item_webhook_update_request [ItemWebhookUpdateRequest]
3470
3665
  # @param [Hash] opts the optional parameters
3471
3666
  # @return [ItemWebhookUpdateResponse]
@@ -3475,7 +3670,7 @@ module Plaid
3475
3670
  end
3476
3671
 
3477
3672
  # 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.
3673
+ # 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.
3479
3674
  # @param item_webhook_update_request [ItemWebhookUpdateRequest]
3480
3675
  # @param [Hash] opts the optional parameters
3481
3676
  # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
@@ -3724,6 +3919,266 @@ module Plaid
3724
3919
  return data, status_code, headers
3725
3920
  end
3726
3921
 
3922
+ # Create payment consent
3923
+ # 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.
3924
+ # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
3925
+ # @param [Hash] opts the optional parameters
3926
+ # @return [PaymentInitiationConsentCreateResponse]
3927
+ def payment_initiation_consent_create(payment_initiation_consent_create_request, opts = {})
3928
+ data, _status_code, _headers = payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts)
3929
+ data
3930
+ end
3931
+
3932
+ # Create payment consent
3933
+ # 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.
3934
+ # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
3935
+ # @param [Hash] opts the optional parameters
3936
+ # @return [Array<(PaymentInitiationConsentCreateResponse, Integer, Hash)>] PaymentInitiationConsentCreateResponse data, response status code and response headers
3937
+ def payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts = {})
3938
+ if @api_client.config.debugging
3939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_create ...'
3940
+ end
3941
+ # verify the required parameter 'payment_initiation_consent_create_request' is set
3942
+ if @api_client.config.client_side_validation && payment_initiation_consent_create_request.nil?
3943
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_create_request' when calling PlaidApi.payment_initiation_consent_create"
3944
+ end
3945
+ # resource path
3946
+ local_var_path = '/payment_initiation/consent/create'
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(payment_initiation_consent_create_request)
3963
+
3964
+ # return_type
3965
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentCreateResponse'
3966
+
3967
+ # auth_names
3968
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3969
+
3970
+ new_options = opts.merge(
3971
+ :operation => :"PlaidApi.payment_initiation_consent_create",
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#payment_initiation_consent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3983
+ end
3984
+ return data, status_code, headers
3985
+ end
3986
+
3987
+ # Get payment consent
3988
+ # 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.
3989
+ # @param payment_initiation_consent_get_request [PaymentInitiationConsentGetRequest]
3990
+ # @param [Hash] opts the optional parameters
3991
+ # @return [PaymentInitiationConsentGetResponse]
3992
+ def payment_initiation_consent_get(payment_initiation_consent_get_request, opts = {})
3993
+ data, _status_code, _headers = payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts)
3994
+ data
3995
+ end
3996
+
3997
+ # Get payment consent
3998
+ # 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.
3999
+ # @param payment_initiation_consent_get_request [PaymentInitiationConsentGetRequest]
4000
+ # @param [Hash] opts the optional parameters
4001
+ # @return [Array<(PaymentInitiationConsentGetResponse, Integer, Hash)>] PaymentInitiationConsentGetResponse data, response status code and response headers
4002
+ def payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts = {})
4003
+ if @api_client.config.debugging
4004
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_get ...'
4005
+ end
4006
+ # verify the required parameter 'payment_initiation_consent_get_request' is set
4007
+ if @api_client.config.client_side_validation && payment_initiation_consent_get_request.nil?
4008
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_get_request' when calling PlaidApi.payment_initiation_consent_get"
4009
+ end
4010
+ # resource path
4011
+ local_var_path = '/payment_initiation/consent/get'
4012
+
4013
+ # query parameters
4014
+ query_params = opts[:query_params] || {}
4015
+
4016
+ # header parameters
4017
+ header_params = opts[:header_params] || {}
4018
+ # HTTP header 'Accept' (if needed)
4019
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4020
+ # HTTP header 'Content-Type'
4021
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4022
+
4023
+ # form parameters
4024
+ form_params = opts[:form_params] || {}
4025
+
4026
+ # http body (model)
4027
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_get_request)
4028
+
4029
+ # return_type
4030
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentGetResponse'
4031
+
4032
+ # auth_names
4033
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4034
+
4035
+ new_options = opts.merge(
4036
+ :operation => :"PlaidApi.payment_initiation_consent_get",
4037
+ :header_params => header_params,
4038
+ :query_params => query_params,
4039
+ :form_params => form_params,
4040
+ :body => post_body,
4041
+ :auth_names => auth_names,
4042
+ :return_type => return_type
4043
+ )
4044
+
4045
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4046
+ if @api_client.config.debugging
4047
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4048
+ end
4049
+ return data, status_code, headers
4050
+ end
4051
+
4052
+ # Execute a single payment using consent
4053
+ # The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.
4054
+ # @param payment_initiation_consent_payment_execute_request [PaymentInitiationConsentPaymentExecuteRequest]
4055
+ # @param [Hash] opts the optional parameters
4056
+ # @return [PaymentInitiationConsentPaymentExecuteResponse]
4057
+ def payment_initiation_consent_payment_execute(payment_initiation_consent_payment_execute_request, opts = {})
4058
+ data, _status_code, _headers = payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts)
4059
+ data
4060
+ end
4061
+
4062
+ # Execute a single payment using consent
4063
+ # The &#x60;/payment_initiation/consent/payment/execute&#x60; endpoint can be used to execute payments using payment consent.
4064
+ # @param payment_initiation_consent_payment_execute_request [PaymentInitiationConsentPaymentExecuteRequest]
4065
+ # @param [Hash] opts the optional parameters
4066
+ # @return [Array<(PaymentInitiationConsentPaymentExecuteResponse, Integer, Hash)>] PaymentInitiationConsentPaymentExecuteResponse data, response status code and response headers
4067
+ def payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts = {})
4068
+ if @api_client.config.debugging
4069
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_payment_execute ...'
4070
+ end
4071
+ # verify the required parameter 'payment_initiation_consent_payment_execute_request' is set
4072
+ if @api_client.config.client_side_validation && payment_initiation_consent_payment_execute_request.nil?
4073
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_payment_execute_request' when calling PlaidApi.payment_initiation_consent_payment_execute"
4074
+ end
4075
+ # resource path
4076
+ local_var_path = '/payment_initiation/consent/payment/execute'
4077
+
4078
+ # query parameters
4079
+ query_params = opts[:query_params] || {}
4080
+
4081
+ # header parameters
4082
+ header_params = opts[:header_params] || {}
4083
+ # HTTP header 'Accept' (if needed)
4084
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4085
+ # HTTP header 'Content-Type'
4086
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4087
+
4088
+ # form parameters
4089
+ form_params = opts[:form_params] || {}
4090
+
4091
+ # http body (model)
4092
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_payment_execute_request)
4093
+
4094
+ # return_type
4095
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentPaymentExecuteResponse'
4096
+
4097
+ # auth_names
4098
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4099
+
4100
+ new_options = opts.merge(
4101
+ :operation => :"PlaidApi.payment_initiation_consent_payment_execute",
4102
+ :header_params => header_params,
4103
+ :query_params => query_params,
4104
+ :form_params => form_params,
4105
+ :body => post_body,
4106
+ :auth_names => auth_names,
4107
+ :return_type => return_type
4108
+ )
4109
+
4110
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4111
+ if @api_client.config.debugging
4112
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_payment_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4113
+ end
4114
+ return data, status_code, headers
4115
+ end
4116
+
4117
+ # Revoke payment consent
4118
+ # 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.
4119
+ # @param payment_initiation_consent_revoke_request [PaymentInitiationConsentRevokeRequest]
4120
+ # @param [Hash] opts the optional parameters
4121
+ # @return [PaymentInitiationConsentRevokeResponse]
4122
+ def payment_initiation_consent_revoke(payment_initiation_consent_revoke_request, opts = {})
4123
+ data, _status_code, _headers = payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts)
4124
+ data
4125
+ end
4126
+
4127
+ # Revoke payment consent
4128
+ # 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.
4129
+ # @param payment_initiation_consent_revoke_request [PaymentInitiationConsentRevokeRequest]
4130
+ # @param [Hash] opts the optional parameters
4131
+ # @return [Array<(PaymentInitiationConsentRevokeResponse, Integer, Hash)>] PaymentInitiationConsentRevokeResponse data, response status code and response headers
4132
+ def payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts = {})
4133
+ if @api_client.config.debugging
4134
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_revoke ...'
4135
+ end
4136
+ # verify the required parameter 'payment_initiation_consent_revoke_request' is set
4137
+ if @api_client.config.client_side_validation && payment_initiation_consent_revoke_request.nil?
4138
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_revoke_request' when calling PlaidApi.payment_initiation_consent_revoke"
4139
+ end
4140
+ # resource path
4141
+ local_var_path = '/payment_initiation/consent/revoke'
4142
+
4143
+ # query parameters
4144
+ query_params = opts[:query_params] || {}
4145
+
4146
+ # header parameters
4147
+ header_params = opts[:header_params] || {}
4148
+ # HTTP header 'Accept' (if needed)
4149
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4150
+ # HTTP header 'Content-Type'
4151
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4152
+
4153
+ # form parameters
4154
+ form_params = opts[:form_params] || {}
4155
+
4156
+ # http body (model)
4157
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_revoke_request)
4158
+
4159
+ # return_type
4160
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentRevokeResponse'
4161
+
4162
+ # auth_names
4163
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4164
+
4165
+ new_options = opts.merge(
4166
+ :operation => :"PlaidApi.payment_initiation_consent_revoke",
4167
+ :header_params => header_params,
4168
+ :query_params => query_params,
4169
+ :form_params => form_params,
4170
+ :body => post_body,
4171
+ :auth_names => auth_names,
4172
+ :return_type => return_type
4173
+ )
4174
+
4175
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4176
+ if @api_client.config.debugging
4177
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4178
+ end
4179
+ return data, status_code, headers
4180
+ end
4181
+
3727
4182
  # Create a payment
3728
4183
  # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3729
4184
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
@@ -4245,7 +4700,7 @@ module Plaid
4245
4700
  end
4246
4701
 
4247
4702
  # 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).
4703
+ # 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
4704
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4250
4705
  # @param [Hash] opts the optional parameters
4251
4706
  # @return [ProcessorAuthGetResponse]
@@ -4255,7 +4710,7 @@ module Plaid
4255
4710
  end
4256
4711
 
4257
4712
  # 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).
4713
+ # 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
4714
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4260
4715
  # @param [Hash] opts the optional parameters
4261
4716
  # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
@@ -4505,7 +4960,7 @@ module Plaid
4505
4960
  end
4506
4961
 
4507
4962
  # 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/).
4963
+ # 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
4964
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
4510
4965
  # @param [Hash] opts the optional parameters
4511
4966
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -4515,7 +4970,7 @@ module Plaid
4515
4970
  end
4516
4971
 
4517
4972
  # 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/).
4973
+ # 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
4974
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
4520
4975
  # @param [Hash] opts the optional parameters
4521
4976
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -4570,7 +5025,7 @@ module Plaid
4570
5025
  end
4571
5026
 
4572
5027
  # 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.
5028
+ # 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
5029
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
4575
5030
  # @param [Hash] opts the optional parameters
4576
5031
  # @return [ProcessorTokenCreateResponse]
@@ -4580,7 +5035,7 @@ module Plaid
4580
5035
  end
4581
5036
 
4582
5037
  # 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.
5038
+ # 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
5039
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
4585
5040
  # @param [Hash] opts the optional parameters
4586
5041
  # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
@@ -5609,8 +6064,73 @@ module Plaid
5609
6064
  return data, status_code, headers
5610
6065
  end
5611
6066
 
6067
+ # enhance locally-held transaction data
6068
+ # The '/beta/transactions/v1/enhance' endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
6069
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
6070
+ # @param [Hash] opts the optional parameters
6071
+ # @return [TransactionsEnhanceGetResponse]
6072
+ def transactions_enhance(transactions_enhance_get_request, opts = {})
6073
+ data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
6074
+ data
6075
+ end
6076
+
6077
+ # enhance locally-held transaction data
6078
+ # The &#39;/beta/transactions/v1/enhance&#39; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
6079
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
6080
+ # @param [Hash] opts the optional parameters
6081
+ # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
6082
+ def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
6083
+ if @api_client.config.debugging
6084
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
6085
+ end
6086
+ # verify the required parameter 'transactions_enhance_get_request' is set
6087
+ if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
6088
+ fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
6089
+ end
6090
+ # resource path
6091
+ local_var_path = '/beta/transactions/v1/enhance'
6092
+
6093
+ # query parameters
6094
+ query_params = opts[:query_params] || {}
6095
+
6096
+ # header parameters
6097
+ header_params = opts[:header_params] || {}
6098
+ # HTTP header 'Accept' (if needed)
6099
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6100
+ # HTTP header 'Content-Type'
6101
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6102
+
6103
+ # form parameters
6104
+ form_params = opts[:form_params] || {}
6105
+
6106
+ # http body (model)
6107
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)
6108
+
6109
+ # return_type
6110
+ return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'
6111
+
6112
+ # auth_names
6113
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6114
+
6115
+ new_options = opts.merge(
6116
+ :operation => :"PlaidApi.transactions_enhance",
6117
+ :header_params => header_params,
6118
+ :query_params => query_params,
6119
+ :form_params => form_params,
6120
+ :body => post_body,
6121
+ :auth_names => auth_names,
6122
+ :return_type => return_type
6123
+ )
6124
+
6125
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6126
+ if @api_client.config.debugging
6127
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6128
+ end
6129
+ return data, status_code, headers
6130
+ end
6131
+
5612
6132
  # 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.
6133
+ # 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
6134
  # @param transactions_get_request [TransactionsGetRequest]
5615
6135
  # @param [Hash] opts the optional parameters
5616
6136
  # @return [TransactionsGetResponse]
@@ -5620,7 +6140,7 @@ module Plaid
5620
6140
  end
5621
6141
 
5622
6142
  # 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.
6143
+ # 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
6144
  # @param transactions_get_request [TransactionsGetRequest]
5625
6145
  # @param [Hash] opts the optional parameters
5626
6146
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -5740,7 +6260,7 @@ module Plaid
5740
6260
  end
5741
6261
 
5742
6262
  # 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.
6263
+ # `/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
6264
  # @param transactions_refresh_request [TransactionsRefreshRequest]
5745
6265
  # @param [Hash] opts the optional parameters
5746
6266
  # @return [TransactionsRefreshResponse]
@@ -5750,7 +6270,7 @@ module Plaid
5750
6270
  end
5751
6271
 
5752
6272
  # 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.
6273
+ # &#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
6274
  # @param transactions_refresh_request [TransactionsRefreshRequest]
5755
6275
  # @param [Hash] opts the optional parameters
5756
6276
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers