plaid 14.0.0.beta.2 → 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown

Sign up to get free protection for your applications and to get access to all the features.
Files changed (651) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -1
  3. data/Gemfile.lock +19 -5
  4. data/LICENSE.txt +1 -1
  5. data/Makefile +2 -21
  6. data/PUBLISH.md +2 -3
  7. data/README.md +4 -4
  8. data/lib/plaid/api/plaid_api.rb +274 -116
  9. data/lib/plaid/api_client.rb +2 -2
  10. data/lib/plaid/api_error.rb +2 -2
  11. data/lib/plaid/configuration.rb +2 -2
  12. data/lib/plaid/models/account_assets.rb +3 -3
  13. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  14. data/lib/plaid/models/account_balance.rb +18 -7
  15. data/lib/plaid/models/account_base.rb +3 -3
  16. data/lib/plaid/models/account_filters_response.rb +2 -2
  17. data/lib/plaid/models/account_identity.rb +3 -3
  18. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  19. data/lib/plaid/models/account_subtype.rb +3 -2
  20. data/lib/plaid/models/account_type.rb +2 -2
  21. data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
  22. data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
  23. data/lib/plaid/models/accounts_get_request.rb +4 -4
  24. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  25. data/lib/plaid/models/accounts_get_response.rb +2 -2
  26. data/lib/plaid/models/ach_class.rb +2 -2
  27. data/lib/plaid/models/address.rb +2 -2
  28. data/lib/plaid/models/address_data.rb +2 -2
  29. data/lib/plaid/models/application.rb +273 -0
  30. data/lib/plaid/models/application_get_request.rb +255 -0
  31. data/lib/plaid/models/{link_token_create_request_account_subtypes_investment.rb → application_get_response.rb} +33 -16
  32. data/lib/plaid/models/apr.rb +2 -2
  33. data/lib/plaid/models/asset_report.rb +2 -2
  34. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
  35. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  36. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
  37. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
  38. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  39. data/lib/plaid/models/asset_report_create_request.rb +28 -4
  40. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  41. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  42. data/lib/plaid/models/asset_report_filter_request.rb +4 -4
  43. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  44. data/lib/plaid/models/asset_report_get_request.rb +5 -5
  45. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  46. data/lib/plaid/models/asset_report_item.rb +2 -2
  47. data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
  48. data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
  49. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  50. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  51. data/lib/plaid/models/asset_report_remove_request.rb +4 -4
  52. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  53. data/lib/plaid/models/asset_report_transaction.rb +28 -6
  54. data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
  55. data/lib/plaid/models/asset_report_user.rb +2 -2
  56. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  57. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  58. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  59. data/lib/plaid/models/auth_get_request.rb +4 -4
  60. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  61. data/lib/plaid/models/auth_get_response.rb +2 -2
  62. data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
  63. data/lib/plaid/models/bank_transfer.rb +11 -2
  64. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  65. data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
  66. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  67. data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
  68. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  69. data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
  70. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  71. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  72. data/lib/plaid/models/bank_transfer_event.rb +4 -2
  73. data/lib/plaid/models/bank_transfer_event_list_request.rb +8 -4
  74. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  75. data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
  76. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  77. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  78. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  79. data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
  80. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  81. data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
  82. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  83. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
  84. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_receiver_details.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  89. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  90. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  91. data/lib/plaid/models/categories_get_response.rb +2 -2
  92. data/lib/plaid/models/category.rb +2 -2
  93. data/lib/plaid/models/cause.rb +2 -2
  94. data/lib/plaid/models/country_code.rb +2 -2
  95. data/lib/plaid/models/credit_card_liability.rb +3 -18
  96. data/lib/plaid/models/credit_filter.rb +2 -2
  97. data/lib/plaid/models/default_update_webhook.rb +2 -2
  98. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  99. data/lib/plaid/models/deposit_switch_alt_create_request.rb +4 -4
  100. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  101. data/lib/plaid/models/deposit_switch_create_request.rb +4 -4
  102. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  103. data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
  104. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  105. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  106. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  107. data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
  108. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  109. data/lib/plaid/models/depository_filter.rb +2 -2
  110. data/lib/plaid/models/email.rb +2 -2
  111. data/lib/plaid/models/employee.rb +2 -2
  112. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  113. data/lib/plaid/models/employer.rb +2 -2
  114. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  115. data/lib/plaid/models/employers_search_request.rb +4 -4
  116. data/lib/plaid/models/employers_search_response.rb +2 -2
  117. data/lib/plaid/models/error.rb +4 -4
  118. data/lib/plaid/models/{item_status_transactions.rb → external_payment_options.rb} +33 -23
  119. data/lib/plaid/models/{link_token_create_request_account_subtypes_depository.rb → external_payment_refund_details.rb} +34 -16
  120. data/lib/plaid/models/external_payment_schedule.rb +7 -7
  121. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  122. data/lib/plaid/models/health_incident.rb +2 -2
  123. data/lib/plaid/models/historical_balance.rb +2 -2
  124. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  125. data/lib/plaid/models/holding.rb +3 -3
  126. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  127. data/lib/plaid/models/identity_get_request.rb +4 -4
  128. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  129. data/lib/plaid/models/identity_get_response.rb +2 -2
  130. data/lib/plaid/models/incident_update.rb +2 -2
  131. data/lib/plaid/models/income_breakdown.rb +2 -2
  132. data/lib/plaid/models/income_summary.rb +2 -2
  133. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  134. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  135. data/lib/plaid/models/income_verification_create_request.rb +4 -4
  136. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  137. data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
  138. data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
  139. data/lib/plaid/models/income_verification_paystub_get_request.rb +4 -4
  140. data/lib/plaid/models/income_verification_paystub_get_response.rb +2 -2
  141. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  142. data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
  143. data/lib/plaid/models/income_verification_summary_get_response.rb +2 -2
  144. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  145. data/lib/plaid/models/inflow_model.rb +2 -2
  146. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  147. data/lib/plaid/models/institution.rb +16 -6
  148. data/lib/plaid/models/institution_status.rb +2 -2
  149. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
  150. data/lib/plaid/models/institutions_get_by_id_request_options.rb +19 -7
  151. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  152. data/lib/plaid/models/institutions_get_request.rb +27 -4
  153. data/lib/plaid/models/institutions_get_request_options.rb +20 -8
  154. data/lib/plaid/models/institutions_get_response.rb +3 -3
  155. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  156. data/lib/plaid/models/{item_status_last_webhook.rb → institutions_search_payment_initiation_options.rb} +14 -26
  157. data/lib/plaid/models/institutions_search_request.rb +25 -4
  158. data/lib/plaid/models/institutions_search_request_options.rb +23 -10
  159. data/lib/plaid/models/institutions_search_response.rb +2 -2
  160. data/lib/plaid/models/investment_filter.rb +2 -2
  161. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  162. data/lib/plaid/models/investment_transaction.rb +4 -3
  163. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  164. data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
  165. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  166. data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
  167. data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
  168. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  169. data/lib/plaid/models/item.rb +43 -3
  170. data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
  171. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  172. data/lib/plaid/models/item_error_webhook.rb +2 -2
  173. data/lib/plaid/models/item_get_request.rb +4 -4
  174. data/lib/plaid/models/item_get_response.rb +6 -16
  175. data/lib/plaid/models/item_import_request.rb +25 -4
  176. data/lib/plaid/models/item_import_request_options.rb +2 -2
  177. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  178. data/lib/plaid/models/item_import_response.rb +2 -2
  179. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  180. data/lib/plaid/models/item_public_token_create_request.rb +4 -4
  181. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  182. data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
  183. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  184. data/lib/plaid/models/item_remove_request.rb +4 -4
  185. data/lib/plaid/models/item_remove_response.rb +2 -2
  186. data/lib/plaid/models/item_status.rb +17 -8
  187. data/lib/plaid/models/item_webhook_update_request.rb +4 -4
  188. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  189. data/lib/plaid/models/jwk_public_key.rb +42 -2
  190. data/lib/plaid/models/jwt_header.rb +2 -2
  191. data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
  192. data/lib/plaid/models/liabilities_get_request.rb +4 -4
  193. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  194. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  195. data/lib/plaid/models/liabilities_object.rb +2 -2
  196. data/lib/plaid/models/liability_override.rb +7 -24
  197. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  198. data/lib/plaid/models/link_token_create_request.rb +51 -12
  199. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +22 -10
  200. data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
  201. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  202. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  203. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  204. data/lib/plaid/models/link_token_create_request_user.rb +4 -4
  205. data/lib/plaid/models/link_token_create_response.rb +3 -3
  206. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  207. data/lib/plaid/models/link_token_get_request.rb +4 -4
  208. data/lib/plaid/models/link_token_get_response.rb +2 -2
  209. data/lib/plaid/models/loan_filter.rb +2 -2
  210. data/lib/plaid/models/location.rb +2 -2
  211. data/lib/plaid/models/meta.rb +2 -2
  212. data/lib/plaid/models/mfa.rb +2 -2
  213. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  214. data/lib/plaid/models/mortgage_liability.rb +2 -2
  215. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  216. data/lib/plaid/models/nullable_access_token.rb +2 -2
  217. data/lib/plaid/models/nullable_address.rb +2 -2
  218. data/lib/plaid/models/nullable_address_data.rb +2 -2
  219. data/lib/plaid/models/nullable_item_status.rb +17 -8
  220. data/lib/plaid/models/nullable_numbers_ach.rb +4 -4
  221. data/lib/plaid/models/nullable_numbers_bacs.rb +2 -2
  222. data/lib/plaid/models/nullable_numbers_eft.rb +2 -2
  223. data/lib/plaid/models/nullable_numbers_international.rb +2 -2
  224. data/lib/plaid/models/nullable_recipient_bacs.rb +2 -2
  225. data/lib/plaid/models/numbers.rb +2 -2
  226. data/lib/plaid/models/numbers_ach.rb +4 -4
  227. data/lib/plaid/models/numbers_bacs.rb +2 -2
  228. data/lib/plaid/models/numbers_eft.rb +2 -2
  229. data/lib/plaid/models/numbers_international.rb +2 -2
  230. data/lib/plaid/models/override_accounts.rb +2 -2
  231. data/lib/plaid/models/owner.rb +3 -3
  232. data/lib/plaid/models/owner_override.rb +2 -2
  233. data/lib/plaid/models/pay_frequency.rb +2 -2
  234. data/lib/plaid/models/pay_period_details.rb +2 -2
  235. data/lib/plaid/models/payment_amount.rb +38 -4
  236. data/lib/plaid/models/payment_initiation_address.rb +19 -2
  237. data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
  238. data/lib/plaid/models/{payment_initiation_recipient_bacs.rb → payment_initiation_optional_restriction_bacs.rb} +14 -15
  239. data/lib/plaid/models/payment_initiation_payment.rb +395 -0
  240. data/lib/plaid/models/payment_initiation_payment_create_request.rb +20 -10
  241. data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
  242. data/lib/plaid/models/payment_initiation_payment_get_request.rb +4 -4
  243. data/lib/plaid/models/payment_initiation_payment_get_response.rb +77 -22
  244. data/lib/plaid/models/payment_initiation_payment_list_request.rb +8 -4
  245. data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
  246. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +4 -4
  247. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
  248. data/lib/plaid/models/payment_initiation_recipient.rb +21 -10
  249. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +5 -4
  250. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  251. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +4 -4
  252. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +22 -3
  253. data/lib/plaid/models/{link_token_create_request_account_subtypes_loan.rb → payment_initiation_recipient_get_response_all_of.rb} +13 -16
  254. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
  255. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  256. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
  257. data/lib/plaid/models/payment_meta.rb +3 -3
  258. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  259. data/lib/plaid/models/payment_status_update_webhook.rb +47 -3
  260. data/lib/plaid/models/paystub.rb +6 -4
  261. data/lib/plaid/models/paystub_deduction.rb +2 -2
  262. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  263. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  264. data/lib/plaid/models/phone_number.rb +2 -2
  265. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
  266. data/lib/plaid/models/processor_auth_get_request.rb +4 -4
  267. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  268. data/lib/plaid/models/processor_balance_get_request.rb +4 -4
  269. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  270. data/lib/plaid/models/processor_identity_get_request.rb +4 -4
  271. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  272. data/lib/plaid/models/processor_number.rb +2 -2
  273. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
  274. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  275. data/lib/plaid/models/processor_token_create_request.rb +5 -5
  276. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  277. data/lib/plaid/models/product_status.rb +2 -2
  278. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  279. data/lib/plaid/models/products.rb +3 -2
  280. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  281. data/lib/plaid/models/pslf_status.rb +2 -2
  282. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  283. data/lib/plaid/models/recipient_bacs.rb +2 -2
  284. data/lib/plaid/models/{item_status_investments.rb → sandbox_bank_transfer_fire_webhook_request.rb} +36 -23
  285. data/lib/plaid/models/{link_token_create_request_account_subtypes_credit.rb → sandbox_bank_transfer_fire_webhook_response.rb} +19 -16
  286. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
  287. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  288. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
  289. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  290. data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
  291. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  292. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
  293. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  294. data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
  295. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  296. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  297. data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
  298. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  299. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  300. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  301. data/lib/plaid/models/security.rb +5 -8
  302. data/lib/plaid/models/servicer_address_data.rb +2 -2
  303. data/lib/plaid/models/standalone_account_type.rb +2 -2
  304. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  305. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
  306. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  307. data/lib/plaid/models/student_loan.rb +4 -15
  308. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  309. data/lib/plaid/models/student_loan_status.rb +2 -2
  310. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  311. data/lib/plaid/models/transaction.rb +28 -6
  312. data/lib/plaid/models/transaction_code.rb +2 -2
  313. data/lib/plaid/models/transaction_data.rb +2 -2
  314. data/lib/plaid/models/transaction_override.rb +21 -21
  315. data/lib/plaid/models/transactions_get_request.rb +4 -4
  316. data/lib/plaid/models/transactions_get_request_options.rb +6 -2
  317. data/lib/plaid/models/transactions_get_response.rb +2 -2
  318. data/lib/plaid/models/transactions_refresh_request.rb +9 -4
  319. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  320. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  321. data/lib/plaid/models/user_custom_password.rb +2 -2
  322. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  323. data/lib/plaid/models/verification_expired_webhook.rb +3 -3
  324. data/lib/plaid/models/verification_status.rb +2 -2
  325. data/lib/plaid/models/warning.rb +2 -2
  326. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  327. data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
  328. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  329. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  330. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  331. data/lib/plaid/version.rb +3 -3
  332. data/lib/plaid.rb +20 -11
  333. data/pkg/plaid-14.2.0.gem +0 -0
  334. data/plaid.gemspec +3 -3
  335. data/templates/ruby/partial_model_generic.mustache +362 -0
  336. data/test/test_bank_transfers.rb +1 -1
  337. data/test/test_item.rb +2 -2
  338. data/test/test_payment_initiation.rb +1 -2
  339. metadata +23 -324
  340. data/docs/ACHClass.md +0 -15
  341. data/docs/APR.md +0 -24
  342. data/docs/AccountAssets.md +0 -40
  343. data/docs/AccountAssetsAllOf.md +0 -24
  344. data/docs/AccountBalance.md +0 -26
  345. data/docs/AccountBase.md +0 -32
  346. data/docs/AccountFiltersResponse.md +0 -24
  347. data/docs/AccountIdentity.md +0 -34
  348. data/docs/AccountIdentityAllOf.md +0 -18
  349. data/docs/AccountSubtype.md +0 -15
  350. data/docs/AccountType.md +0 -15
  351. data/docs/AccountsBalanceGetRequest.md +0 -24
  352. data/docs/AccountsBalanceGetRequestOptions.md +0 -18
  353. data/docs/AccountsGetRequest.md +0 -24
  354. data/docs/AccountsGetRequestOptions.md +0 -18
  355. data/docs/AccountsGetResponse.md +0 -22
  356. data/docs/Address.md +0 -20
  357. data/docs/AddressData.md +0 -26
  358. data/docs/Amount.md +0 -20
  359. data/docs/AssetReport.md +0 -28
  360. data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
  361. data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
  362. data/docs/AssetReportAuditCopyGetRequest.md +0 -22
  363. data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
  364. data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
  365. data/docs/AssetReportCreateRequest.md +0 -26
  366. data/docs/AssetReportCreateRequestOptions.md +0 -22
  367. data/docs/AssetReportCreateResponse.md +0 -22
  368. data/docs/AssetReportFilterRequest.md +0 -24
  369. data/docs/AssetReportFilterResponse.md +0 -22
  370. data/docs/AssetReportGetRequest.md +0 -24
  371. data/docs/AssetReportGetResponse.md +0 -22
  372. data/docs/AssetReportItem.md +0 -26
  373. data/docs/AssetReportPDFGetRequest.md +0 -22
  374. data/docs/AssetReportRefreshRequest.md +0 -26
  375. data/docs/AssetReportRefreshRequestOptions.md +0 -22
  376. data/docs/AssetReportRefreshResponse.md +0 -22
  377. data/docs/AssetReportRemoveRequest.md +0 -22
  378. data/docs/AssetReportRemoveResponse.md +0 -20
  379. data/docs/AssetReportTransaction.md +0 -58
  380. data/docs/AssetReportTransactionAllOf.md +0 -20
  381. data/docs/AssetReportUser.md +0 -30
  382. data/docs/AssetsErrorWebhook.md +0 -24
  383. data/docs/AssetsProductReadyWebhook.md +0 -22
  384. data/docs/AuthGetNumbers.md +0 -24
  385. data/docs/AuthGetRequest.md +0 -24
  386. data/docs/AuthGetRequestOptions.md +0 -18
  387. data/docs/AuthGetResponse.md +0 -24
  388. data/docs/AutomaticallyVerifiedWebhook.md +0 -24
  389. data/docs/BankTransfer.md +0 -50
  390. data/docs/BankTransferBalance.md +0 -20
  391. data/docs/BankTransferBalanceGetRequest.md +0 -22
  392. data/docs/BankTransferBalanceGetResponse.md +0 -22
  393. data/docs/BankTransferCancelRequest.md +0 -22
  394. data/docs/BankTransferCancelResponse.md +0 -18
  395. data/docs/BankTransferCreateRequest.md +0 -46
  396. data/docs/BankTransferCreateResponse.md +0 -20
  397. data/docs/BankTransferDirection.md +0 -15
  398. data/docs/BankTransferEvent.md +0 -40
  399. data/docs/BankTransferEventListRequest.md +0 -40
  400. data/docs/BankTransferEventListResponse.md +0 -20
  401. data/docs/BankTransferEventSyncRequest.md +0 -24
  402. data/docs/BankTransferEventSyncResponse.md +0 -20
  403. data/docs/BankTransferEventType.md +0 -15
  404. data/docs/BankTransferFailure.md +0 -20
  405. data/docs/BankTransferGetRequest.md +0 -22
  406. data/docs/BankTransferGetResponse.md +0 -20
  407. data/docs/BankTransferListRequest.md +0 -32
  408. data/docs/BankTransferListResponse.md +0 -20
  409. data/docs/BankTransferMigrateAccountRequest.md +0 -26
  410. data/docs/BankTransferMigrateAccountResponse.md +0 -22
  411. data/docs/BankTransferNetwork.md +0 -15
  412. data/docs/BankTransferReceiverDetails.md +0 -18
  413. data/docs/BankTransferStatus.md +0 -15
  414. data/docs/BankTransferType.md +0 -15
  415. data/docs/BankTransferUser.md +0 -22
  416. data/docs/CategoriesGetResponse.md +0 -20
  417. data/docs/Category.md +0 -22
  418. data/docs/Cause.md +0 -20
  419. data/docs/CountryCode.md +0 -15
  420. data/docs/CreditCardLiability.md +0 -34
  421. data/docs/CreditFilter.md +0 -18
  422. data/docs/DefaultUpdateWebhook.md +0 -26
  423. data/docs/DepositSwitchAddressData.md +0 -26
  424. data/docs/DepositSwitchAltCreateRequest.md +0 -24
  425. data/docs/DepositSwitchAltCreateResponse.md +0 -20
  426. data/docs/DepositSwitchCreateRequest.md +0 -24
  427. data/docs/DepositSwitchCreateResponse.md +0 -20
  428. data/docs/DepositSwitchGetRequest.md +0 -22
  429. data/docs/DepositSwitchGetResponse.md +0 -38
  430. data/docs/DepositSwitchTargetAccount.md +0 -24
  431. data/docs/DepositSwitchTargetUser.md +0 -28
  432. data/docs/DepositSwitchTokenCreateRequest.md +0 -22
  433. data/docs/DepositSwitchTokenCreateResponse.md +0 -22
  434. data/docs/DepositoryFilter.md +0 -18
  435. data/docs/Email.md +0 -22
  436. data/docs/Employee.md +0 -22
  437. data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
  438. data/docs/Employer.md +0 -24
  439. data/docs/EmployerIncomeSummaryFieldString.md +0 -20
  440. data/docs/EmployersSearchRequest.md +0 -24
  441. data/docs/EmployersSearchResponse.md +0 -20
  442. data/docs/Error.md +0 -34
  443. data/docs/ExternalPaymentSchedule.md +0 -24
  444. data/docs/HealthIncident.md +0 -24
  445. data/docs/HistoricalBalance.md +0 -24
  446. data/docs/HistoricalUpdateWebhook.md +0 -26
  447. data/docs/Holding.md +0 -34
  448. data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
  449. data/docs/IdentityGetRequest.md +0 -24
  450. data/docs/IdentityGetRequestOptions.md +0 -18
  451. data/docs/IdentityGetResponse.md +0 -22
  452. data/docs/IncidentUpdate.md +0 -22
  453. data/docs/IncomeBreakdown.md +0 -24
  454. data/docs/IncomeSummary.md +0 -30
  455. data/docs/IncomeSummaryFieldNumber.md +0 -20
  456. data/docs/IncomeSummaryFieldString.md +0 -20
  457. data/docs/IncomeVerificationCreateRequest.md +0 -22
  458. data/docs/IncomeVerificationCreateResponse.md +0 -20
  459. data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
  460. data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
  461. data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
  462. data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
  463. data/docs/IncomeVerificationStatusWebhook.md +0 -24
  464. data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
  465. data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
  466. data/docs/IncomeVerificationWebhookStatus.md +0 -18
  467. data/docs/InflowModel.md +0 -26
  468. data/docs/InitialUpdateWebhook.md +0 -26
  469. data/docs/Institution.md +0 -36
  470. data/docs/InstitutionStatus.md +0 -30
  471. data/docs/InstitutionsGetByIdRequest.md +0 -26
  472. data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
  473. data/docs/InstitutionsGetByIdResponse.md +0 -20
  474. data/docs/InstitutionsGetRequest.md +0 -28
  475. data/docs/InstitutionsGetRequestOptions.md +0 -24
  476. data/docs/InstitutionsGetResponse.md +0 -22
  477. data/docs/InstitutionsSearchAccountFilter.md +0 -24
  478. data/docs/InstitutionsSearchRequest.md +0 -28
  479. data/docs/InstitutionsSearchRequestOptions.md +0 -22
  480. data/docs/InstitutionsSearchResponse.md +0 -20
  481. data/docs/InvestmentFilter.md +0 -18
  482. data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
  483. data/docs/InvestmentTransaction.md +0 -44
  484. data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
  485. data/docs/InvestmentsHoldingsGetRequest.md +0 -24
  486. data/docs/InvestmentsHoldingsGetResponse.md +0 -26
  487. data/docs/InvestmentsTransactionsGetRequest.md +0 -28
  488. data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
  489. data/docs/InvestmentsTransactionsGetResponse.md +0 -28
  490. data/docs/Item.md +0 -32
  491. data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
  492. data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
  493. data/docs/ItemErrorWebhook.md +0 -24
  494. data/docs/ItemGetRequest.md +0 -22
  495. data/docs/ItemGetResponse.md +0 -24
  496. data/docs/ItemImportRequest.md +0 -26
  497. data/docs/ItemImportRequestOptions.md +0 -18
  498. data/docs/ItemImportRequestUserAuth.md +0 -20
  499. data/docs/ItemImportResponse.md +0 -20
  500. data/docs/ItemProductReadyWebhook.md +0 -24
  501. data/docs/ItemPublicTokenCreateRequest.md +0 -22
  502. data/docs/ItemPublicTokenCreateResponse.md +0 -22
  503. data/docs/ItemPublicTokenExchangeRequest.md +0 -22
  504. data/docs/ItemPublicTokenExchangeResponse.md +0 -22
  505. data/docs/ItemRemoveRequest.md +0 -22
  506. data/docs/ItemRemoveResponse.md +0 -18
  507. data/docs/ItemStatus.md +0 -22
  508. data/docs/ItemStatusInvestments.md +0 -20
  509. data/docs/ItemStatusLastWebhook.md +0 -20
  510. data/docs/ItemStatusTransactions.md +0 -20
  511. data/docs/ItemWebhookUpdateRequest.md +0 -24
  512. data/docs/ItemWebhookUpdateResponse.md +0 -20
  513. data/docs/JWKPublicKey.md +0 -34
  514. data/docs/JWTHeader.md +0 -18
  515. data/docs/LiabilitiesGetRequest.md +0 -24
  516. data/docs/LiabilitiesGetRequestOptions.md +0 -18
  517. data/docs/LiabilitiesGetResponse.md +0 -24
  518. data/docs/LiabilitiesObject.md +0 -22
  519. data/docs/LiabilityOverride.md +0 -66
  520. data/docs/LinkTokenAccountFilters.md +0 -24
  521. data/docs/LinkTokenCreateRequest.md +0 -48
  522. data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
  523. data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
  524. data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
  525. data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
  526. data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
  527. data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
  528. data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
  529. data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
  530. data/docs/LinkTokenCreateRequestUser.md +0 -32
  531. data/docs/LinkTokenCreateResponse.md +0 -22
  532. data/docs/LinkTokenGetMetadataResponse.md +0 -30
  533. data/docs/LinkTokenGetRequest.md +0 -22
  534. data/docs/LinkTokenGetResponse.md +0 -26
  535. data/docs/LoanFilter.md +0 -18
  536. data/docs/Location.md +0 -32
  537. data/docs/MFA.md +0 -26
  538. data/docs/Meta.md +0 -22
  539. data/docs/MortgageInterestRate.md +0 -20
  540. data/docs/MortgageLiability.md +0 -56
  541. data/docs/MortgagePropertyAddress.md +0 -26
  542. data/docs/NullableAccessToken.md +0 -15
  543. data/docs/NullableAddress.md +0 -20
  544. data/docs/NullableAddressData.md +0 -26
  545. data/docs/NullableItemStatus.md +0 -22
  546. data/docs/NullableNumbersACH.md +0 -24
  547. data/docs/NullableNumbersBACS.md +0 -22
  548. data/docs/NullableNumbersEFT.md +0 -24
  549. data/docs/NullableNumbersInternational.md +0 -22
  550. data/docs/NullableRecipientBACS.md +0 -20
  551. data/docs/Numbers.md +0 -32
  552. data/docs/NumbersACH.md +0 -24
  553. data/docs/NumbersBACS.md +0 -22
  554. data/docs/NumbersEFT.md +0 -24
  555. data/docs/NumbersInternational.md +0 -22
  556. data/docs/OverrideAccounts.md +0 -38
  557. data/docs/Owner.md +0 -24
  558. data/docs/OwnerOverride.md +0 -24
  559. data/docs/PSLFStatus.md +0 -22
  560. data/docs/PayFrequency.md +0 -20
  561. data/docs/PayPeriodDetails.md +0 -26
  562. data/docs/PaymentAmount.md +0 -20
  563. data/docs/PaymentInitiationAddress.md +0 -24
  564. data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
  565. data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
  566. data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
  567. data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
  568. data/docs/PaymentInitiationPaymentListRequest.md +0 -24
  569. data/docs/PaymentInitiationPaymentListResponse.md +0 -22
  570. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
  571. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
  572. data/docs/PaymentInitiationRecipient.md +0 -26
  573. data/docs/PaymentInitiationRecipientBacs.md +0 -20
  574. data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
  575. data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
  576. data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
  577. data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
  578. data/docs/PaymentInitiationRecipientListRequest.md +0 -20
  579. data/docs/PaymentInitiationRecipientListResponse.md +0 -20
  580. data/docs/PaymentMeta.md +0 -32
  581. data/docs/PaymentStatusUpdateWebhook.md +0 -30
  582. data/docs/Paystub.md +0 -30
  583. data/docs/PaystubDeduction.md +0 -22
  584. data/docs/PaystubYTDDetails.md +0 -20
  585. data/docs/PendingExpirationWebhook.md +0 -24
  586. data/docs/PhoneNumber.md +0 -22
  587. data/docs/PlaidApi.md +0 -5580
  588. data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
  589. data/docs/ProcessorAuthGetRequest.md +0 -22
  590. data/docs/ProcessorAuthGetResponse.md +0 -22
  591. data/docs/ProcessorBalanceGetRequest.md +0 -22
  592. data/docs/ProcessorBalanceGetResponse.md +0 -20
  593. data/docs/ProcessorIdentityGetRequest.md +0 -22
  594. data/docs/ProcessorIdentityGetResponse.md +0 -20
  595. data/docs/ProcessorNumber.md +0 -24
  596. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
  597. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
  598. data/docs/ProcessorTokenCreateRequest.md +0 -26
  599. data/docs/ProcessorTokenCreateResponse.md +0 -20
  600. data/docs/ProductStatus.md +0 -22
  601. data/docs/ProductStatusBreakdown.md +0 -24
  602. data/docs/Products.md +0 -15
  603. data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
  604. data/docs/RecaptchaRequiredError.md +0 -30
  605. data/docs/RecipientBACS.md +0 -20
  606. data/docs/SandboxBankTransferSimulateRequest.md +0 -26
  607. data/docs/SandboxBankTransferSimulateResponse.md +0 -18
  608. data/docs/SandboxItemFireWebhookRequest.md +0 -24
  609. data/docs/SandboxItemFireWebhookResponse.md +0 -20
  610. data/docs/SandboxItemResetLoginRequest.md +0 -22
  611. data/docs/SandboxItemResetLoginResponse.md +0 -20
  612. data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
  613. data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
  614. data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
  615. data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
  616. data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
  617. data/docs/SandboxPublicTokenCreateRequest.md +0 -26
  618. data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
  619. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
  620. data/docs/SandboxPublicTokenCreateResponse.md +0 -20
  621. data/docs/Security.md +0 -46
  622. data/docs/ServicerAddressData.md +0 -26
  623. data/docs/StandaloneAccountType.md +0 -26
  624. data/docs/StandaloneCurrencyCodeList.md +0 -20
  625. data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
  626. data/docs/StandaloneInvestmentTransactionType.md +0 -28
  627. data/docs/StudentLoan.md +0 -66
  628. data/docs/StudentLoanRepaymentModel.md +0 -22
  629. data/docs/StudentLoanStatus.md +0 -20
  630. data/docs/StudentRepaymentPlan.md +0 -20
  631. data/docs/Transaction.md +0 -54
  632. data/docs/TransactionCode.md +0 -15
  633. data/docs/TransactionData.md +0 -26
  634. data/docs/TransactionOverride.md +0 -26
  635. data/docs/TransactionsGetRequest.md +0 -28
  636. data/docs/TransactionsGetRequestOptions.md +0 -22
  637. data/docs/TransactionsGetResponse.md +0 -26
  638. data/docs/TransactionsRefreshRequest.md +0 -22
  639. data/docs/TransactionsRefreshResponse.md +0 -18
  640. data/docs/TransactionsRemovedWebhook.md +0 -26
  641. data/docs/UserCustomPassword.md +0 -28
  642. data/docs/UserPermissionRevokedWebhook.md +0 -24
  643. data/docs/VerificationExpiredWebhook.md +0 -24
  644. data/docs/VerificationStatus.md +0 -15
  645. data/docs/Warning.md +0 -22
  646. data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
  647. data/docs/WebhookVerificationKeyGetRequest.md +0 -22
  648. data/docs/WebhookVerificationKeyGetResponse.md +0 -20
  649. data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
  650. data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
  651. data/pkg/plaid-14.0.0.beta.2.gem +0 -0
@@ -3,10 +3,10 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.16.6
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -85,7 +85,7 @@ module Plaid
85
85
  end
86
86
 
87
87
  # Retrieve accounts
88
- # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
88
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. 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.
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 information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
98
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. 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.
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
@@ -149,6 +149,71 @@ module Plaid
149
149
  return data, status_code, headers
150
150
  end
151
151
 
152
+ # Retrieve information about a Plaid application
153
+ # Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
154
+ # @param application_get_request [ApplicationGetRequest]
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [ApplicationGetResponse]
157
+ def application_get(application_get_request, opts = {})
158
+ data, _status_code, _headers = application_get_with_http_info(application_get_request, opts)
159
+ data
160
+ end
161
+
162
+ # Retrieve information about a Plaid application
163
+ # Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
164
+ # @param application_get_request [ApplicationGetRequest]
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [Array<(ApplicationGetResponse, Integer, Hash)>] ApplicationGetResponse data, response status code and response headers
167
+ def application_get_with_http_info(application_get_request, opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug 'Calling API: PlaidApi.application_get ...'
170
+ end
171
+ # verify the required parameter 'application_get_request' is set
172
+ if @api_client.config.client_side_validation && application_get_request.nil?
173
+ fail ArgumentError, "Missing the required parameter 'application_get_request' when calling PlaidApi.application_get"
174
+ end
175
+ # resource path
176
+ local_var_path = '/application/get'
177
+
178
+ # query parameters
179
+ query_params = opts[:query_params] || {}
180
+
181
+ # header parameters
182
+ header_params = opts[:header_params] || {}
183
+ # HTTP header 'Accept' (if needed)
184
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
185
+ # HTTP header 'Content-Type'
186
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
187
+
188
+ # form parameters
189
+ form_params = opts[:form_params] || {}
190
+
191
+ # http body (model)
192
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(application_get_request)
193
+
194
+ # return_type
195
+ return_type = opts[:debug_return_type] || 'ApplicationGetResponse'
196
+
197
+ # auth_names
198
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
199
+
200
+ new_options = opts.merge(
201
+ :operation => :"PlaidApi.application_get",
202
+ :header_params => header_params,
203
+ :query_params => query_params,
204
+ :form_params => form_params,
205
+ :body => post_body,
206
+ :auth_names => auth_names,
207
+ :return_type => return_type
208
+ )
209
+
210
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "API called: PlaidApi#application_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
152
217
  # Create Asset Report Audit Copy
153
218
  # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
154
219
  # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
@@ -475,7 +540,7 @@ module Plaid
475
540
  end
476
541
 
477
542
  # Retrieve an Asset Report
478
- # 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`](/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`. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
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`](/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`.
479
544
  # @param asset_report_get_request [AssetReportGetRequest]
480
545
  # @param [Hash] opts the optional parameters
481
546
  # @return [AssetReportGetResponse]
@@ -485,7 +550,7 @@ module Plaid
485
550
  end
486
551
 
487
552
  # Retrieve an Asset Report
488
- # 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;](/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;. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
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;](/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;.
489
554
  # @param asset_report_get_request [AssetReportGetRequest]
490
555
  # @param [Hash] opts the optional parameters
491
556
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -1450,24 +1515,28 @@ module Plaid
1450
1515
  end
1451
1516
 
1452
1517
  # Create a deposit switch when not using Plaid Exchange.'
1453
- # 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 created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1518
+ # 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.
1519
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1454
1520
  # @param [Hash] opts the optional parameters
1455
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1456
1521
  # @return [DepositSwitchAltCreateResponse]
1457
- def deposit_switch_alt_create(opts = {})
1458
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(opts)
1522
+ def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
1523
+ data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
1459
1524
  data
1460
1525
  end
1461
1526
 
1462
1527
  # Create a deposit switch when not using Plaid Exchange.&#39;
1463
- # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1528
+ # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1529
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1464
1530
  # @param [Hash] opts the optional parameters
1465
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1466
1531
  # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1467
- def deposit_switch_alt_create_with_http_info(opts = {})
1532
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1468
1533
  if @api_client.config.debugging
1469
1534
  @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
1470
1535
  end
1536
+ # verify the required parameter 'deposit_switch_alt_create_request' is set
1537
+ if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
1539
+ end
1471
1540
  # resource path
1472
1541
  local_var_path = '/deposit_switch/alt/create'
1473
1542
 
@@ -1485,7 +1554,7 @@ module Plaid
1485
1554
  form_params = opts[:form_params] || {}
1486
1555
 
1487
1556
  # http body (model)
1488
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'deposit_switch_alt_create_request'])
1557
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
1489
1558
 
1490
1559
  # return_type
1491
1560
  return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
@@ -1707,23 +1776,27 @@ module Plaid
1707
1776
 
1708
1777
  # Search employer database
1709
1778
  # `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Verification of Income product progresses through the beta period, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1779
+ # @param employers_search_request [EmployersSearchRequest]
1710
1780
  # @param [Hash] opts the optional parameters
1711
- # @option opts [EmployersSearchRequest] :employers_search_request
1712
1781
  # @return [EmployersSearchResponse]
1713
- def employers_search(opts = {})
1714
- data, _status_code, _headers = employers_search_with_http_info(opts)
1782
+ def employers_search(employers_search_request, opts = {})
1783
+ data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
1715
1784
  data
1716
1785
  end
1717
1786
 
1718
1787
  # Search employer database
1719
1788
  # &#x60;/employers/search&#x60; allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Verification of Income product progresses through the beta period, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1789
+ # @param employers_search_request [EmployersSearchRequest]
1720
1790
  # @param [Hash] opts the optional parameters
1721
- # @option opts [EmployersSearchRequest] :employers_search_request
1722
1791
  # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
1723
- def employers_search_with_http_info(opts = {})
1792
+ def employers_search_with_http_info(employers_search_request, opts = {})
1724
1793
  if @api_client.config.debugging
1725
1794
  @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
1726
1795
  end
1796
+ # verify the required parameter 'employers_search_request' is set
1797
+ if @api_client.config.client_side_validation && employers_search_request.nil?
1798
+ fail ArgumentError, "Missing the required parameter 'employers_search_request' when calling PlaidApi.employers_search"
1799
+ end
1727
1800
  # resource path
1728
1801
  local_var_path = '/employers/search'
1729
1802
 
@@ -1741,7 +1814,7 @@ module Plaid
1741
1814
  form_params = opts[:form_params] || {}
1742
1815
 
1743
1816
  # http body (model)
1744
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'employers_search_request'])
1817
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)
1745
1818
 
1746
1819
  # return_type
1747
1820
  return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
@@ -1831,25 +1904,94 @@ module Plaid
1831
1904
  return data, status_code, headers
1832
1905
  end
1833
1906
 
1907
+ # Create an income verification instance
1908
+ # `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an `INCOME` webhook.
1909
+ # @param income_verification_create_request [IncomeVerificationCreateRequest]
1910
+ # @param [Hash] opts the optional parameters
1911
+ # @return [IncomeVerificationCreateResponse]
1912
+ def income_verification_create(income_verification_create_request, opts = {})
1913
+ data, _status_code, _headers = income_verification_create_with_http_info(income_verification_create_request, opts)
1914
+ data
1915
+ end
1916
+
1917
+ # Create an income verification instance
1918
+ # &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an &#x60;INCOME&#x60; webhook.
1919
+ # @param income_verification_create_request [IncomeVerificationCreateRequest]
1920
+ # @param [Hash] opts the optional parameters
1921
+ # @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
1922
+ def income_verification_create_with_http_info(income_verification_create_request, opts = {})
1923
+ if @api_client.config.debugging
1924
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_create ...'
1925
+ end
1926
+ # verify the required parameter 'income_verification_create_request' is set
1927
+ if @api_client.config.client_side_validation && income_verification_create_request.nil?
1928
+ fail ArgumentError, "Missing the required parameter 'income_verification_create_request' when calling PlaidApi.income_verification_create"
1929
+ end
1930
+ # resource path
1931
+ local_var_path = '/income/verification/create'
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(income_verification_create_request)
1948
+
1949
+ # return_type
1950
+ return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
1951
+
1952
+ # auth_names
1953
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1954
+
1955
+ new_options = opts.merge(
1956
+ :operation => :"PlaidApi.income_verification_create",
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#income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1968
+ end
1969
+ return data, status_code, headers
1970
+ end
1971
+
1834
1972
  # Download the original documents used for income verification
1835
1973
  # `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header. In the future, when Digital Verification is available, the most recent file available for download with the payroll provider will also be available from this endpoint.
1974
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1836
1975
  # @param [Hash] opts the optional parameters
1837
- # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1838
1976
  # @return [File]
1839
- def income_verification_documents_download(opts = {})
1840
- data, _status_code, _headers = income_verification_documents_download_with_http_info(opts)
1977
+ def income_verification_documents_download(income_verification_documents_download_request, opts = {})
1978
+ data, _status_code, _headers = income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts)
1841
1979
  data
1842
1980
  end
1843
1981
 
1844
1982
  # Download the original documents used for income verification
1845
1983
  # &#x60;/income/verification/documents/download&#x60; provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to &#x60;/income/verification/documents/download&#x60; is a ZIP file in binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. In the future, when Digital Verification is available, the most recent file available for download with the payroll provider will also be available from this endpoint.
1984
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1846
1985
  # @param [Hash] opts the optional parameters
1847
- # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1848
1986
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1849
- def income_verification_documents_download_with_http_info(opts = {})
1987
+ def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
1850
1988
  if @api_client.config.debugging
1851
1989
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
1852
1990
  end
1991
+ # verify the required parameter 'income_verification_documents_download_request' is set
1992
+ if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
1993
+ fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
1994
+ end
1853
1995
  # resource path
1854
1996
  local_var_path = '/income/verification/documents/download'
1855
1997
 
@@ -1867,7 +2009,7 @@ module Plaid
1867
2009
  form_params = opts[:form_params] || {}
1868
2010
 
1869
2011
  # http body (model)
1870
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_documents_download_request'])
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)
1871
2013
 
1872
2014
  # return_type
1873
2015
  return_type = opts[:debug_return_type] || 'File'
@@ -1894,23 +2036,27 @@ module Plaid
1894
2036
 
1895
2037
  # Retrieve information from the paystub used for income verification
1896
2038
  # `/income/verification/paystub/get` returns the information collected from the paystub that was 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.
2039
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
1897
2040
  # @param [Hash] opts the optional parameters
1898
- # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1899
2041
  # @return [IncomeVerificationPaystubGetResponse]
1900
- def income_verification_paystub_get(opts = {})
1901
- data, _status_code, _headers = income_verification_paystub_get_with_http_info(opts)
2042
+ def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
2043
+ data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
1902
2044
  data
1903
2045
  end
1904
2046
 
1905
2047
  # Retrieve information from the paystub used for income verification
1906
2048
  # &#x60;/income/verification/paystub/get&#x60; returns the information collected from the paystub that was used to verify an end user&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2049
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
1907
2050
  # @param [Hash] opts the optional parameters
1908
- # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1909
2051
  # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
1910
- def income_verification_paystub_get_with_http_info(opts = {})
2052
+ def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
1911
2053
  if @api_client.config.debugging
1912
2054
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
1913
2055
  end
2056
+ # verify the required parameter 'income_verification_paystub_get_request' is set
2057
+ if @api_client.config.client_side_validation && income_verification_paystub_get_request.nil?
2058
+ fail ArgumentError, "Missing the required parameter 'income_verification_paystub_get_request' when calling PlaidApi.income_verification_paystub_get"
2059
+ end
1914
2060
  # resource path
1915
2061
  local_var_path = '/income/verification/paystub/get'
1916
2062
 
@@ -1928,7 +2074,7 @@ module Plaid
1928
2074
  form_params = opts[:form_params] || {}
1929
2075
 
1930
2076
  # http body (model)
1931
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_paystub_get_request'])
2077
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
1932
2078
 
1933
2079
  # return_type
1934
2080
  return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
@@ -1955,23 +2101,27 @@ module Plaid
1955
2101
 
1956
2102
  # Retrieve a summary of information derived from income verification
1957
2103
  # `/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.
2104
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
1958
2105
  # @param [Hash] opts the optional parameters
1959
- # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1960
2106
  # @return [IncomeVerificationSummaryGetResponse]
1961
- def income_verification_summary_get(opts = {})
1962
- data, _status_code, _headers = income_verification_summary_get_with_http_info(opts)
2107
+ def income_verification_summary_get(income_verification_summary_get_request, opts = {})
2108
+ data, _status_code, _headers = income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts)
1963
2109
  data
1964
2110
  end
1965
2111
 
1966
2112
  # Retrieve a summary of information derived from income verification
1967
2113
  # &#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.
2114
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
1968
2115
  # @param [Hash] opts the optional parameters
1969
- # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1970
2116
  # @return [Array<(IncomeVerificationSummaryGetResponse, Integer, Hash)>] IncomeVerificationSummaryGetResponse data, response status code and response headers
1971
- def income_verification_summary_get_with_http_info(opts = {})
2117
+ def income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts = {})
1972
2118
  if @api_client.config.debugging
1973
2119
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
1974
2120
  end
2121
+ # verify the required parameter 'income_verification_summary_get_request' is set
2122
+ if @api_client.config.client_side_validation && income_verification_summary_get_request.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'income_verification_summary_get_request' when calling PlaidApi.income_verification_summary_get"
2124
+ end
1975
2125
  # resource path
1976
2126
  local_var_path = '/income/verification/summary/get'
1977
2127
 
@@ -1989,7 +2139,7 @@ module Plaid
1989
2139
  form_params = opts[:form_params] || {}
1990
2140
 
1991
2141
  # http body (model)
1992
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_summary_get_request'])
2142
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_summary_get_request)
1993
2143
 
1994
2144
  # return_type
1995
2145
  return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
@@ -2048,7 +2198,7 @@ module Plaid
2048
2198
  # HTTP header 'Accept' (if needed)
2049
2199
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2050
2200
  # HTTP header 'Content-Type'
2051
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
2201
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2052
2202
 
2053
2203
  # form parameters
2054
2204
  form_params = opts[:form_params] || {}
@@ -2665,7 +2815,7 @@ module Plaid
2665
2815
  end
2666
2816
 
2667
2817
  # Remove an Item
2668
- # 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.
2818
+ # 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.
2669
2819
  # @param item_remove_request [ItemRemoveRequest]
2670
2820
  # @param [Hash] opts the optional parameters
2671
2821
  # @return [ItemRemoveResponse]
@@ -2675,7 +2825,7 @@ module Plaid
2675
2825
  end
2676
2826
 
2677
2827
  # Remove an Item
2678
- # 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.
2828
+ # 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.
2679
2829
  # @param item_remove_request [ItemRemoveRequest]
2680
2830
  # @param [Hash] opts the optional parameters
2681
2831
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -2990,7 +3140,7 @@ module Plaid
2990
3140
  end
2991
3141
 
2992
3142
  # Create a payment
2993
- # 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 will continue indefinitely and 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.
3143
+ # 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 will continue indefinitely and 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.
2994
3144
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
2995
3145
  # @param [Hash] opts the optional parameters
2996
3146
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -3000,7 +3150,7 @@ module Plaid
3000
3150
  end
3001
3151
 
3002
3152
  # Create a payment
3003
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and 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.
3153
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and 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.
3004
3154
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3005
3155
  # @param [Hash] opts the optional parameters
3006
3156
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -3185,7 +3335,7 @@ module Plaid
3185
3335
  end
3186
3336
 
3187
3337
  # Create payment recipient
3188
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`. In the Sandbox environment, you can use the `/payment_initiation/recipient/create` endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid's Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3338
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
3189
3339
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3190
3340
  # @param [Hash] opts the optional parameters
3191
3341
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -3195,7 +3345,7 @@ module Plaid
3195
3345
  end
3196
3346
 
3197
3347
  # Create payment recipient
3198
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;. In the Sandbox environment, you can use the &#x60;/payment_initiation/recipient/create&#x60; endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid&#39;s Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3348
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
3199
3349
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3200
3350
  # @param [Hash] opts the optional parameters
3201
3351
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -3379,67 +3529,6 @@ module Plaid
3379
3529
  return data, status_code, headers
3380
3530
  end
3381
3531
 
3382
- # Create an income verification instance
3383
- # `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an `INCOME` webhook.
3384
- # @param [Hash] opts the optional parameters
3385
- # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3386
- # @return [IncomeVerificationCreateResponse]
3387
- def post_income_verification_create(opts = {})
3388
- data, _status_code, _headers = post_income_verification_create_with_http_info(opts)
3389
- data
3390
- end
3391
-
3392
- # Create an income verification instance
3393
- # &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an &#x60;INCOME&#x60; webhook.
3394
- # @param [Hash] opts the optional parameters
3395
- # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3396
- # @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
3397
- def post_income_verification_create_with_http_info(opts = {})
3398
- if @api_client.config.debugging
3399
- @api_client.config.logger.debug 'Calling API: PlaidApi.post_income_verification_create ...'
3400
- end
3401
- # resource path
3402
- local_var_path = '/income/verification/create'
3403
-
3404
- # query parameters
3405
- query_params = opts[:query_params] || {}
3406
-
3407
- # header parameters
3408
- header_params = opts[:header_params] || {}
3409
- # HTTP header 'Accept' (if needed)
3410
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3411
- # HTTP header 'Content-Type'
3412
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3413
-
3414
- # form parameters
3415
- form_params = opts[:form_params] || {}
3416
-
3417
- # http body (model)
3418
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_create_request'])
3419
-
3420
- # return_type
3421
- return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
3422
-
3423
- # auth_names
3424
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3425
-
3426
- new_options = opts.merge(
3427
- :operation => :"PlaidApi.post_income_verification_create",
3428
- :header_params => header_params,
3429
- :query_params => query_params,
3430
- :form_params => form_params,
3431
- :body => post_body,
3432
- :auth_names => auth_names,
3433
- :return_type => return_type
3434
- )
3435
-
3436
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3437
- if @api_client.config.debugging
3438
- @api_client.config.logger.debug "API called: PlaidApi#post_income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3439
- end
3440
- return data, status_code, headers
3441
- end
3442
-
3443
3532
  # Create Apex bank account token
3444
3533
  # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3445
3534
  # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
@@ -3701,7 +3790,7 @@ module Plaid
3701
3790
  end
3702
3791
 
3703
3792
  # Create Stripe bank account token
3704
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
3793
+ # 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/).
3705
3794
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3706
3795
  # @param [Hash] opts the optional parameters
3707
3796
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -3711,7 +3800,7 @@ module Plaid
3711
3800
  end
3712
3801
 
3713
3802
  # Create Stripe bank account token
3714
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
3803
+ # 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/).
3715
3804
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3716
3805
  # @param [Hash] opts the optional parameters
3717
3806
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -3830,6 +3919,71 @@ module Plaid
3830
3919
  return data, status_code, headers
3831
3920
  end
3832
3921
 
3922
+ # Manually fire a Bank Transfer webhook
3923
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3924
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3925
+ # @param [Hash] opts the optional parameters
3926
+ # @return [SandboxBankTransferFireWebhookResponse]
3927
+ def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
3928
+ data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
3929
+ data
3930
+ end
3931
+
3932
+ # Manually fire a Bank Transfer webhook
3933
+ # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3934
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3935
+ # @param [Hash] opts the optional parameters
3936
+ # @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
3937
+ def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
3938
+ if @api_client.config.debugging
3939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
3940
+ end
3941
+ # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
3942
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
3943
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
3944
+ end
3945
+ # resource path
3946
+ local_var_path = '/sandbox/bank_transfer/fire_webhook'
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(sandbox_bank_transfer_fire_webhook_request)
3963
+
3964
+ # return_type
3965
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
3966
+
3967
+ # auth_names
3968
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3969
+
3970
+ new_options = opts.merge(
3971
+ :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
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#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3983
+ end
3984
+ return data, status_code, headers
3985
+ end
3986
+
3833
3987
  # Simulate a bank transfer event in Sandbox
3834
3988
  # Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
3835
3989
  # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
@@ -4092,23 +4246,27 @@ module Plaid
4092
4246
 
4093
4247
  # Create a test Item and processor token
4094
4248
  # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4249
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4095
4250
  # @param [Hash] opts the optional parameters
4096
- # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4097
4251
  # @return [SandboxProcessorTokenCreateResponse]
4098
- def sandbox_processor_token_create(opts = {})
4099
- data, _status_code, _headers = sandbox_processor_token_create_with_http_info(opts)
4252
+ def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
4253
+ data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
4100
4254
  data
4101
4255
  end
4102
4256
 
4103
4257
  # Create a test Item and processor token
4104
4258
  # Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4259
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4105
4260
  # @param [Hash] opts the optional parameters
4106
- # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4107
4261
  # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
4108
- def sandbox_processor_token_create_with_http_info(opts = {})
4262
+ def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
4109
4263
  if @api_client.config.debugging
4110
4264
  @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
4111
4265
  end
4266
+ # verify the required parameter 'sandbox_processor_token_create_request' is set
4267
+ if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
4268
+ fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
4269
+ end
4112
4270
  # resource path
4113
4271
  local_var_path = '/sandbox/processor_token/create'
4114
4272
 
@@ -4126,7 +4284,7 @@ module Plaid
4126
4284
  form_params = opts[:form_params] || {}
4127
4285
 
4128
4286
  # http body (model)
4129
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sandbox_processor_token_create_request'])
4287
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)
4130
4288
 
4131
4289
  # return_type
4132
4290
  return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
@@ -4217,7 +4375,7 @@ module Plaid
4217
4375
  end
4218
4376
 
4219
4377
  # Get transaction data
4220
- # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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. 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`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/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.
4378
+ # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/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.
4221
4379
  # @param transactions_get_request [TransactionsGetRequest]
4222
4380
  # @param [Hash] opts the optional parameters
4223
4381
  # @return [TransactionsGetResponse]
@@ -4227,7 +4385,7 @@ module Plaid
4227
4385
  end
4228
4386
 
4229
4387
  # Get transaction data
4230
- # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the &#x60;/liabilities/get&#x60; endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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. 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;](/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](/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.
4388
+ # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the &#x60;/liabilities/get&#x60; endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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;](/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](/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.
4231
4389
  # @param transactions_get_request [TransactionsGetRequest]
4232
4390
  # @param [Hash] opts the optional parameters
4233
4391
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers