plaid 21.3.0 → 23.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1367) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +891 -102
  3. data/CONTRIBUTING.md +4 -1
  4. data/Gemfile.lock +5 -3
  5. data/Makefile +1 -1
  6. data/README.md +112 -57
  7. data/lib/plaid/api/plaid_api.rb +1070 -118
  8. data/lib/plaid/api_client.rb +2 -2
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +1 -1
  11. data/lib/plaid/models/account_access.rb +1 -1
  12. data/lib/plaid/models/account_assets.rb +11 -2
  13. data/lib/plaid/models/account_assets_all_of.rb +11 -2
  14. data/lib/plaid/models/account_balance.rb +1 -1
  15. data/lib/plaid/models/account_base.rb +1 -1
  16. data/lib/plaid/models/account_filter.rb +1 -1
  17. data/lib/plaid/models/account_filters_response.rb +1 -1
  18. data/lib/plaid/models/account_identity.rb +1 -1
  19. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  20. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  22. data/lib/plaid/models/account_product_access.rb +1 -1
  23. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  24. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  25. data/lib/plaid/models/account_subtype.rb +1 -1
  26. data/lib/plaid/models/account_type.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request.rb +1 -1
  30. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  31. data/lib/plaid/models/accounts_get_response.rb +1 -1
  32. data/lib/plaid/models/ach_class.rb +1 -1
  33. data/lib/plaid/models/action_state.rb +1 -1
  34. data/lib/plaid/models/activity.rb +1 -1
  35. data/lib/plaid/models/activity_type.rb +1 -1
  36. data/lib/plaid/models/address.rb +1 -1
  37. data/lib/plaid/models/address_data.rb +1 -1
  38. data/lib/plaid/models/address_data_not_required.rb +1 -1
  39. data/lib/plaid/models/address_data_nullable.rb +1 -1
  40. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  41. data/lib/plaid/models/address_match_score.rb +2 -2
  42. data/lib/plaid/models/address_nullable.rb +1 -1
  43. data/lib/plaid/models/address_purpose_label.rb +1 -1
  44. data/lib/plaid/models/application.rb +1 -1
  45. data/lib/plaid/models/application_get_request.rb +1 -1
  46. data/lib/plaid/models/application_get_response.rb +1 -1
  47. data/lib/plaid/models/apr.rb +1 -1
  48. data/lib/plaid/models/asset.rb +1 -1
  49. data/lib/plaid/models/asset_detail.rb +1 -1
  50. data/lib/plaid/models/asset_holder.rb +1 -1
  51. data/lib/plaid/models/asset_holder_name.rb +1 -1
  52. data/lib/plaid/models/asset_owner.rb +1 -1
  53. data/lib/plaid/models/asset_owners.rb +1 -1
  54. data/lib/plaid/models/asset_report.rb +1 -1
  55. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_create_request.rb +2 -12
  62. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  63. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  67. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  71. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_investment_holding.rb +341 -0
  73. data/lib/plaid/models/asset_report_investment_security.rb +259 -0
  74. data/lib/plaid/models/asset_report_investments.rb +388 -0
  75. data/lib/plaid/models/asset_report_item.rb +1 -1
  76. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  78. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  80. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  81. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  84. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  85. data/lib/plaid/models/asset_report_user.rb +1 -1
  86. data/lib/plaid/models/asset_transaction.rb +1 -1
  87. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  88. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  89. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  90. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  91. data/lib/plaid/models/asset_transactions.rb +1 -1
  92. data/lib/plaid/models/asset_type.rb +1 -1
  93. data/lib/plaid/models/assets.rb +1 -1
  94. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  95. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  96. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  97. data/lib/plaid/models/auth_get_request.rb +1 -1
  98. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  99. data/lib/plaid/models/auth_get_response.rb +1 -1
  100. data/lib/plaid/models/auth_metadata.rb +1 -1
  101. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  102. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  103. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  104. data/lib/plaid/models/bank_income_complete_webhook.rb +3 -3
  105. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  106. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  107. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  108. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  109. data/lib/plaid/models/bank_transfer.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  142. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  143. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  144. data/lib/plaid/models/base_report.rb +1 -1
  145. data/lib/plaid/models/base_report_account.rb +1 -1
  146. data/lib/plaid/models/base_report_account_insights.rb +1 -1
  147. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  148. data/lib/plaid/models/base_report_get_request.rb +1 -1
  149. data/lib/plaid/models/base_report_get_response.rb +14 -2
  150. data/lib/plaid/models/base_report_item.rb +1 -1
  151. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  152. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  153. data/lib/plaid/models/base_report_transaction.rb +1 -1
  154. data/lib/plaid/models/base_report_warning.rb +254 -0
  155. data/lib/plaid/models/base_report_warning_code.rb +39 -0
  156. data/lib/plaid/models/base_reports_error_webhook.rb +14 -9
  157. data/lib/plaid/models/base_reports_product_ready_webhook.rb +6 -1
  158. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  159. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  160. data/lib/plaid/models/beacon_match_summary_code.rb +41 -0
  161. data/lib/plaid/models/beacon_report.rb +309 -0
  162. data/lib/plaid/models/beacon_report_create_request.rb +2 -1
  163. data/lib/plaid/models/beacon_report_create_response.rb +2 -6
  164. data/lib/plaid/models/beacon_report_list_request.rb +257 -0
  165. data/lib/plaid/models/beacon_report_list_response.rb +253 -0
  166. data/lib/plaid/models/beacon_report_syndication.rb +254 -0
  167. data/lib/plaid/models/beacon_report_syndication_analysis.rb +309 -0
  168. data/lib/plaid/models/beacon_report_syndication_list_request.rb +257 -0
  169. data/lib/plaid/models/beacon_report_syndication_list_response.rb +253 -0
  170. data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voe25.rb → beacon_report_syndication_original_report.rb} +51 -27
  171. data/lib/plaid/models/beacon_report_type.rb +1 -1
  172. data/lib/plaid/models/beacon_user_address.rb +1 -1
  173. data/lib/plaid/models/beacon_user_create_embedded_report.rb +2 -2
  174. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  175. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  176. data/lib/plaid/models/beacon_user_data.rb +1 -1
  177. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  178. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  179. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  180. data/lib/plaid/models/beacon_user_name.rb +1 -1
  181. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  182. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  183. data/lib/plaid/models/beacon_user_status.rb +1 -1
  184. data/lib/plaid/models/categories_get_response.rb +1 -1
  185. data/lib/plaid/models/category.rb +1 -1
  186. data/lib/plaid/models/category_insight_details.rb +288 -0
  187. data/lib/plaid/models/category_insights.rb +235 -0
  188. data/lib/plaid/models/cause.rb +1 -1
  189. data/lib/plaid/models/cause_all_of.rb +1 -1
  190. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  191. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  192. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  193. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  194. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  195. data/lib/plaid/models/connected_application.rb +1 -1
  196. data/lib/plaid/models/consumer_report_permissible_purpose.rb +2 -2
  197. data/lib/plaid/models/consumer_report_user_identity.rb +2 -2
  198. data/lib/plaid/models/counterparty.rb +4 -4
  199. data/lib/plaid/models/counterparty_insights.rb +235 -0
  200. data/lib/plaid/models/counterparty_type.rb +1 -1
  201. data/lib/plaid/models/country_code.rb +1 -1
  202. data/lib/plaid/models/cra_bank_income.rb +1 -1
  203. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  204. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  205. data/lib/plaid/models/cra_bank_income_complete_result.rb +39 -0
  206. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +284 -0
  207. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  208. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  209. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  210. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  211. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  212. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  213. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  214. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  215. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  216. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  217. data/lib/plaid/models/credit1099.rb +1 -1
  218. data/lib/plaid/models/credit1099_filer.rb +1 -1
  219. data/lib/plaid/models/credit1099_payer.rb +1 -1
  220. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  221. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  222. data/lib/plaid/models/credit_ach_class.rb +1 -1
  223. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  224. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  225. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  226. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  227. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  228. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  229. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  230. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  231. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  232. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  233. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  234. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  235. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  236. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  237. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  238. data/lib/plaid/models/credit_bank_income.rb +1 -1
  239. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  240. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  241. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  242. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  243. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  244. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  245. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  246. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  247. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  248. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  249. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  250. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  251. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  252. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  253. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  254. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  255. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  256. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  257. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  258. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  259. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  260. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  261. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  262. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  263. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  264. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  265. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  266. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  267. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  268. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  269. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  270. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  271. data/lib/plaid/models/credit_card_liability.rb +1 -1
  272. data/lib/plaid/models/credit_category.rb +1 -1
  273. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  274. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  275. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  276. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  277. data/lib/plaid/models/credit_employment_item.rb +1 -1
  278. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  279. data/lib/plaid/models/credit_filter.rb +1 -1
  280. data/lib/plaid/models/{credit_freddie_mac_asset_voa24.rb → credit_freddie_mac_asset.rb} +5 -5
  281. data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voa24.rb → credit_freddie_mac_asset_transaction.rb} +4 -4
  282. data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voe25.rb → credit_freddie_mac_asset_transactions.rb} +5 -5
  283. data/lib/plaid/models/{credit_freddie_mac_assets_voe25.rb → credit_freddie_mac_assets.rb} +5 -5
  284. data/lib/plaid/models/{credit_freddie_mac_individual_name_voa24.rb → credit_freddie_mac_individual_name.rb} +4 -4
  285. data/lib/plaid/models/{credit_freddie_mac_loan_voa24.rb → credit_freddie_mac_loan.rb} +5 -5
  286. data/lib/plaid/models/{credit_freddie_mac_loan_identifiers_voa24.rb → credit_freddie_mac_loan_identifiers.rb} +4 -4
  287. data/lib/plaid/models/{credit_freddie_mac_loans_voa24.rb → credit_freddie_mac_loans.rb} +5 -5
  288. data/lib/plaid/models/{credit_freddie_mac_parties_voa24.rb → credit_freddie_mac_parties.rb} +5 -5
  289. data/lib/plaid/models/{credit_freddie_mac_party_voa24.rb → credit_freddie_mac_party.rb} +5 -5
  290. data/lib/plaid/models/{credit_freddie_mac_party_individual_voa24.rb → credit_freddie_mac_party_individual.rb} +5 -5
  291. data/lib/plaid/models/{credit_freddie_mac_reporting_information_voa24.rb → credit_freddie_mac_reporting_information.rb} +15 -5
  292. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  293. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +31 -22
  294. data/lib/plaid/models/{credit_freddie_mac_service_voa24.rb → credit_freddie_mac_service.rb} +5 -5
  295. data/lib/plaid/models/{credit_freddie_mac_services_voa24.rb → credit_freddie_mac_services.rb} +5 -5
  296. data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_voe25.rb → credit_freddie_mac_verification_of_asset.rb} +6 -6
  297. data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_response_voa24.rb → credit_freddie_mac_verification_of_asset_response.rb} +5 -5
  298. data/lib/plaid/models/{credit_freddie_mac_verification_of_assets_deal_voa24.rb → credit_freddie_mac_verification_of_assets_deal.rb} +7 -7
  299. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  300. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  301. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  302. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  303. data/lib/plaid/models/credit_pay_stub_employee.rb +2 -2
  304. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  305. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  306. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  307. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  308. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  309. data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_voa24.rb → credit_payroll_income_parsing_config_update_request.rb} +55 -35
  310. data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voa24.rb → credit_payroll_income_parsing_config_update_response.rb} +16 -17
  311. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  312. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  313. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  314. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  315. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  316. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  317. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  318. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  319. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  320. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  321. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  322. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  323. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  324. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  325. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  326. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  327. data/lib/plaid/models/credit_session.rb +1 -1
  328. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  329. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  330. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  331. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  332. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  333. data/lib/plaid/models/credit_session_error.rb +1 -1
  334. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  335. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  336. data/lib/plaid/models/credit_session_results.rb +1 -1
  337. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  338. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  339. data/lib/plaid/models/credit_w2.rb +1 -1
  340. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  341. data/lib/plaid/models/dashboard_user.rb +1 -1
  342. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  343. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  344. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  345. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  346. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  347. data/lib/plaid/models/date_range.rb +1 -1
  348. data/lib/plaid/models/deductions.rb +1 -1
  349. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  350. data/lib/plaid/models/deductions_total.rb +1 -1
  351. data/lib/plaid/models/default_update_webhook.rb +1 -1
  352. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  353. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  354. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  355. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  356. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  357. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  358. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  359. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  360. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  361. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  362. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  363. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  364. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  365. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  366. data/lib/plaid/models/depository_filter.rb +1 -1
  367. data/lib/plaid/models/detailed_originator.rb +2 -1
  368. data/lib/plaid/models/detected_account.rb +298 -0
  369. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  370. data/lib/plaid/models/doc_type.rb +1 -1
  371. data/lib/plaid/models/document_analysis.rb +1 -1
  372. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  373. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  374. data/lib/plaid/models/document_metadata.rb +1 -1
  375. data/lib/plaid/models/document_name_match_code.rb +1 -1
  376. data/lib/plaid/models/document_risk_signal.rb +1 -1
  377. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  378. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  379. data/lib/plaid/models/document_risk_summary.rb +1 -1
  380. data/lib/plaid/models/document_status.rb +1 -1
  381. data/lib/plaid/models/documentary_verification.rb +1 -1
  382. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  383. data/lib/plaid/models/earnings.rb +1 -1
  384. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  385. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  386. data/lib/plaid/models/earnings_total.rb +1 -1
  387. data/lib/plaid/models/email.rb +1 -1
  388. data/lib/plaid/models/email_address_match_score.rb +1 -1
  389. data/lib/plaid/models/employee.rb +1 -1
  390. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  391. data/lib/plaid/models/employer.rb +1 -1
  392. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  393. data/lib/plaid/models/employer_verification.rb +1 -1
  394. data/lib/plaid/models/employers_search_request.rb +1 -1
  395. data/lib/plaid/models/employers_search_response.rb +1 -1
  396. data/lib/plaid/models/employment_details.rb +1 -1
  397. data/lib/plaid/models/employment_source_type.rb +1 -1
  398. data/lib/plaid/models/employment_verification.rb +1 -1
  399. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  400. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  401. data/lib/plaid/models/employment_verification_status.rb +1 -1
  402. data/lib/plaid/models/enhancements.rb +3 -3
  403. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  404. data/lib/plaid/models/enrichments.rb +4 -4
  405. data/lib/plaid/models/entity_document.rb +1 -1
  406. data/lib/plaid/models/entity_document_type.rb +1 -1
  407. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  408. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  409. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  410. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  411. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  412. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  413. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  414. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  415. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  416. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  417. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  418. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  419. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  420. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  421. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  422. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  423. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  424. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  425. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  426. data/lib/plaid/models/expiration_date.rb +1 -1
  427. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  428. data/lib/plaid/models/external_payment_options.rb +1 -1
  429. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  430. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  431. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  432. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  433. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  434. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  435. data/lib/plaid/models/fdx_content_types.rb +1 -1
  436. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  437. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  438. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  439. data/lib/plaid/models/fdx_notification.rb +1 -6
  440. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  441. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  442. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  443. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  444. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  445. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  446. data/lib/plaid/models/fdx_party.rb +1 -1
  447. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  448. data/lib/plaid/models/fdx_party_type.rb +1 -1
  449. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  450. data/lib/plaid/models/financial_institution_insights.rb +265 -0
  451. data/lib/plaid/models/form1099_type.rb +1 -1
  452. data/lib/plaid/models/fraud_amount.rb +1 -1
  453. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  454. data/lib/plaid/models/health_incident.rb +1 -1
  455. data/lib/plaid/models/historical_balance.rb +1 -1
  456. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  457. data/lib/plaid/models/holding.rb +1 -1
  458. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  459. data/lib/plaid/models/holdings_override.rb +1 -1
  460. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  461. data/lib/plaid/models/id_number_type.rb +1 -1
  462. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  463. data/lib/plaid/models/identity_get_request.rb +1 -1
  464. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  465. data/lib/plaid/models/identity_get_response.rb +1 -1
  466. data/lib/plaid/models/identity_match_request.rb +1 -1
  467. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  468. data/lib/plaid/models/identity_match_response.rb +1 -1
  469. data/lib/plaid/models/identity_match_user.rb +1 -1
  470. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  471. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  472. data/lib/plaid/models/identity_update_types.rb +1 -1
  473. data/lib/plaid/models/identity_verification.rb +1 -1
  474. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  475. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  476. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  477. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  478. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  479. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  480. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  481. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  482. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  483. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  484. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  485. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  486. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  487. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  488. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  489. data/lib/plaid/models/identity_verification_status.rb +1 -1
  490. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  491. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  492. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  493. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  494. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  495. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  496. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  497. data/lib/plaid/models/image_quality.rb +1 -1
  498. data/lib/plaid/models/incident_update.rb +1 -1
  499. data/lib/plaid/models/income_breakdown.rb +1 -1
  500. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  501. data/lib/plaid/models/income_override.rb +1 -1
  502. data/lib/plaid/models/income_summary.rb +1 -1
  503. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  504. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  505. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  506. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  507. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  508. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  509. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  510. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  511. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  512. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  513. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  514. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  515. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  516. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  517. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  518. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  519. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  520. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  521. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  522. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  523. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  524. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  525. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  526. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  527. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  528. data/lib/plaid/models/individual_name.rb +1 -1
  529. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  530. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  531. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  532. data/lib/plaid/models/inflow_model.rb +1 -1
  533. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  534. data/lib/plaid/models/institution.rb +1 -1
  535. data/lib/plaid/models/institution_status.rb +1 -1
  536. data/lib/plaid/models/institution_status_alert_webhook.rb +285 -0
  537. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  538. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  539. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  540. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  541. data/lib/plaid/models/institutions_get_request.rb +1 -1
  542. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  543. data/lib/plaid/models/institutions_get_response.rb +1 -1
  544. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  545. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  546. data/lib/plaid/models/institutions_search_request.rb +1 -1
  547. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  548. data/lib/plaid/models/institutions_search_response.rb +1 -1
  549. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  550. data/lib/plaid/models/investment_filter.rb +1 -1
  551. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  552. data/lib/plaid/models/investment_transaction.rb +1 -1
  553. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  554. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  555. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  556. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  557. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  558. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  559. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  560. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  561. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  562. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  563. data/lib/plaid/models/investments_holdings_get_response.rb +15 -5
  564. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  565. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  566. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  567. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  568. data/lib/plaid/models/investments_transactions_get_response.rb +15 -5
  569. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  570. data/lib/plaid/models/iso_currency_code.rb +1 -1
  571. data/lib/plaid/models/issuing_country.rb +1 -1
  572. data/lib/plaid/models/item.rb +1 -1
  573. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  574. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  575. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  576. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  577. data/lib/plaid/models/item_application_list_request.rb +1 -1
  578. data/lib/plaid/models/item_application_list_response.rb +1 -1
  579. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  580. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  581. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  582. data/lib/plaid/models/item_error_webhook.rb +1 -1
  583. data/lib/plaid/models/item_get_request.rb +1 -1
  584. data/lib/plaid/models/item_get_response.rb +1 -1
  585. data/lib/plaid/models/item_import_request.rb +1 -1
  586. data/lib/plaid/models/item_import_request_options.rb +1 -1
  587. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  588. data/lib/plaid/models/item_import_response.rb +1 -1
  589. data/lib/plaid/models/item_login_repaired_webhook.rb +2 -2
  590. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  591. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  592. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  593. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  594. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  595. data/lib/plaid/models/item_remove_request.rb +1 -1
  596. data/lib/plaid/models/item_remove_response.rb +1 -1
  597. data/lib/plaid/models/item_status.rb +1 -1
  598. data/lib/plaid/models/item_status_investments.rb +1 -1
  599. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  600. data/lib/plaid/models/item_status_nullable.rb +1 -1
  601. data/lib/plaid/models/item_status_transactions.rb +1 -1
  602. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  603. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  604. data/lib/plaid/models/jwk_public_key.rb +1 -1
  605. data/lib/plaid/models/jwt_header.rb +1 -1
  606. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  607. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  608. data/lib/plaid/models/kyc_check_details.rb +1 -1
  609. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  610. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  611. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  612. data/lib/plaid/models/last_data_access_times.rb +1 -1
  613. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  614. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  615. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  616. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  617. data/lib/plaid/models/liabilities_object.rb +1 -1
  618. data/lib/plaid/models/liability_override.rb +2 -2
  619. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  620. data/lib/plaid/models/link_delivery_account.rb +1 -1
  621. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  622. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  623. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  624. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  625. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  626. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  627. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  628. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  629. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  630. data/lib/plaid/models/link_delivery_options.rb +1 -1
  631. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  632. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  633. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  634. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  635. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  636. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  637. data/lib/plaid/models/link_event.rb +1 -1
  638. data/lib/plaid/models/link_event_metadata.rb +1 -1
  639. data/lib/plaid/models/link_event_name.rb +2 -1
  640. data/lib/plaid/models/link_events_webhook.rb +1 -1
  641. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  642. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  643. data/lib/plaid/models/link_session_exit.rb +1 -1
  644. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  645. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  646. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  647. data/lib/plaid/models/link_session_success.rb +1 -1
  648. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  649. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  650. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  651. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  652. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  653. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  654. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  655. data/lib/plaid/models/link_token_create_hosted_link.rb +15 -5
  656. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  657. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  658. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  659. data/lib/plaid/models/link_token_create_request.rb +28 -16
  660. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  661. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  662. data/lib/plaid/models/link_token_create_request_base_report.rb +6 -1
  663. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  664. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  665. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  666. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  667. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  668. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  669. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  670. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  671. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  672. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  673. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  674. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  675. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  676. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  677. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  678. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  679. data/lib/plaid/models/link_token_create_response.rb +1 -1
  680. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  681. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  682. data/lib/plaid/models/link_token_get_request.rb +1 -1
  683. data/lib/plaid/models/link_token_get_response.rb +1 -1
  684. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  685. data/lib/plaid/models/link_token_investments.rb +15 -5
  686. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  687. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  688. data/lib/plaid/models/loan.rb +1 -1
  689. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  690. data/lib/plaid/models/loan_filter.rb +1 -1
  691. data/lib/plaid/models/loan_identifier.rb +1 -1
  692. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  693. data/lib/plaid/models/loan_identifiers.rb +1 -1
  694. data/lib/plaid/models/loans.rb +1 -1
  695. data/lib/plaid/models/location.rb +1 -1
  696. data/lib/plaid/models/match_summary.rb +1 -1
  697. data/lib/plaid/models/match_summary_code.rb +1 -1
  698. data/lib/plaid/models/merchant_insights.rb +315 -0
  699. data/lib/plaid/models/meta.rb +1 -1
  700. data/lib/plaid/models/mfa.rb +1 -1
  701. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  702. data/lib/plaid/models/mortgage_liability.rb +1 -1
  703. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  704. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  705. data/lib/plaid/models/name_match_score.rb +1 -1
  706. data/lib/plaid/models/net_pay.rb +1 -1
  707. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  708. data/lib/plaid/models/numbers.rb +1 -1
  709. data/lib/plaid/models/numbers_acats.rb +1 -1
  710. data/lib/plaid/models/numbers_ach.rb +1 -1
  711. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  712. data/lib/plaid/models/numbers_aton.rb +1 -1
  713. data/lib/plaid/models/numbers_bacs.rb +1 -1
  714. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  715. data/lib/plaid/models/numbers_eft.rb +1 -1
  716. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  717. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  718. data/lib/plaid/models/numbers_international.rb +1 -1
  719. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  720. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  721. data/lib/plaid/models/omittable_transfer_type.rb +39 -0
  722. data/lib/plaid/models/originator.rb +1 -1
  723. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  724. data/lib/plaid/models/override_account_type.rb +1 -1
  725. data/lib/plaid/models/override_accounts.rb +1 -1
  726. data/lib/plaid/models/owner.rb +1 -1
  727. data/lib/plaid/models/owner_override.rb +1 -1
  728. data/lib/plaid/models/ownership_type.rb +1 -1
  729. data/lib/plaid/models/parties.rb +1 -1
  730. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  731. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  732. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  733. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  734. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  735. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  736. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  737. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  738. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  739. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  740. data/lib/plaid/models/partner_end_customer.rb +1 -1
  741. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  742. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  743. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  744. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  745. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  746. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  747. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  748. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  749. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  750. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  751. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  752. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  753. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  754. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  755. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  756. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  757. data/lib/plaid/models/party.rb +1 -1
  758. data/lib/plaid/models/party_individual.rb +1 -1
  759. data/lib/plaid/models/party_role_type.rb +1 -1
  760. data/lib/plaid/models/pay.rb +1 -1
  761. data/lib/plaid/models/pay_frequency.rb +1 -1
  762. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  763. data/lib/plaid/models/pay_period_details.rb +1 -1
  764. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  765. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  766. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  767. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  768. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  769. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  770. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  771. data/lib/plaid/models/payment_amount.rb +1 -1
  772. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  773. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  774. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  775. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  776. data/lib/plaid/models/payment_channel.rb +1 -1
  777. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  778. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  779. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  780. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  781. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  782. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  783. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  784. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  785. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  786. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  787. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  788. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  789. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  790. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  791. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  792. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  793. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  794. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  795. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  796. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  797. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  798. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  799. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  800. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  801. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  802. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  803. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  804. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  805. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  806. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  807. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  808. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  809. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  810. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  811. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  812. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  813. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  814. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  815. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  816. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  817. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  818. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  819. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  820. data/lib/plaid/models/payment_meta.rb +1 -1
  821. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  822. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  823. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  824. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  825. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  826. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  827. data/lib/plaid/models/payment_profile_status.rb +1 -1
  828. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  829. data/lib/plaid/models/payment_scheme.rb +1 -1
  830. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  831. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  832. data/lib/plaid/models/payroll_income_object.rb +1 -1
  833. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  834. data/lib/plaid/models/payroll_item.rb +1 -1
  835. data/lib/plaid/models/payroll_item_status.rb +1 -1
  836. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  837. data/lib/plaid/models/paystub.rb +1 -1
  838. data/lib/plaid/models/paystub_address.rb +1 -1
  839. data/lib/plaid/models/paystub_deduction.rb +1 -1
  840. data/lib/plaid/models/paystub_details.rb +1 -1
  841. data/lib/plaid/models/paystub_employer.rb +1 -1
  842. data/lib/plaid/models/paystub_override.rb +1 -1
  843. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  844. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  845. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  846. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  847. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  848. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  849. data/lib/plaid/models/personal_finance_category.rb +3 -3
  850. data/lib/plaid/models/phone_number.rb +1 -1
  851. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  852. data/lib/plaid/models/phone_type.rb +1 -1
  853. data/lib/plaid/models/physical_document_category.rb +1 -1
  854. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  855. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  856. data/lib/plaid/models/physical_document_images.rb +1 -1
  857. data/lib/plaid/models/plaid_error.rb +1 -1
  858. data/lib/plaid/models/plaid_error_type.rb +1 -1
  859. data/lib/plaid/models/platform_ids.rb +1 -1
  860. data/lib/plaid/models/po_box_status.rb +1 -1
  861. data/lib/plaid/models/processor_account_get_request.rb +246 -0
  862. data/lib/plaid/models/processor_account_get_response.rb +240 -0
  863. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  864. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  865. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  866. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  867. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  868. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  869. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  870. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  871. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  872. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  873. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  874. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  875. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  876. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  877. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  878. data/lib/plaid/models/processor_number.rb +1 -1
  879. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  880. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  881. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  882. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  883. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  884. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  885. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  886. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  887. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  888. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  889. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  890. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  891. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  892. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  893. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  894. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  895. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  896. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  897. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  898. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  899. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  900. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +5 -22
  901. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  902. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  903. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  904. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  905. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  906. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  907. data/lib/plaid/models/product_access.rb +1 -1
  908. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  909. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  910. data/lib/plaid/models/product_status.rb +1 -1
  911. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  912. data/lib/plaid/models/products.rb +1 -1
  913. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  914. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  915. data/lib/plaid/models/proxy_type.rb +1 -1
  916. data/lib/plaid/models/pslf_status.rb +1 -1
  917. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  918. data/lib/plaid/models/recipient_bacs.rb +1 -1
  919. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  920. data/lib/plaid/models/recurrence.rb +1 -1
  921. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  922. data/lib/plaid/models/recurring_frequency.rb +1 -1
  923. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  924. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  925. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  926. data/lib/plaid/models/recurring_transfer.rb +1 -1
  927. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  928. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  929. data/lib/plaid/models/removed_transaction.rb +1 -1
  930. data/lib/plaid/models/report_type.rb +2 -3
  931. data/lib/plaid/models/reporting_information.rb +1 -1
  932. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  933. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  934. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  935. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  936. data/lib/plaid/models/risk_check_details.rb +1 -1
  937. data/lib/plaid/models/risk_check_device.rb +1 -1
  938. data/lib/plaid/models/risk_check_email.rb +1 -1
  939. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  940. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  941. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  942. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  943. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  944. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  945. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  946. data/lib/plaid/models/risk_check_phone.rb +1 -1
  947. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  948. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  949. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  950. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  951. data/lib/plaid/models/role.rb +1 -1
  952. data/lib/plaid/models/role_detail.rb +1 -1
  953. data/lib/plaid/models/roles.rb +1 -1
  954. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  955. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  956. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  957. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  958. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  959. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  960. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  961. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  962. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  963. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  964. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  965. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  966. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  967. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  968. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  969. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  970. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  971. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  972. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  973. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  974. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  975. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  976. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  977. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  978. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  979. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  980. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  981. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  982. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  983. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  984. data/lib/plaid/models/{credit_freddie_mac_asset_voe25.rb → sandbox_transfer_ledger_deposit_simulate_request.rb} +49 -46
  985. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +226 -0
  986. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +242 -0
  987. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +226 -0
  988. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +270 -0
  989. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +226 -0
  990. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +282 -0
  991. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +226 -0
  992. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  993. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  994. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  995. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  996. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  997. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  998. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  999. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1000. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1001. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1002. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1003. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1004. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1005. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1006. data/lib/plaid/models/scopes.rb +1 -1
  1007. data/lib/plaid/models/scopes_context.rb +1 -1
  1008. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1009. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1010. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1011. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1012. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1013. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1014. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1015. data/lib/plaid/models/security.rb +3 -3
  1016. data/lib/plaid/models/security_override.rb +3 -3
  1017. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1018. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1019. data/lib/plaid/models/selfie_capture.rb +1 -1
  1020. data/lib/plaid/models/selfie_check.rb +1 -1
  1021. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1022. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1023. data/lib/plaid/models/selfie_status.rb +1 -1
  1024. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1025. data/lib/plaid/models/service.rb +1 -1
  1026. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1027. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1028. data/lib/plaid/models/service_product_fulfillment_identifier.rb +2 -2
  1029. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1030. data/lib/plaid/models/services.rb +1 -1
  1031. data/lib/plaid/models/signal_address_data.rb +1 -1
  1032. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1033. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1034. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1035. data/lib/plaid/models/signal_device.rb +1 -1
  1036. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1037. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1038. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1039. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1040. data/lib/plaid/models/signal_person_name.rb +1 -1
  1041. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1042. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1043. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1044. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1045. data/lib/plaid/models/signal_scores.rb +1 -1
  1046. data/lib/plaid/models/signal_user.rb +1 -1
  1047. data/lib/plaid/models/signal_warning.rb +2 -2
  1048. data/lib/plaid/models/simulated_transfer_sweep.rb +26 -6
  1049. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1050. data/lib/plaid/models/source.rb +1 -1
  1051. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1052. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1053. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1054. data/lib/plaid/models/statements_account.rb +2 -2
  1055. data/lib/plaid/models/statements_download_request.rb +1 -1
  1056. data/lib/plaid/models/statements_list_request.rb +1 -1
  1057. data/lib/plaid/models/statements_list_response.rb +1 -1
  1058. data/lib/plaid/models/statements_statement.rb +23 -2
  1059. data/lib/plaid/models/status.rb +1 -1
  1060. data/lib/plaid/models/statuses.rb +1 -1
  1061. data/lib/plaid/models/strategy.rb +1 -1
  1062. data/lib/plaid/models/student_loan.rb +1 -1
  1063. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1064. data/lib/plaid/models/student_loan_status.rb +1 -1
  1065. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  1066. data/lib/plaid/models/sweep_status.rb +1 -1
  1067. data/lib/plaid/models/sweep_trigger.rb +41 -0
  1068. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1069. data/lib/plaid/models/taxform.rb +1 -1
  1070. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1071. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1072. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1073. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1074. data/lib/plaid/models/total.rb +1 -1
  1075. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1076. data/lib/plaid/models/transaction.rb +22 -11
  1077. data/lib/plaid/models/transaction_all_of.rb +18 -7
  1078. data/lib/plaid/models/transaction_base.rb +5 -5
  1079. data/lib/plaid/models/transaction_code.rb +1 -1
  1080. data/lib/plaid/models/transaction_counterparty.rb +29 -7
  1081. data/lib/plaid/models/transaction_data.rb +1 -1
  1082. data/lib/plaid/models/transaction_override.rb +1 -1
  1083. data/lib/plaid/models/transaction_stream.rb +1 -1
  1084. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1085. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1086. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1087. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1088. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1089. data/lib/plaid/models/{transactions_enrich_get_request.rb → transactions_enrich_request.rb} +5 -5
  1090. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1091. data/lib/plaid/models/{transactions_enrich_get_response.rb → transactions_enrich_response.rb} +5 -5
  1092. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1093. data/lib/plaid/models/transactions_get_request_options.rb +5 -5
  1094. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1095. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1096. data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
  1097. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1098. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1099. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1100. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1101. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1102. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1103. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1104. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1105. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1106. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1107. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1108. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1109. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1110. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1111. data/lib/plaid/models/transactions_sync_request_options.rb +3 -3
  1112. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1113. data/lib/plaid/models/transactions_user_insights_get_request.rb +246 -0
  1114. data/lib/plaid/models/{credit_freddie_verification_of_employment_deal_voe25.rb → transactions_user_insights_get_response.rb} +27 -37
  1115. data/lib/plaid/models/transfer.rb +17 -7
  1116. data/lib/plaid/models/transfer_ach_network.rb +39 -0
  1117. data/lib/plaid/models/transfer_authorization.rb +12 -12
  1118. data/lib/plaid/models/transfer_authorization_create_request.rb +18 -8
  1119. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1120. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1121. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1122. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +2 -1
  1123. data/lib/plaid/models/transfer_authorization_device.rb +4 -4
  1124. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1125. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1126. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1127. data/lib/plaid/models/{credit_freddie_mac_asset_detail_voe25.rb → transfer_authorization_payment_risk.rb} +85 -91
  1128. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
  1129. data/lib/plaid/models/transfer_authorization_risk_level.rb +42 -0
  1130. data/lib/plaid/models/transfer_authorization_user_in_request.rb +5 -5
  1131. data/lib/plaid/models/transfer_balance.rb +1 -1
  1132. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1133. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1134. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1135. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1136. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1137. data/lib/plaid/models/transfer_capabilities_get_request.rb +13 -3
  1138. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1139. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1140. data/lib/plaid/models/transfer_configuration_get_request.rb +2 -2
  1141. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1142. data/lib/plaid/models/transfer_create_request.rb +18 -18
  1143. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1144. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1145. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1146. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1147. data/lib/plaid/models/transfer_device.rb +1 -1
  1148. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +2 -2
  1149. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1150. data/lib/plaid/models/transfer_diligence_status.rb +3 -1
  1151. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1152. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1153. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1154. data/lib/plaid/models/transfer_event.rb +5 -20
  1155. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1156. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1157. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1158. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1159. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1160. data/lib/plaid/models/transfer_event_type.rb +6 -1
  1161. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1162. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1163. data/lib/plaid/models/transfer_failure.rb +1 -1
  1164. data/lib/plaid/models/{fraud_amount_nullable.rb → transfer_funding_account.rb} +26 -25
  1165. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1166. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1167. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1168. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1169. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1170. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1171. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  1172. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1173. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1174. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1175. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1176. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1177. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1178. data/lib/plaid/models/{signal_insights.rb → transfer_ledger_balance.rb} +30 -21
  1179. data/lib/plaid/models/transfer_ledger_deposit_request.rb +346 -0
  1180. data/lib/plaid/models/{credit_freddie_mac_services_voe25.rb → transfer_ledger_deposit_response.rb} +30 -15
  1181. data/lib/plaid/models/{credit_freddie_mac_service_voe25.rb → transfer_ledger_get_request.rb} +31 -30
  1182. data/lib/plaid/models/{credit_freddie_verification_of_employment_voe25.rb → transfer_ledger_get_response.rb} +25 -25
  1183. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +41 -0
  1184. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +346 -0
  1185. data/lib/plaid/models/{credit_freddie_mac_verification_of_assets_voa24.rb → transfer_ledger_withdraw_response.rb} +25 -25
  1186. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1187. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1188. data/lib/plaid/models/transfer_metrics_get_request.rb +2 -2
  1189. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1190. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1191. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1192. data/lib/plaid/models/transfer_network.rb +1 -1
  1193. data/lib/plaid/models/transfer_originator_address.rb +5 -1
  1194. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1195. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1196. data/lib/plaid/models/transfer_originator_diligence.rb +19 -5
  1197. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +260 -0
  1198. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +226 -0
  1199. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1200. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1201. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1202. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1203. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1204. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1205. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1206. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1207. data/lib/plaid/models/transfer_recurring_create_request.rb +4 -9
  1208. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1209. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1210. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1211. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1212. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1213. data/lib/plaid/models/transfer_recurring_schedule.rb +3 -3
  1214. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1215. data/lib/plaid/models/transfer_refund.rb +1 -1
  1216. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1217. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1218. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1219. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1220. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1221. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1222. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1223. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1224. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1225. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1226. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1227. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1228. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1229. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1230. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1231. data/lib/plaid/models/transfer_status.rb +1 -1
  1232. data/lib/plaid/models/transfer_sweep.rb +26 -6
  1233. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1234. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1235. data/lib/plaid/models/transfer_sweep_list_request.rb +16 -6
  1236. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1237. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1238. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1239. data/lib/plaid/models/transfer_type.rb +1 -1
  1240. data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
  1241. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1242. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1243. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1244. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1245. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1246. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1247. data/lib/plaid/models/user_address.rb +1 -1
  1248. data/lib/plaid/models/user_create_request.rb +1 -1
  1249. data/lib/plaid/models/user_create_response.rb +1 -1
  1250. data/lib/plaid/models/user_custom_password.rb +1 -1
  1251. data/lib/plaid/models/user_data_overview.rb +291 -0
  1252. data/lib/plaid/models/user_id_number.rb +1 -1
  1253. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1254. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1255. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1256. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1257. data/lib/plaid/models/user_update_request.rb +256 -0
  1258. data/lib/plaid/models/{credit_freddie_mac_assets_voa24.rb → user_update_response.rb} +16 -18
  1259. data/lib/plaid/models/validation_source.rb +1 -1
  1260. data/lib/plaid/models/validation_sources.rb +1 -1
  1261. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1262. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1263. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1264. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1265. data/lib/plaid/models/verification_status.rb +1 -1
  1266. data/lib/plaid/models/w2.rb +1 -1
  1267. data/lib/plaid/models/w2_box12.rb +1 -1
  1268. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1269. data/lib/plaid/models/wallet.rb +1 -1
  1270. data/lib/plaid/models/wallet_balance.rb +1 -1
  1271. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1272. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1273. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1274. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1275. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1276. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1277. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1278. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1279. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1280. data/lib/plaid/models/wallet_status.rb +1 -1
  1281. data/lib/plaid/models/wallet_transaction.rb +4 -4
  1282. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1283. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1284. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1285. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1286. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1287. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1288. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1289. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1290. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1291. data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
  1292. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1293. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1294. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1295. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1296. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +2 -2
  1297. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1298. data/lib/plaid/models/warning.rb +1 -1
  1299. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1300. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1301. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1302. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1303. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1304. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1305. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1306. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1307. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1308. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1309. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1310. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1311. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1312. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1313. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1314. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1315. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1316. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1317. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1318. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1319. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1320. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1321. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1322. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1323. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1324. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1325. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1326. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1327. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1328. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1329. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1330. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1331. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1332. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1333. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1334. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1335. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1336. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1337. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1338. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1339. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1340. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1341. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1342. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1343. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1344. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1345. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1346. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1347. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1348. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1349. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1350. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1351. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1352. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1353. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1354. data/lib/plaid/models/webhook_type.rb +1 -1
  1355. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1356. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1357. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1358. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1359. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1360. data/lib/plaid/version.rb +2 -2
  1361. data/lib/plaid.rb +76 -35
  1362. data/plaid.gemspec +1 -1
  1363. data/test/test_enrich.rb +2 -2
  1364. metadata +77 -37
  1365. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +0 -324
  1366. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +0 -225
  1367. data/test/test_deposit_switch.rb +0 -73
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.419.0
6
+ The version of the OpenAPI document: 2020-09-14_1.457.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.1.0
@@ -564,7 +564,7 @@ module Plaid
564
564
  end
565
565
 
566
566
  # Retrieve an Asset Report
567
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
567
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
568
568
  # @param asset_report_get_request [AssetReportGetRequest]
569
569
  # @param [Hash] opts the optional parameters
570
570
  # @return [AssetReportGetResponse]
@@ -574,7 +574,7 @@ module Plaid
574
574
  end
575
575
 
576
576
  # Retrieve an Asset Report
577
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
577
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
578
578
  # @param asset_report_get_request [AssetReportGetRequest]
579
579
  # @param [Hash] opts the optional parameters
580
580
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -632,7 +632,7 @@ module Plaid
632
632
  end
633
633
 
634
634
  # Retrieve a PDF Asset Report
635
- # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
635
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
636
636
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
637
637
  # @param [Hash] opts the optional parameters
638
638
  # @return [File]
@@ -642,7 +642,7 @@ module Plaid
642
642
  end
643
643
 
644
644
  # Retrieve a PDF Asset Report
645
- # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. If &#x60;report_type&#x60; was set to &#x60;VERIFICATION_OF_EMPLOYMENT&#x60; when the Asset Report was created in &#x60;/asset_report/create&#x60;, debit transactions and transaction amounts won’t be included in the report. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
645
+ # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
646
646
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
647
647
  # @param [Hash] opts the optional parameters
648
648
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -1719,6 +1719,142 @@ module Plaid
1719
1719
  return data, status_code, headers
1720
1720
  end
1721
1721
 
1722
+ # List Beacon Reports for a Beacon User
1723
+ # Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
1724
+ # @param beacon_report_list_request [BeaconReportListRequest]
1725
+ # @param [Hash] opts the optional parameters
1726
+ # @return [BeaconReportListResponse]
1727
+ def beacon_report_list(beacon_report_list_request, opts = {})
1728
+ data, _status_code, _headers = beacon_report_list_with_http_info(beacon_report_list_request, opts)
1729
+ data
1730
+ end
1731
+
1732
+ # List Beacon Reports for a Beacon User
1733
+ # Use the &#x60;/beacon/report/list&#x60; endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.
1734
+ # @param beacon_report_list_request [BeaconReportListRequest]
1735
+ # @param [Hash] opts the optional parameters
1736
+ # @return [Array<(BeaconReportListResponse, Integer, Hash)>] BeaconReportListResponse data, response status code and response headers
1737
+ def beacon_report_list_with_http_info(beacon_report_list_request, opts = {})
1738
+ if @api_client.config.debugging
1739
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_list ...'
1740
+ end
1741
+ # verify the required parameter 'beacon_report_list_request' is set
1742
+ if @api_client.config.client_side_validation && beacon_report_list_request.nil?
1743
+ fail ArgumentError, "Missing the required parameter 'beacon_report_list_request' when calling PlaidApi.beacon_report_list"
1744
+ end
1745
+ # resource path
1746
+ local_var_path = '/beacon/report/list'
1747
+
1748
+ # query parameters
1749
+ query_params = opts[:query_params] || {}
1750
+
1751
+ # header parameters
1752
+ header_params = opts[:header_params] || {}
1753
+ # HTTP header 'Accept' (if needed)
1754
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1755
+ # HTTP header 'Content-Type'
1756
+ content_type = @api_client.select_header_content_type(['application/json'])
1757
+ if !content_type.nil?
1758
+ header_params['Content-Type'] = content_type
1759
+ end
1760
+
1761
+ # form parameters
1762
+ form_params = opts[:form_params] || {}
1763
+
1764
+ # http body (model)
1765
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_list_request)
1766
+
1767
+ # return_type
1768
+ return_type = opts[:debug_return_type] || 'BeaconReportListResponse'
1769
+
1770
+ # auth_names
1771
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1772
+
1773
+ new_options = opts.merge(
1774
+ :operation => :"PlaidApi.beacon_report_list",
1775
+ :header_params => header_params,
1776
+ :query_params => query_params,
1777
+ :form_params => form_params,
1778
+ :body => post_body,
1779
+ :auth_names => auth_names,
1780
+ :return_type => return_type
1781
+ )
1782
+
1783
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1784
+ if @api_client.config.debugging
1785
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_report_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1786
+ end
1787
+ return data, status_code, headers
1788
+ end
1789
+
1790
+ # List Beacon Report Syndications for a Beacon User
1791
+ # Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
1792
+ # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
1793
+ # @param [Hash] opts the optional parameters
1794
+ # @return [BeaconReportSyndicationListResponse]
1795
+ def beacon_report_syndication_list(beacon_report_syndication_list_request, opts = {})
1796
+ data, _status_code, _headers = beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts)
1797
+ data
1798
+ end
1799
+
1800
+ # List Beacon Report Syndications for a Beacon User
1801
+ # Use the &#x60;/beacon/report_syndication/list&#x60; endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.
1802
+ # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
1803
+ # @param [Hash] opts the optional parameters
1804
+ # @return [Array<(BeaconReportSyndicationListResponse, Integer, Hash)>] BeaconReportSyndicationListResponse data, response status code and response headers
1805
+ def beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts = {})
1806
+ if @api_client.config.debugging
1807
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_list ...'
1808
+ end
1809
+ # verify the required parameter 'beacon_report_syndication_list_request' is set
1810
+ if @api_client.config.client_side_validation && beacon_report_syndication_list_request.nil?
1811
+ fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_list_request' when calling PlaidApi.beacon_report_syndication_list"
1812
+ end
1813
+ # resource path
1814
+ local_var_path = '/beacon/report_syndication/list'
1815
+
1816
+ # query parameters
1817
+ query_params = opts[:query_params] || {}
1818
+
1819
+ # header parameters
1820
+ header_params = opts[:header_params] || {}
1821
+ # HTTP header 'Accept' (if needed)
1822
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1823
+ # HTTP header 'Content-Type'
1824
+ content_type = @api_client.select_header_content_type(['application/json'])
1825
+ if !content_type.nil?
1826
+ header_params['Content-Type'] = content_type
1827
+ end
1828
+
1829
+ # form parameters
1830
+ form_params = opts[:form_params] || {}
1831
+
1832
+ # http body (model)
1833
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_syndication_list_request)
1834
+
1835
+ # return_type
1836
+ return_type = opts[:debug_return_type] || 'BeaconReportSyndicationListResponse'
1837
+
1838
+ # auth_names
1839
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1840
+
1841
+ new_options = opts.merge(
1842
+ :operation => :"PlaidApi.beacon_report_syndication_list",
1843
+ :header_params => header_params,
1844
+ :query_params => query_params,
1845
+ :form_params => form_params,
1846
+ :body => post_body,
1847
+ :auth_names => auth_names,
1848
+ :return_type => return_type
1849
+ )
1850
+
1851
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1852
+ if @api_client.config.debugging
1853
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_report_syndication_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1854
+ end
1855
+ return data, status_code, headers
1856
+ end
1857
+
1722
1858
  # Create a Beacon User
1723
1859
  # Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
1724
1860
  # @param beacon_user_create_request [BeaconUserCreateRequest]
@@ -2875,6 +3011,74 @@ module Plaid
2875
3011
  return data, status_code, headers
2876
3012
  end
2877
3013
 
3014
+ # Update the parsing configuration for a document income verification
3015
+ # `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
3016
+ # @param request_body [Hash<String, Object>]
3017
+ # @param [Hash] opts the optional parameters
3018
+ # @return [CreditPayrollIncomeParsingConfigUpdateResponse]
3019
+ def credit_payroll_income_parsing_config_update(request_body, opts = {})
3020
+ data, _status_code, _headers = credit_payroll_income_parsing_config_update_with_http_info(request_body, opts)
3021
+ data
3022
+ end
3023
+
3024
+ # Update the parsing configuration for a document income verification
3025
+ # &#x60;/credit/payroll_income/parsing_config/update&#x60; updates the parsing configuration for a document income verification.
3026
+ # @param request_body [Hash<String, Object>]
3027
+ # @param [Hash] opts the optional parameters
3028
+ # @return [Array<(CreditPayrollIncomeParsingConfigUpdateResponse, Integer, Hash)>] CreditPayrollIncomeParsingConfigUpdateResponse data, response status code and response headers
3029
+ def credit_payroll_income_parsing_config_update_with_http_info(request_body, opts = {})
3030
+ if @api_client.config.debugging
3031
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_parsing_config_update ...'
3032
+ end
3033
+ # verify the required parameter 'request_body' is set
3034
+ if @api_client.config.client_side_validation && request_body.nil?
3035
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_payroll_income_parsing_config_update"
3036
+ end
3037
+ # resource path
3038
+ local_var_path = '/credit/payroll_income/parsing_config/update'
3039
+
3040
+ # query parameters
3041
+ query_params = opts[:query_params] || {}
3042
+
3043
+ # header parameters
3044
+ header_params = opts[:header_params] || {}
3045
+ # HTTP header 'Accept' (if needed)
3046
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3047
+ # HTTP header 'Content-Type'
3048
+ content_type = @api_client.select_header_content_type(['application/json'])
3049
+ if !content_type.nil?
3050
+ header_params['Content-Type'] = content_type
3051
+ end
3052
+
3053
+ # form parameters
3054
+ form_params = opts[:form_params] || {}
3055
+
3056
+ # http body (model)
3057
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
3058
+
3059
+ # return_type
3060
+ return_type = opts[:debug_return_type] || 'CreditPayrollIncomeParsingConfigUpdateResponse'
3061
+
3062
+ # auth_names
3063
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3064
+
3065
+ new_options = opts.merge(
3066
+ :operation => :"PlaidApi.credit_payroll_income_parsing_config_update",
3067
+ :header_params => header_params,
3068
+ :query_params => query_params,
3069
+ :form_params => form_params,
3070
+ :body => post_body,
3071
+ :auth_names => auth_names,
3072
+ :return_type => return_type
3073
+ )
3074
+
3075
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3076
+ if @api_client.config.debugging
3077
+ @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_parsing_config_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3078
+ end
3079
+ return data, status_code, headers
3080
+ end
3081
+
2878
3082
  # Check income verification eligibility and optimize conversion
2879
3083
  # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
2880
3084
  # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
@@ -7839,6 +8043,74 @@ module Plaid
7839
8043
  return data, status_code, headers
7840
8044
  end
7841
8045
 
8046
+ # Retrieve the account associated with a processor token
8047
+ # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable.
8048
+ # @param processor_account_get_request [ProcessorAccountGetRequest]
8049
+ # @param [Hash] opts the optional parameters
8050
+ # @return [ProcessorAccountGetResponse]
8051
+ def processor_account_get(processor_account_get_request, opts = {})
8052
+ data, _status_code, _headers = processor_account_get_with_http_info(processor_account_get_request, opts)
8053
+ data
8054
+ end
8055
+
8056
+ # Retrieve the account associated with a processor token
8057
+ # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use &#x60;/processor/balance/get&#x60; instead. Note that some information is nullable.
8058
+ # @param processor_account_get_request [ProcessorAccountGetRequest]
8059
+ # @param [Hash] opts the optional parameters
8060
+ # @return [Array<(ProcessorAccountGetResponse, Integer, Hash)>] ProcessorAccountGetResponse data, response status code and response headers
8061
+ def processor_account_get_with_http_info(processor_account_get_request, opts = {})
8062
+ if @api_client.config.debugging
8063
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_account_get ...'
8064
+ end
8065
+ # verify the required parameter 'processor_account_get_request' is set
8066
+ if @api_client.config.client_side_validation && processor_account_get_request.nil?
8067
+ fail ArgumentError, "Missing the required parameter 'processor_account_get_request' when calling PlaidApi.processor_account_get"
8068
+ end
8069
+ # resource path
8070
+ local_var_path = '/processor/account/get'
8071
+
8072
+ # query parameters
8073
+ query_params = opts[:query_params] || {}
8074
+
8075
+ # header parameters
8076
+ header_params = opts[:header_params] || {}
8077
+ # HTTP header 'Accept' (if needed)
8078
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8079
+ # HTTP header 'Content-Type'
8080
+ content_type = @api_client.select_header_content_type(['application/json'])
8081
+ if !content_type.nil?
8082
+ header_params['Content-Type'] = content_type
8083
+ end
8084
+
8085
+ # form parameters
8086
+ form_params = opts[:form_params] || {}
8087
+
8088
+ # http body (model)
8089
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_account_get_request)
8090
+
8091
+ # return_type
8092
+ return_type = opts[:debug_return_type] || 'ProcessorAccountGetResponse'
8093
+
8094
+ # auth_names
8095
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8096
+
8097
+ new_options = opts.merge(
8098
+ :operation => :"PlaidApi.processor_account_get",
8099
+ :header_params => header_params,
8100
+ :query_params => query_params,
8101
+ :form_params => form_params,
8102
+ :body => post_body,
8103
+ :auth_names => auth_names,
8104
+ :return_type => return_type
8105
+ )
8106
+
8107
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8108
+ if @api_client.config.debugging
8109
+ @api_client.config.logger.debug "API called: PlaidApi#processor_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8110
+ end
8111
+ return data, status_code, headers
8112
+ end
8113
+
7842
8114
  # Create Apex bank account token
7843
8115
  # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
7844
8116
  # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
@@ -8724,7 +8996,7 @@ module Plaid
8724
8996
  end
8725
8997
 
8726
8998
  # Update a processor token's webhook URL
8727
- # This endpoint allows you to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL.
8999
+ # This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL.
8728
9000
  # @param processor_token_webhook_update_request [ProcessorTokenWebhookUpdateRequest]
8729
9001
  # @param [Hash] opts the optional parameters
8730
9002
  # @return [ProcessorTokenWebhookUpdateResponse]
@@ -8734,7 +9006,7 @@ module Plaid
8734
9006
  end
8735
9007
 
8736
9008
  # Update a processor token&#39;s webhook URL
8737
- # This endpoint allows you to update the webhook URL associated with a processor token. This request triggers a &#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60; webhook to the newly specified webhook URL.
9009
+ # This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a &#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60; webhook to the newly specified webhook URL.
8738
9010
  # @param processor_token_webhook_update_request [ProcessorTokenWebhookUpdateRequest]
8739
9011
  # @param [Hash] opts the optional parameters
8740
9012
  # @return [Array<(ProcessorTokenWebhookUpdateResponse, Integer, Hash)>] ProcessorTokenWebhookUpdateResponse data, response status code and response headers
@@ -9336,7 +9608,7 @@ module Plaid
9336
9608
  end
9337
9609
 
9338
9610
  # Fire a test webhook
9339
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
9611
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type `TRANSFER`).
9340
9612
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
9341
9613
  # @param [Hash] opts the optional parameters
9342
9614
  # @return [SandboxItemFireWebhookResponse]
@@ -9346,7 +9618,7 @@ module Plaid
9346
9618
  end
9347
9619
 
9348
9620
  # Fire a test webhook
9349
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
9621
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type &#x60;TRANSFER&#x60;).
9350
9622
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
9351
9623
  # @param [Hash] opts the optional parameters
9352
9624
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -9812,7 +10084,7 @@ module Plaid
9812
10084
  end
9813
10085
 
9814
10086
  # Manually fire a Transfer webhook
9815
- # Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a Transfer webhook in the Sandbox environment.
10087
+ # Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.
9816
10088
  # @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
9817
10089
  # @param [Hash] opts the optional parameters
9818
10090
  # @return [SandboxTransferFireWebhookResponse]
@@ -9822,7 +10094,7 @@ module Plaid
9822
10094
  end
9823
10095
 
9824
10096
  # Manually fire a Transfer webhook
9825
- # Use the &#x60;/sandbox/transfer/fire_webhook&#x60; endpoint to manually trigger a Transfer webhook in the Sandbox environment.
10097
+ # Use the &#x60;/sandbox/transfer/fire_webhook&#x60; endpoint to manually trigger a &#x60;TRANSFER_EVENTS_UPDATE&#x60; webhook in the Sandbox environment.
9826
10098
  # @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
9827
10099
  # @param [Hash] opts the optional parameters
9828
10100
  # @return [Array<(SandboxTransferFireWebhookResponse, Integer, Hash)>] SandboxTransferFireWebhookResponse data, response status code and response headers
@@ -9879,31 +10151,31 @@ module Plaid
9879
10151
  return data, status_code, headers
9880
10152
  end
9881
10153
 
9882
- # Trigger the creation of a repayment
9883
- # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
9884
- # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
10154
+ # Simulate a ledger deposit event in Sandbox
10155
+ # Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment.
10156
+ # @param sandbox_transfer_ledger_deposit_simulate_request [SandboxTransferLedgerDepositSimulateRequest]
9885
10157
  # @param [Hash] opts the optional parameters
9886
- # @return [SandboxTransferRepaymentSimulateResponse]
9887
- def sandbox_transfer_repayment_simulate(sandbox_transfer_repayment_simulate_request, opts = {})
9888
- data, _status_code, _headers = sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts)
10158
+ # @return [SandboxTransferLedgerDepositSimulateResponse]
10159
+ def sandbox_transfer_ledger_deposit_simulate(sandbox_transfer_ledger_deposit_simulate_request, opts = {})
10160
+ data, _status_code, _headers = sandbox_transfer_ledger_deposit_simulate_with_http_info(sandbox_transfer_ledger_deposit_simulate_request, opts)
9889
10161
  data
9890
10162
  end
9891
10163
 
9892
- # Trigger the creation of a repayment
9893
- # Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
9894
- # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
10164
+ # Simulate a ledger deposit event in Sandbox
10165
+ # Use the &#x60;/sandbox/transfer/ledger/deposit/simulate&#x60; endpoint to simulate a ledger deposit event in the Sandbox environment.
10166
+ # @param sandbox_transfer_ledger_deposit_simulate_request [SandboxTransferLedgerDepositSimulateRequest]
9895
10167
  # @param [Hash] opts the optional parameters
9896
- # @return [Array<(SandboxTransferRepaymentSimulateResponse, Integer, Hash)>] SandboxTransferRepaymentSimulateResponse data, response status code and response headers
9897
- def sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts = {})
10168
+ # @return [Array<(SandboxTransferLedgerDepositSimulateResponse, Integer, Hash)>] SandboxTransferLedgerDepositSimulateResponse data, response status code and response headers
10169
+ def sandbox_transfer_ledger_deposit_simulate_with_http_info(sandbox_transfer_ledger_deposit_simulate_request, opts = {})
9898
10170
  if @api_client.config.debugging
9899
- @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_repayment_simulate ...'
10171
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_deposit_simulate ...'
9900
10172
  end
9901
- # verify the required parameter 'sandbox_transfer_repayment_simulate_request' is set
9902
- if @api_client.config.client_side_validation && sandbox_transfer_repayment_simulate_request.nil?
9903
- fail ArgumentError, "Missing the required parameter 'sandbox_transfer_repayment_simulate_request' when calling PlaidApi.sandbox_transfer_repayment_simulate"
10173
+ # verify the required parameter 'sandbox_transfer_ledger_deposit_simulate_request' is set
10174
+ if @api_client.config.client_side_validation && sandbox_transfer_ledger_deposit_simulate_request.nil?
10175
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_deposit_simulate_request' when calling PlaidApi.sandbox_transfer_ledger_deposit_simulate"
9904
10176
  end
9905
10177
  # resource path
9906
- local_var_path = '/sandbox/transfer/repayment/simulate'
10178
+ local_var_path = '/sandbox/transfer/ledger/deposit/simulate'
9907
10179
 
9908
10180
  # query parameters
9909
10181
  query_params = opts[:query_params] || {}
@@ -9922,16 +10194,16 @@ module Plaid
9922
10194
  form_params = opts[:form_params] || {}
9923
10195
 
9924
10196
  # http body (model)
9925
- post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_repayment_simulate_request)
10197
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_deposit_simulate_request)
9926
10198
 
9927
10199
  # return_type
9928
- return_type = opts[:debug_return_type] || 'SandboxTransferRepaymentSimulateResponse'
10200
+ return_type = opts[:debug_return_type] || 'SandboxTransferLedgerDepositSimulateResponse'
9929
10201
 
9930
10202
  # auth_names
9931
10203
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9932
10204
 
9933
10205
  new_options = opts.merge(
9934
- :operation => :"PlaidApi.sandbox_transfer_repayment_simulate",
10206
+ :operation => :"PlaidApi.sandbox_transfer_ledger_deposit_simulate",
9935
10207
  :header_params => header_params,
9936
10208
  :query_params => query_params,
9937
10209
  :form_params => form_params,
@@ -9942,36 +10214,36 @@ module Plaid
9942
10214
 
9943
10215
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9944
10216
  if @api_client.config.debugging
9945
- @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_repayment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10217
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_deposit_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9946
10218
  end
9947
10219
  return data, status_code, headers
9948
10220
  end
9949
10221
 
9950
- # Simulate a transfer event in Sandbox
9951
- # Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
9952
- # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
10222
+ # Simulate converting pending balance to available balance
10223
+ # Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.
10224
+ # @param sandbox_transfer_ledger_simulate_available_request [SandboxTransferLedgerSimulateAvailableRequest]
9953
10225
  # @param [Hash] opts the optional parameters
9954
- # @return [SandboxTransferSimulateResponse]
9955
- def sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {})
9956
- data, _status_code, _headers = sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts)
10226
+ # @return [SandboxTransferLedgerSimulateAvailableResponse]
10227
+ def sandbox_transfer_ledger_simulate_available(sandbox_transfer_ledger_simulate_available_request, opts = {})
10228
+ data, _status_code, _headers = sandbox_transfer_ledger_simulate_available_with_http_info(sandbox_transfer_ledger_simulate_available_request, opts)
9957
10229
  data
9958
10230
  end
9959
10231
 
9960
- # Simulate a transfer event in Sandbox
9961
- # Use the &#x60;/sandbox/transfer/simulate&#x60; endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
9962
- # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
10232
+ # Simulate converting pending balance to available balance
10233
+ # Use the &#x60;/sandbox/transfer/ledger/simulate_available&#x60; endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.
10234
+ # @param sandbox_transfer_ledger_simulate_available_request [SandboxTransferLedgerSimulateAvailableRequest]
9963
10235
  # @param [Hash] opts the optional parameters
9964
- # @return [Array<(SandboxTransferSimulateResponse, Integer, Hash)>] SandboxTransferSimulateResponse data, response status code and response headers
9965
- def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {})
10236
+ # @return [Array<(SandboxTransferLedgerSimulateAvailableResponse, Integer, Hash)>] SandboxTransferLedgerSimulateAvailableResponse data, response status code and response headers
10237
+ def sandbox_transfer_ledger_simulate_available_with_http_info(sandbox_transfer_ledger_simulate_available_request, opts = {})
9966
10238
  if @api_client.config.debugging
9967
- @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_simulate ...'
10239
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_simulate_available ...'
9968
10240
  end
9969
- # verify the required parameter 'sandbox_transfer_simulate_request' is set
9970
- if @api_client.config.client_side_validation && sandbox_transfer_simulate_request.nil?
9971
- fail ArgumentError, "Missing the required parameter 'sandbox_transfer_simulate_request' when calling PlaidApi.sandbox_transfer_simulate"
10241
+ # verify the required parameter 'sandbox_transfer_ledger_simulate_available_request' is set
10242
+ if @api_client.config.client_side_validation && sandbox_transfer_ledger_simulate_available_request.nil?
10243
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_simulate_available_request' when calling PlaidApi.sandbox_transfer_ledger_simulate_available"
9972
10244
  end
9973
10245
  # resource path
9974
- local_var_path = '/sandbox/transfer/simulate'
10246
+ local_var_path = '/sandbox/transfer/ledger/simulate_available'
9975
10247
 
9976
10248
  # query parameters
9977
10249
  query_params = opts[:query_params] || {}
@@ -9990,16 +10262,16 @@ module Plaid
9990
10262
  form_params = opts[:form_params] || {}
9991
10263
 
9992
10264
  # http body (model)
9993
- post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_simulate_request)
10265
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_simulate_available_request)
9994
10266
 
9995
10267
  # return_type
9996
- return_type = opts[:debug_return_type] || 'SandboxTransferSimulateResponse'
10268
+ return_type = opts[:debug_return_type] || 'SandboxTransferLedgerSimulateAvailableResponse'
9997
10269
 
9998
10270
  # auth_names
9999
10271
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10000
10272
 
10001
10273
  new_options = opts.merge(
10002
- :operation => :"PlaidApi.sandbox_transfer_simulate",
10274
+ :operation => :"PlaidApi.sandbox_transfer_ledger_simulate_available",
10003
10275
  :header_params => header_params,
10004
10276
  :query_params => query_params,
10005
10277
  :form_params => form_params,
@@ -10010,36 +10282,36 @@ module Plaid
10010
10282
 
10011
10283
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10012
10284
  if @api_client.config.debugging
10013
- @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10285
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_simulate_available\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10014
10286
  end
10015
10287
  return data, status_code, headers
10016
10288
  end
10017
10289
 
10018
- # Simulate creating a sweep
10019
- # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
10020
- # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
10290
+ # Simulate a ledger withdraw event in Sandbox
10291
+ # Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.
10292
+ # @param sandbox_transfer_ledger_withdraw_simulate_request [SandboxTransferLedgerWithdrawSimulateRequest]
10021
10293
  # @param [Hash] opts the optional parameters
10022
- # @return [SandboxTransferSweepSimulateResponse]
10023
- def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opts = {})
10024
- data, _status_code, _headers = sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts)
10294
+ # @return [SandboxTransferLedgerWithdrawSimulateResponse]
10295
+ def sandbox_transfer_ledger_withdraw_simulate(sandbox_transfer_ledger_withdraw_simulate_request, opts = {})
10296
+ data, _status_code, _headers = sandbox_transfer_ledger_withdraw_simulate_with_http_info(sandbox_transfer_ledger_withdraw_simulate_request, opts)
10025
10297
  data
10026
10298
  end
10027
10299
 
10028
- # Simulate creating a sweep
10029
- # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_swept&#x60;.
10030
- # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
10300
+ # Simulate a ledger withdraw event in Sandbox
10301
+ # Use the &#x60;/sandbox/transfer/ledger/withdraw/simulate&#x60; endpoint to simulate a ledger withdraw event in the Sandbox environment.
10302
+ # @param sandbox_transfer_ledger_withdraw_simulate_request [SandboxTransferLedgerWithdrawSimulateRequest]
10031
10303
  # @param [Hash] opts the optional parameters
10032
- # @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
10033
- def sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts = {})
10304
+ # @return [Array<(SandboxTransferLedgerWithdrawSimulateResponse, Integer, Hash)>] SandboxTransferLedgerWithdrawSimulateResponse data, response status code and response headers
10305
+ def sandbox_transfer_ledger_withdraw_simulate_with_http_info(sandbox_transfer_ledger_withdraw_simulate_request, opts = {})
10034
10306
  if @api_client.config.debugging
10035
- @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_sweep_simulate ...'
10307
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_withdraw_simulate ...'
10036
10308
  end
10037
- # verify the required parameter 'sandbox_transfer_sweep_simulate_request' is set
10038
- if @api_client.config.client_side_validation && sandbox_transfer_sweep_simulate_request.nil?
10039
- fail ArgumentError, "Missing the required parameter 'sandbox_transfer_sweep_simulate_request' when calling PlaidApi.sandbox_transfer_sweep_simulate"
10309
+ # verify the required parameter 'sandbox_transfer_ledger_withdraw_simulate_request' is set
10310
+ if @api_client.config.client_side_validation && sandbox_transfer_ledger_withdraw_simulate_request.nil?
10311
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_withdraw_simulate_request' when calling PlaidApi.sandbox_transfer_ledger_withdraw_simulate"
10040
10312
  end
10041
10313
  # resource path
10042
- local_var_path = '/sandbox/transfer/sweep/simulate'
10314
+ local_var_path = '/sandbox/transfer/ledger/withdraw/simulate'
10043
10315
 
10044
10316
  # query parameters
10045
10317
  query_params = opts[:query_params] || {}
@@ -10058,16 +10330,16 @@ module Plaid
10058
10330
  form_params = opts[:form_params] || {}
10059
10331
 
10060
10332
  # http body (model)
10061
- post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_sweep_simulate_request)
10333
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_withdraw_simulate_request)
10062
10334
 
10063
10335
  # return_type
10064
- return_type = opts[:debug_return_type] || 'SandboxTransferSweepSimulateResponse'
10336
+ return_type = opts[:debug_return_type] || 'SandboxTransferLedgerWithdrawSimulateResponse'
10065
10337
 
10066
10338
  # auth_names
10067
10339
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10068
10340
 
10069
10341
  new_options = opts.merge(
10070
- :operation => :"PlaidApi.sandbox_transfer_sweep_simulate",
10342
+ :operation => :"PlaidApi.sandbox_transfer_ledger_withdraw_simulate",
10071
10343
  :header_params => header_params,
10072
10344
  :query_params => query_params,
10073
10345
  :form_params => form_params,
@@ -10078,13 +10350,285 @@ module Plaid
10078
10350
 
10079
10351
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10080
10352
  if @api_client.config.debugging
10081
- @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_sweep_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10353
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_withdraw_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10082
10354
  end
10083
10355
  return data, status_code, headers
10084
10356
  end
10085
10357
 
10086
- # Advance a test clock
10087
- # Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
10358
+ # Simulate a refund event in Sandbox
10359
+ # Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
10360
+ # @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest]
10361
+ # @param [Hash] opts the optional parameters
10362
+ # @return [SandboxTransferRefundSimulateResponse]
10363
+ def sandbox_transfer_refund_simulate(sandbox_transfer_refund_simulate_request, opts = {})
10364
+ data, _status_code, _headers = sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts)
10365
+ data
10366
+ end
10367
+
10368
+ # Simulate a refund event in Sandbox
10369
+ # Use the &#x60;/sandbox/transfer/refund/simulate&#x60; endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
10370
+ # @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest]
10371
+ # @param [Hash] opts the optional parameters
10372
+ # @return [Array<(SandboxTransferRefundSimulateResponse, Integer, Hash)>] SandboxTransferRefundSimulateResponse data, response status code and response headers
10373
+ def sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts = {})
10374
+ if @api_client.config.debugging
10375
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_refund_simulate ...'
10376
+ end
10377
+ # verify the required parameter 'sandbox_transfer_refund_simulate_request' is set
10378
+ if @api_client.config.client_side_validation && sandbox_transfer_refund_simulate_request.nil?
10379
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_refund_simulate_request' when calling PlaidApi.sandbox_transfer_refund_simulate"
10380
+ end
10381
+ # resource path
10382
+ local_var_path = '/sandbox/transfer/refund/simulate'
10383
+
10384
+ # query parameters
10385
+ query_params = opts[:query_params] || {}
10386
+
10387
+ # header parameters
10388
+ header_params = opts[:header_params] || {}
10389
+ # HTTP header 'Accept' (if needed)
10390
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10391
+ # HTTP header 'Content-Type'
10392
+ content_type = @api_client.select_header_content_type(['application/json'])
10393
+ if !content_type.nil?
10394
+ header_params['Content-Type'] = content_type
10395
+ end
10396
+
10397
+ # form parameters
10398
+ form_params = opts[:form_params] || {}
10399
+
10400
+ # http body (model)
10401
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_refund_simulate_request)
10402
+
10403
+ # return_type
10404
+ return_type = opts[:debug_return_type] || 'SandboxTransferRefundSimulateResponse'
10405
+
10406
+ # auth_names
10407
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10408
+
10409
+ new_options = opts.merge(
10410
+ :operation => :"PlaidApi.sandbox_transfer_refund_simulate",
10411
+ :header_params => header_params,
10412
+ :query_params => query_params,
10413
+ :form_params => form_params,
10414
+ :body => post_body,
10415
+ :auth_names => auth_names,
10416
+ :return_type => return_type
10417
+ )
10418
+
10419
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10420
+ if @api_client.config.debugging
10421
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_refund_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10422
+ end
10423
+ return data, status_code, headers
10424
+ end
10425
+
10426
+ # Trigger the creation of a repayment
10427
+ # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
10428
+ # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
10429
+ # @param [Hash] opts the optional parameters
10430
+ # @return [SandboxTransferRepaymentSimulateResponse]
10431
+ def sandbox_transfer_repayment_simulate(sandbox_transfer_repayment_simulate_request, opts = {})
10432
+ data, _status_code, _headers = sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts)
10433
+ data
10434
+ end
10435
+
10436
+ # Trigger the creation of a repayment
10437
+ # Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
10438
+ # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
10439
+ # @param [Hash] opts the optional parameters
10440
+ # @return [Array<(SandboxTransferRepaymentSimulateResponse, Integer, Hash)>] SandboxTransferRepaymentSimulateResponse data, response status code and response headers
10441
+ def sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts = {})
10442
+ if @api_client.config.debugging
10443
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_repayment_simulate ...'
10444
+ end
10445
+ # verify the required parameter 'sandbox_transfer_repayment_simulate_request' is set
10446
+ if @api_client.config.client_side_validation && sandbox_transfer_repayment_simulate_request.nil?
10447
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_repayment_simulate_request' when calling PlaidApi.sandbox_transfer_repayment_simulate"
10448
+ end
10449
+ # resource path
10450
+ local_var_path = '/sandbox/transfer/repayment/simulate'
10451
+
10452
+ # query parameters
10453
+ query_params = opts[:query_params] || {}
10454
+
10455
+ # header parameters
10456
+ header_params = opts[:header_params] || {}
10457
+ # HTTP header 'Accept' (if needed)
10458
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10459
+ # HTTP header 'Content-Type'
10460
+ content_type = @api_client.select_header_content_type(['application/json'])
10461
+ if !content_type.nil?
10462
+ header_params['Content-Type'] = content_type
10463
+ end
10464
+
10465
+ # form parameters
10466
+ form_params = opts[:form_params] || {}
10467
+
10468
+ # http body (model)
10469
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_repayment_simulate_request)
10470
+
10471
+ # return_type
10472
+ return_type = opts[:debug_return_type] || 'SandboxTransferRepaymentSimulateResponse'
10473
+
10474
+ # auth_names
10475
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10476
+
10477
+ new_options = opts.merge(
10478
+ :operation => :"PlaidApi.sandbox_transfer_repayment_simulate",
10479
+ :header_params => header_params,
10480
+ :query_params => query_params,
10481
+ :form_params => form_params,
10482
+ :body => post_body,
10483
+ :auth_names => auth_names,
10484
+ :return_type => return_type
10485
+ )
10486
+
10487
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10488
+ if @api_client.config.debugging
10489
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_repayment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10490
+ end
10491
+ return data, status_code, headers
10492
+ end
10493
+
10494
+ # Simulate a transfer event in Sandbox
10495
+ # Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
10496
+ # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
10497
+ # @param [Hash] opts the optional parameters
10498
+ # @return [SandboxTransferSimulateResponse]
10499
+ def sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {})
10500
+ data, _status_code, _headers = sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts)
10501
+ data
10502
+ end
10503
+
10504
+ # Simulate a transfer event in Sandbox
10505
+ # Use the &#x60;/sandbox/transfer/simulate&#x60; endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
10506
+ # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
10507
+ # @param [Hash] opts the optional parameters
10508
+ # @return [Array<(SandboxTransferSimulateResponse, Integer, Hash)>] SandboxTransferSimulateResponse data, response status code and response headers
10509
+ def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {})
10510
+ if @api_client.config.debugging
10511
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_simulate ...'
10512
+ end
10513
+ # verify the required parameter 'sandbox_transfer_simulate_request' is set
10514
+ if @api_client.config.client_side_validation && sandbox_transfer_simulate_request.nil?
10515
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_simulate_request' when calling PlaidApi.sandbox_transfer_simulate"
10516
+ end
10517
+ # resource path
10518
+ local_var_path = '/sandbox/transfer/simulate'
10519
+
10520
+ # query parameters
10521
+ query_params = opts[:query_params] || {}
10522
+
10523
+ # header parameters
10524
+ header_params = opts[:header_params] || {}
10525
+ # HTTP header 'Accept' (if needed)
10526
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10527
+ # HTTP header 'Content-Type'
10528
+ content_type = @api_client.select_header_content_type(['application/json'])
10529
+ if !content_type.nil?
10530
+ header_params['Content-Type'] = content_type
10531
+ end
10532
+
10533
+ # form parameters
10534
+ form_params = opts[:form_params] || {}
10535
+
10536
+ # http body (model)
10537
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_simulate_request)
10538
+
10539
+ # return_type
10540
+ return_type = opts[:debug_return_type] || 'SandboxTransferSimulateResponse'
10541
+
10542
+ # auth_names
10543
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10544
+
10545
+ new_options = opts.merge(
10546
+ :operation => :"PlaidApi.sandbox_transfer_simulate",
10547
+ :header_params => header_params,
10548
+ :query_params => query_params,
10549
+ :form_params => form_params,
10550
+ :body => post_body,
10551
+ :auth_names => auth_names,
10552
+ :return_type => return_type
10553
+ )
10554
+
10555
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10556
+ if @api_client.config.debugging
10557
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10558
+ end
10559
+ return data, status_code, headers
10560
+ end
10561
+
10562
+ # Simulate creating a sweep
10563
+ # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
10564
+ # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
10565
+ # @param [Hash] opts the optional parameters
10566
+ # @return [SandboxTransferSweepSimulateResponse]
10567
+ def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opts = {})
10568
+ data, _status_code, _headers = sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts)
10569
+ data
10570
+ end
10571
+
10572
+ # Simulate creating a sweep
10573
+ # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of &#x60;swept&#x60; will become &#x60;swept_settled&#x60;, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_swept&#x60;.
10574
+ # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
10575
+ # @param [Hash] opts the optional parameters
10576
+ # @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
10577
+ def sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts = {})
10578
+ if @api_client.config.debugging
10579
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_sweep_simulate ...'
10580
+ end
10581
+ # verify the required parameter 'sandbox_transfer_sweep_simulate_request' is set
10582
+ if @api_client.config.client_side_validation && sandbox_transfer_sweep_simulate_request.nil?
10583
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_sweep_simulate_request' when calling PlaidApi.sandbox_transfer_sweep_simulate"
10584
+ end
10585
+ # resource path
10586
+ local_var_path = '/sandbox/transfer/sweep/simulate'
10587
+
10588
+ # query parameters
10589
+ query_params = opts[:query_params] || {}
10590
+
10591
+ # header parameters
10592
+ header_params = opts[:header_params] || {}
10593
+ # HTTP header 'Accept' (if needed)
10594
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10595
+ # HTTP header 'Content-Type'
10596
+ content_type = @api_client.select_header_content_type(['application/json'])
10597
+ if !content_type.nil?
10598
+ header_params['Content-Type'] = content_type
10599
+ end
10600
+
10601
+ # form parameters
10602
+ form_params = opts[:form_params] || {}
10603
+
10604
+ # http body (model)
10605
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_sweep_simulate_request)
10606
+
10607
+ # return_type
10608
+ return_type = opts[:debug_return_type] || 'SandboxTransferSweepSimulateResponse'
10609
+
10610
+ # auth_names
10611
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10612
+
10613
+ new_options = opts.merge(
10614
+ :operation => :"PlaidApi.sandbox_transfer_sweep_simulate",
10615
+ :header_params => header_params,
10616
+ :query_params => query_params,
10617
+ :form_params => form_params,
10618
+ :body => post_body,
10619
+ :auth_names => auth_names,
10620
+ :return_type => return_type
10621
+ )
10622
+
10623
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10624
+ if @api_client.config.debugging
10625
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_sweep_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10626
+ end
10627
+ return data, status_code, headers
10628
+ end
10629
+
10630
+ # Advance a test clock
10631
+ # Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
10088
10632
  # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
10089
10633
  # @param [Hash] opts the optional parameters
10090
10634
  # @return [SandboxTransferTestClockAdvanceResponse]
@@ -10094,7 +10638,7 @@ module Plaid
10094
10638
  end
10095
10639
 
10096
10640
  # Advance a test clock
10097
- # Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;virtual_time&#x60;, but may never go back to a lower &#x60;virtual_time&#x60;. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;virtual_time&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current &#x60;virtual_time&#x60; should be limited such that there are no more than 20 originations resulting from the advance operation on each &#x60;recurring_transfer&#x60; associated with the &#x60;test_clock&#x60;. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;virtual_time&#x60; up to 80 weeks on each API call.
10641
+ # Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;virtual_time&#x60;, but may never go back to a lower &#x60;virtual_time&#x60;. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;virtual_time&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current &#x60;virtual_time&#x60; should be limited such that there are no more than 20 originations resulting from the advance operation on each &#x60;recurring_transfer&#x60; associated with the &#x60;test_clock&#x60;. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;virtual_time&#x60; up to 80 weeks on each API call.
10098
10642
  # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
10099
10643
  # @param [Hash] opts the optional parameters
10100
10644
  # @return [Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>] SandboxTransferTestClockAdvanceResponse data, response status code and response headers
@@ -10356,7 +10900,7 @@ module Plaid
10356
10900
  end
10357
10901
 
10358
10902
  # Report whether you initiated an ACH transaction
10359
- # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
10903
+ # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
10360
10904
  # @param signal_decision_report_request [SignalDecisionReportRequest]
10361
10905
  # @param [Hash] opts the optional parameters
10362
10906
  # @return [SignalDecisionReportResponse]
@@ -10366,7 +10910,7 @@ module Plaid
10366
10910
  end
10367
10911
 
10368
10912
  # Report whether you initiated an ACH transaction
10369
- # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
10913
+ # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated.
10370
10914
  # @param signal_decision_report_request [SignalDecisionReportRequest]
10371
10915
  # @param [Hash] opts the optional parameters
10372
10916
  # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
@@ -10492,7 +11036,7 @@ module Plaid
10492
11036
  end
10493
11037
 
10494
11038
  # Opt-in an Item to Signal
10495
- # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).
11039
+ # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
10496
11040
  # @param signal_prepare_request [SignalPrepareRequest]
10497
11041
  # @param [Hash] opts the optional parameters
10498
11042
  # @return [SignalPrepareResponse]
@@ -10502,7 +11046,7 @@ module Plaid
10502
11046
  end
10503
11047
 
10504
11048
  # Opt-in an Item to Signal
10505
- # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).
11049
+ # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
10506
11050
  # @param signal_prepare_request [SignalPrepareRequest]
10507
11051
  # @param [Hash] opts the optional parameters
10508
11052
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -10628,7 +11172,7 @@ module Plaid
10628
11172
  end
10629
11173
 
10630
11174
  # Retrieve a single statement.
10631
- # The `/statements/download` endpoint retrieves a single statement.
11175
+ # The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.
10632
11176
  # @param statements_download_request [StatementsDownloadRequest]
10633
11177
  # @param [Hash] opts the optional parameters
10634
11178
  # @return [File]
@@ -10638,7 +11182,7 @@ module Plaid
10638
11182
  end
10639
11183
 
10640
11184
  # Retrieve a single statement.
10641
- # The &#x60;/statements/download&#x60; endpoint retrieves a single statement.
11185
+ # The &#x60;/statements/download&#x60; endpoint retrieves a single statement PDF in binary format. The response will contain a &#x60;Plaid-Content-Hash&#x60; header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.
10642
11186
  # @param statements_download_request [StatementsDownloadRequest]
10643
11187
  # @param [Hash] opts the optional parameters
10644
11188
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -10833,26 +11377,26 @@ module Plaid
10833
11377
 
10834
11378
  # Enrich locally-held transaction data
10835
11379
  # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
10836
- # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
11380
+ # @param transactions_enrich_request [TransactionsEnrichRequest]
10837
11381
  # @param [Hash] opts the optional parameters
10838
- # @return [TransactionsEnrichGetResponse]
10839
- def transactions_enrich(transactions_enrich_get_request, opts = {})
10840
- data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_get_request, opts)
11382
+ # @return [TransactionsEnrichResponse]
11383
+ def transactions_enrich(transactions_enrich_request, opts = {})
11384
+ data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_request, opts)
10841
11385
  data
10842
11386
  end
10843
11387
 
10844
11388
  # Enrich locally-held transaction data
10845
11389
  # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
10846
- # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
11390
+ # @param transactions_enrich_request [TransactionsEnrichRequest]
10847
11391
  # @param [Hash] opts the optional parameters
10848
- # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
10849
- def transactions_enrich_with_http_info(transactions_enrich_get_request, opts = {})
11392
+ # @return [Array<(TransactionsEnrichResponse, Integer, Hash)>] TransactionsEnrichResponse data, response status code and response headers
11393
+ def transactions_enrich_with_http_info(transactions_enrich_request, opts = {})
10850
11394
  if @api_client.config.debugging
10851
11395
  @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
10852
11396
  end
10853
- # verify the required parameter 'transactions_enrich_get_request' is set
10854
- if @api_client.config.client_side_validation && transactions_enrich_get_request.nil?
10855
- fail ArgumentError, "Missing the required parameter 'transactions_enrich_get_request' when calling PlaidApi.transactions_enrich"
11397
+ # verify the required parameter 'transactions_enrich_request' is set
11398
+ if @api_client.config.client_side_validation && transactions_enrich_request.nil?
11399
+ fail ArgumentError, "Missing the required parameter 'transactions_enrich_request' when calling PlaidApi.transactions_enrich"
10856
11400
  end
10857
11401
  # resource path
10858
11402
  local_var_path = '/transactions/enrich'
@@ -10874,10 +11418,10 @@ module Plaid
10874
11418
  form_params = opts[:form_params] || {}
10875
11419
 
10876
11420
  # http body (model)
10877
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_get_request)
11421
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_request)
10878
11422
 
10879
11423
  # return_type
10880
- return_type = opts[:debug_return_type] || 'TransactionsEnrichGetResponse'
11424
+ return_type = opts[:debug_return_type] || 'TransactionsEnrichResponse'
10881
11425
 
10882
11426
  # auth_names
10883
11427
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -11317,21 +11861,89 @@ module Plaid
11317
11861
  data
11318
11862
  end
11319
11863
 
11320
- # Get incremental transaction updates on an Item
11321
- # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
11322
- # @param transactions_sync_request [TransactionsSyncRequest]
11864
+ # Get incremental transaction updates on an Item
11865
+ # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
11866
+ # @param transactions_sync_request [TransactionsSyncRequest]
11867
+ # @param [Hash] opts the optional parameters
11868
+ # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
11869
+ def transactions_sync_with_http_info(transactions_sync_request, opts = {})
11870
+ if @api_client.config.debugging
11871
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
11872
+ end
11873
+ # verify the required parameter 'transactions_sync_request' is set
11874
+ if @api_client.config.client_side_validation && transactions_sync_request.nil?
11875
+ fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
11876
+ end
11877
+ # resource path
11878
+ local_var_path = '/transactions/sync'
11879
+
11880
+ # query parameters
11881
+ query_params = opts[:query_params] || {}
11882
+
11883
+ # header parameters
11884
+ header_params = opts[:header_params] || {}
11885
+ # HTTP header 'Accept' (if needed)
11886
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11887
+ # HTTP header 'Content-Type'
11888
+ content_type = @api_client.select_header_content_type(['application/json'])
11889
+ if !content_type.nil?
11890
+ header_params['Content-Type'] = content_type
11891
+ end
11892
+
11893
+ # form parameters
11894
+ form_params = opts[:form_params] || {}
11895
+
11896
+ # http body (model)
11897
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
11898
+
11899
+ # return_type
11900
+ return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
11901
+
11902
+ # auth_names
11903
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11904
+
11905
+ new_options = opts.merge(
11906
+ :operation => :"PlaidApi.transactions_sync",
11907
+ :header_params => header_params,
11908
+ :query_params => query_params,
11909
+ :form_params => form_params,
11910
+ :body => post_body,
11911
+ :auth_names => auth_names,
11912
+ :return_type => return_type
11913
+ )
11914
+
11915
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11916
+ if @api_client.config.debugging
11917
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11918
+ end
11919
+ return data, status_code, headers
11920
+ end
11921
+
11922
+ # Obtain user insights based on transactions sent through /transactions/enrich
11923
+ # The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta.
11924
+ # @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest]
11925
+ # @param [Hash] opts the optional parameters
11926
+ # @return [TransactionsUserInsightsGetResponse]
11927
+ def transactions_user_insights_get(transactions_user_insights_get_request, opts = {})
11928
+ data, _status_code, _headers = transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts)
11929
+ data
11930
+ end
11931
+
11932
+ # Obtain user insights based on transactions sent through /transactions/enrich
11933
+ # The &#x60;/beta/transactions/user_insights/v1/get&#x60; gets user insights for clients who have enriched data with &#x60;/transactions/enrich&#x60;. The product is currently in beta.
11934
+ # @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest]
11323
11935
  # @param [Hash] opts the optional parameters
11324
- # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
11325
- def transactions_sync_with_http_info(transactions_sync_request, opts = {})
11936
+ # @return [Array<(TransactionsUserInsightsGetResponse, Integer, Hash)>] TransactionsUserInsightsGetResponse data, response status code and response headers
11937
+ def transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts = {})
11326
11938
  if @api_client.config.debugging
11327
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
11939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_user_insights_get ...'
11328
11940
  end
11329
- # verify the required parameter 'transactions_sync_request' is set
11330
- if @api_client.config.client_side_validation && transactions_sync_request.nil?
11331
- fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
11941
+ # verify the required parameter 'transactions_user_insights_get_request' is set
11942
+ if @api_client.config.client_side_validation && transactions_user_insights_get_request.nil?
11943
+ fail ArgumentError, "Missing the required parameter 'transactions_user_insights_get_request' when calling PlaidApi.transactions_user_insights_get"
11332
11944
  end
11333
11945
  # resource path
11334
- local_var_path = '/transactions/sync'
11946
+ local_var_path = '/beta/transactions/user_insights/v1/get'
11335
11947
 
11336
11948
  # query parameters
11337
11949
  query_params = opts[:query_params] || {}
@@ -11350,16 +11962,16 @@ module Plaid
11350
11962
  form_params = opts[:form_params] || {}
11351
11963
 
11352
11964
  # http body (model)
11353
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
11965
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_user_insights_get_request)
11354
11966
 
11355
11967
  # return_type
11356
- return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
11968
+ return_type = opts[:debug_return_type] || 'TransactionsUserInsightsGetResponse'
11357
11969
 
11358
11970
  # auth_names
11359
11971
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11360
11972
 
11361
11973
  new_options = opts.merge(
11362
- :operation => :"PlaidApi.transactions_sync",
11974
+ :operation => :"PlaidApi.transactions_user_insights_get",
11363
11975
  :header_params => header_params,
11364
11976
  :query_params => query_params,
11365
11977
  :form_params => form_params,
@@ -11370,13 +11982,13 @@ module Plaid
11370
11982
 
11371
11983
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11372
11984
  if @api_client.config.debugging
11373
- @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11985
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11374
11986
  end
11375
11987
  return data, status_code, headers
11376
11988
  end
11377
11989
 
11378
11990
  # Create a transfer authorization
11379
- # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. The fields `device.ip_address` and `device.user_agent` are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device.
11991
+ # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
11380
11992
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
11381
11993
  # @param [Hash] opts the optional parameters
11382
11994
  # @return [TransferAuthorizationCreateResponse]
@@ -11386,7 +11998,7 @@ module Plaid
11386
11998
  end
11387
11999
 
11388
12000
  # Create a transfer authorization
11389
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. The fields &#x60;device.ip_address&#x60; and &#x60;device.user_agent&#x60; are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device.
12001
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. There are three possible outcomes to calling this endpoint: If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
11390
12002
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
11391
12003
  # @param [Hash] opts the optional parameters
11392
12004
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -11580,7 +12192,7 @@ module Plaid
11580
12192
  end
11581
12193
 
11582
12194
  # Get RTP eligibility information of a transfer
11583
- # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
12195
+ # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligiblity in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
11584
12196
  # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
11585
12197
  # @param [Hash] opts the optional parameters
11586
12198
  # @return [TransferCapabilitiesGetResponse]
@@ -11590,7 +12202,7 @@ module Plaid
11590
12202
  end
11591
12203
 
11592
12204
  # Get RTP eligibility information of a transfer
11593
- # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer.
12205
+ # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligiblity in Sandbox, log in using the username &#x60;user_good&#x60; and password &#x60;pass_good&#x60; and use the first two checking and savings accounts in the \&quot;First Platypus Bank\&quot; institution (ending in 0000 or 1111), which will return &#x60;true&#x60;. Any other account will return &#x60;false&#x60;.
11594
12206
  # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
11595
12207
  # @param [Hash] opts the optional parameters
11596
12208
  # @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
@@ -11783,7 +12395,7 @@ module Plaid
11783
12395
  return data, status_code, headers
11784
12396
  end
11785
12397
 
11786
- # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
12398
+ # Upload transfer diligence document on behalf of the originator
11787
12399
  # Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
11788
12400
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
11789
12401
  # @param [Hash] opts the optional parameters
@@ -11793,7 +12405,7 @@ module Plaid
11793
12405
  data
11794
12406
  end
11795
12407
 
11796
- # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
12408
+ # Upload transfer diligence document on behalf of the originator
11797
12409
  # Third-party sender customers can use &#x60;/transfer/diligence/document/upload&#x60; endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.
11798
12410
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
11799
12411
  # @param [Hash] opts the optional parameters
@@ -11851,8 +12463,8 @@ module Plaid
11851
12463
  return data, status_code, headers
11852
12464
  end
11853
12465
 
11854
- # Submit transfer diligence on behalf of the end customer (i.e. the originator).
11855
- # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
12466
+ # Submit transfer diligence on behalf of the originator
12467
+ # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
11856
12468
  # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
11857
12469
  # @param [Hash] opts the optional parameters
11858
12470
  # @return [TransferDiligenceSubmitResponse]
@@ -11861,8 +12473,8 @@ module Plaid
11861
12473
  data
11862
12474
  end
11863
12475
 
11864
- # Submit transfer diligence on behalf of the end customer (i.e. the originator).
11865
- # Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator.
12476
+ # Submit transfer diligence on behalf of the originator
12477
+ # Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
11866
12478
  # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
11867
12479
  # @param [Hash] opts the optional parameters
11868
12480
  # @return [Array<(TransferDiligenceSubmitResponse, Integer, Hash)>] TransferDiligenceSubmitResponse data, response status code and response headers
@@ -12259,6 +12871,210 @@ module Plaid
12259
12871
  return data, status_code, headers
12260
12872
  end
12261
12873
 
12874
+ # Deposit funds into a Plaid Ledger balance
12875
+ # Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger.
12876
+ # @param transfer_ledger_deposit_request [TransferLedgerDepositRequest]
12877
+ # @param [Hash] opts the optional parameters
12878
+ # @return [TransferLedgerDepositResponse]
12879
+ def transfer_ledger_deposit(transfer_ledger_deposit_request, opts = {})
12880
+ data, _status_code, _headers = transfer_ledger_deposit_with_http_info(transfer_ledger_deposit_request, opts)
12881
+ data
12882
+ end
12883
+
12884
+ # Deposit funds into a Plaid Ledger balance
12885
+ # Use the &#x60;/transfer/ledger/deposit&#x60; endpoint to deposit funds into Plaid Ledger.
12886
+ # @param transfer_ledger_deposit_request [TransferLedgerDepositRequest]
12887
+ # @param [Hash] opts the optional parameters
12888
+ # @return [Array<(TransferLedgerDepositResponse, Integer, Hash)>] TransferLedgerDepositResponse data, response status code and response headers
12889
+ def transfer_ledger_deposit_with_http_info(transfer_ledger_deposit_request, opts = {})
12890
+ if @api_client.config.debugging
12891
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_deposit ...'
12892
+ end
12893
+ # verify the required parameter 'transfer_ledger_deposit_request' is set
12894
+ if @api_client.config.client_side_validation && transfer_ledger_deposit_request.nil?
12895
+ fail ArgumentError, "Missing the required parameter 'transfer_ledger_deposit_request' when calling PlaidApi.transfer_ledger_deposit"
12896
+ end
12897
+ # resource path
12898
+ local_var_path = '/transfer/ledger/deposit'
12899
+
12900
+ # query parameters
12901
+ query_params = opts[:query_params] || {}
12902
+
12903
+ # header parameters
12904
+ header_params = opts[:header_params] || {}
12905
+ # HTTP header 'Accept' (if needed)
12906
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12907
+ # HTTP header 'Content-Type'
12908
+ content_type = @api_client.select_header_content_type(['application/json'])
12909
+ if !content_type.nil?
12910
+ header_params['Content-Type'] = content_type
12911
+ end
12912
+
12913
+ # form parameters
12914
+ form_params = opts[:form_params] || {}
12915
+
12916
+ # http body (model)
12917
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_deposit_request)
12918
+
12919
+ # return_type
12920
+ return_type = opts[:debug_return_type] || 'TransferLedgerDepositResponse'
12921
+
12922
+ # auth_names
12923
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12924
+
12925
+ new_options = opts.merge(
12926
+ :operation => :"PlaidApi.transfer_ledger_deposit",
12927
+ :header_params => header_params,
12928
+ :query_params => query_params,
12929
+ :form_params => form_params,
12930
+ :body => post_body,
12931
+ :auth_names => auth_names,
12932
+ :return_type => return_type
12933
+ )
12934
+
12935
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12936
+ if @api_client.config.debugging
12937
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12938
+ end
12939
+ return data, status_code, headers
12940
+ end
12941
+
12942
+ # Retrieve Plaid Ledger balance
12943
+ # Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.
12944
+ # @param transfer_ledger_get_request [TransferLedgerGetRequest]
12945
+ # @param [Hash] opts the optional parameters
12946
+ # @return [TransferLedgerGetResponse]
12947
+ def transfer_ledger_get(transfer_ledger_get_request, opts = {})
12948
+ data, _status_code, _headers = transfer_ledger_get_with_http_info(transfer_ledger_get_request, opts)
12949
+ data
12950
+ end
12951
+
12952
+ # Retrieve Plaid Ledger balance
12953
+ # Use the &#x60;/transfer/ledger/get&#x60; endpoint to view a balance on the ledger held with Plaid.
12954
+ # @param transfer_ledger_get_request [TransferLedgerGetRequest]
12955
+ # @param [Hash] opts the optional parameters
12956
+ # @return [Array<(TransferLedgerGetResponse, Integer, Hash)>] TransferLedgerGetResponse data, response status code and response headers
12957
+ def transfer_ledger_get_with_http_info(transfer_ledger_get_request, opts = {})
12958
+ if @api_client.config.debugging
12959
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_get ...'
12960
+ end
12961
+ # verify the required parameter 'transfer_ledger_get_request' is set
12962
+ if @api_client.config.client_side_validation && transfer_ledger_get_request.nil?
12963
+ fail ArgumentError, "Missing the required parameter 'transfer_ledger_get_request' when calling PlaidApi.transfer_ledger_get"
12964
+ end
12965
+ # resource path
12966
+ local_var_path = '/transfer/ledger/get'
12967
+
12968
+ # query parameters
12969
+ query_params = opts[:query_params] || {}
12970
+
12971
+ # header parameters
12972
+ header_params = opts[:header_params] || {}
12973
+ # HTTP header 'Accept' (if needed)
12974
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12975
+ # HTTP header 'Content-Type'
12976
+ content_type = @api_client.select_header_content_type(['application/json'])
12977
+ if !content_type.nil?
12978
+ header_params['Content-Type'] = content_type
12979
+ end
12980
+
12981
+ # form parameters
12982
+ form_params = opts[:form_params] || {}
12983
+
12984
+ # http body (model)
12985
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_get_request)
12986
+
12987
+ # return_type
12988
+ return_type = opts[:debug_return_type] || 'TransferLedgerGetResponse'
12989
+
12990
+ # auth_names
12991
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12992
+
12993
+ new_options = opts.merge(
12994
+ :operation => :"PlaidApi.transfer_ledger_get",
12995
+ :header_params => header_params,
12996
+ :query_params => query_params,
12997
+ :form_params => form_params,
12998
+ :body => post_body,
12999
+ :auth_names => auth_names,
13000
+ :return_type => return_type
13001
+ )
13002
+
13003
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13004
+ if @api_client.config.debugging
13005
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13006
+ end
13007
+ return data, status_code, headers
13008
+ end
13009
+
13010
+ # Withdraw funds from a Plaid Ledger balance
13011
+ # Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance.
13012
+ # @param transfer_ledger_withdraw_request [TransferLedgerWithdrawRequest]
13013
+ # @param [Hash] opts the optional parameters
13014
+ # @return [TransferLedgerWithdrawResponse]
13015
+ def transfer_ledger_withdraw(transfer_ledger_withdraw_request, opts = {})
13016
+ data, _status_code, _headers = transfer_ledger_withdraw_with_http_info(transfer_ledger_withdraw_request, opts)
13017
+ data
13018
+ end
13019
+
13020
+ # Withdraw funds from a Plaid Ledger balance
13021
+ # Use the &#x60;/transfer/ledger/withdraw&#x60; endpoint to withdraw funds from a Plaid Ledger balance.
13022
+ # @param transfer_ledger_withdraw_request [TransferLedgerWithdrawRequest]
13023
+ # @param [Hash] opts the optional parameters
13024
+ # @return [Array<(TransferLedgerWithdrawResponse, Integer, Hash)>] TransferLedgerWithdrawResponse data, response status code and response headers
13025
+ def transfer_ledger_withdraw_with_http_info(transfer_ledger_withdraw_request, opts = {})
13026
+ if @api_client.config.debugging
13027
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_withdraw ...'
13028
+ end
13029
+ # verify the required parameter 'transfer_ledger_withdraw_request' is set
13030
+ if @api_client.config.client_side_validation && transfer_ledger_withdraw_request.nil?
13031
+ fail ArgumentError, "Missing the required parameter 'transfer_ledger_withdraw_request' when calling PlaidApi.transfer_ledger_withdraw"
13032
+ end
13033
+ # resource path
13034
+ local_var_path = '/transfer/ledger/withdraw'
13035
+
13036
+ # query parameters
13037
+ query_params = opts[:query_params] || {}
13038
+
13039
+ # header parameters
13040
+ header_params = opts[:header_params] || {}
13041
+ # HTTP header 'Accept' (if needed)
13042
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13043
+ # HTTP header 'Content-Type'
13044
+ content_type = @api_client.select_header_content_type(['application/json'])
13045
+ if !content_type.nil?
13046
+ header_params['Content-Type'] = content_type
13047
+ end
13048
+
13049
+ # form parameters
13050
+ form_params = opts[:form_params] || {}
13051
+
13052
+ # http body (model)
13053
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_withdraw_request)
13054
+
13055
+ # return_type
13056
+ return_type = opts[:debug_return_type] || 'TransferLedgerWithdrawResponse'
13057
+
13058
+ # auth_names
13059
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
13060
+
13061
+ new_options = opts.merge(
13062
+ :operation => :"PlaidApi.transfer_ledger_withdraw",
13063
+ :header_params => header_params,
13064
+ :query_params => query_params,
13065
+ :form_params => form_params,
13066
+ :body => post_body,
13067
+ :auth_names => auth_names,
13068
+ :return_type => return_type
13069
+ )
13070
+
13071
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13072
+ if @api_client.config.debugging
13073
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_withdraw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13074
+ end
13075
+ return data, status_code, headers
13076
+ end
13077
+
12262
13078
  # List transfers
12263
13079
  # Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
12264
13080
  # @param transfer_list_request [TransferListRequest]
@@ -12531,6 +13347,74 @@ module Plaid
12531
13347
  return data, status_code, headers
12532
13348
  end
12533
13349
 
13350
+ # Update the funding account associated with the originator
13351
+ # Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.
13352
+ # @param transfer_originator_funding_account_update_request [TransferOriginatorFundingAccountUpdateRequest]
13353
+ # @param [Hash] opts the optional parameters
13354
+ # @return [TransferOriginatorFundingAccountUpdateResponse]
13355
+ def transfer_originator_funding_account_update(transfer_originator_funding_account_update_request, opts = {})
13356
+ data, _status_code, _headers = transfer_originator_funding_account_update_with_http_info(transfer_originator_funding_account_update_request, opts)
13357
+ data
13358
+ end
13359
+
13360
+ # Update the funding account associated with the originator
13361
+ # Use the &#x60;/transfer/originator/funding_account/update&#x60; endpoint to update the funding account associated with the originator.
13362
+ # @param transfer_originator_funding_account_update_request [TransferOriginatorFundingAccountUpdateRequest]
13363
+ # @param [Hash] opts the optional parameters
13364
+ # @return [Array<(TransferOriginatorFundingAccountUpdateResponse, Integer, Hash)>] TransferOriginatorFundingAccountUpdateResponse data, response status code and response headers
13365
+ def transfer_originator_funding_account_update_with_http_info(transfer_originator_funding_account_update_request, opts = {})
13366
+ if @api_client.config.debugging
13367
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_funding_account_update ...'
13368
+ end
13369
+ # verify the required parameter 'transfer_originator_funding_account_update_request' is set
13370
+ if @api_client.config.client_side_validation && transfer_originator_funding_account_update_request.nil?
13371
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_funding_account_update_request' when calling PlaidApi.transfer_originator_funding_account_update"
13372
+ end
13373
+ # resource path
13374
+ local_var_path = '/transfer/originator/funding_account/update'
13375
+
13376
+ # query parameters
13377
+ query_params = opts[:query_params] || {}
13378
+
13379
+ # header parameters
13380
+ header_params = opts[:header_params] || {}
13381
+ # HTTP header 'Accept' (if needed)
13382
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13383
+ # HTTP header 'Content-Type'
13384
+ content_type = @api_client.select_header_content_type(['application/json'])
13385
+ if !content_type.nil?
13386
+ header_params['Content-Type'] = content_type
13387
+ end
13388
+
13389
+ # form parameters
13390
+ form_params = opts[:form_params] || {}
13391
+
13392
+ # http body (model)
13393
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_funding_account_update_request)
13394
+
13395
+ # return_type
13396
+ return_type = opts[:debug_return_type] || 'TransferOriginatorFundingAccountUpdateResponse'
13397
+
13398
+ # auth_names
13399
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
13400
+
13401
+ new_options = opts.merge(
13402
+ :operation => :"PlaidApi.transfer_originator_funding_account_update",
13403
+ :header_params => header_params,
13404
+ :query_params => query_params,
13405
+ :form_params => form_params,
13406
+ :body => post_body,
13407
+ :auth_names => auth_names,
13408
+ :return_type => return_type
13409
+ )
13410
+
13411
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13412
+ if @api_client.config.debugging
13413
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_funding_account_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13414
+ end
13415
+ return data, status_code, headers
13416
+ end
13417
+
12534
13418
  # Get status of an originator's onboarding
12535
13419
  # The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
12536
13420
  # @param transfer_originator_get_request [TransferOriginatorGetRequest]
@@ -12804,7 +13688,7 @@ module Plaid
12804
13688
  end
12805
13689
 
12806
13690
  # Create a recurring transfer
12807
- # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
13691
+ # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
12808
13692
  # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
12809
13693
  # @param [Hash] opts the optional parameters
12810
13694
  # @return [TransferRecurringCreateResponse]
@@ -12814,7 +13698,7 @@ module Plaid
12814
13698
  end
12815
13699
 
12816
13700
  # Create a recurring transfer
12817
- # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer.
13701
+ # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
12818
13702
  # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
12819
13703
  # @param [Hash] opts the optional parameters
12820
13704
  # @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
@@ -13551,6 +14435,74 @@ module Plaid
13551
14435
  return data, status_code, headers
13552
14436
  end
13553
14437
 
14438
+ # Update user information
14439
+ # This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
14440
+ # @param user_update_request [UserUpdateRequest]
14441
+ # @param [Hash] opts the optional parameters
14442
+ # @return [UserUpdateResponse]
14443
+ def user_update(user_update_request, opts = {})
14444
+ data, _status_code, _headers = user_update_with_http_info(user_update_request, opts)
14445
+ data
14446
+ end
14447
+
14448
+ # Update user information
14449
+ # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. The &#x60;user_token&#x60; should be in the response of &#x60;/user/create&#x60; call If you call the endpoint with a non-exist &#x60;user_token&#x60;, the call will fail with an error message indicating that the user token is not found.
14450
+ # @param user_update_request [UserUpdateRequest]
14451
+ # @param [Hash] opts the optional parameters
14452
+ # @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers
14453
+ def user_update_with_http_info(user_update_request, opts = {})
14454
+ if @api_client.config.debugging
14455
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_update ...'
14456
+ end
14457
+ # verify the required parameter 'user_update_request' is set
14458
+ if @api_client.config.client_side_validation && user_update_request.nil?
14459
+ fail ArgumentError, "Missing the required parameter 'user_update_request' when calling PlaidApi.user_update"
14460
+ end
14461
+ # resource path
14462
+ local_var_path = '/user/update'
14463
+
14464
+ # query parameters
14465
+ query_params = opts[:query_params] || {}
14466
+
14467
+ # header parameters
14468
+ header_params = opts[:header_params] || {}
14469
+ # HTTP header 'Accept' (if needed)
14470
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14471
+ # HTTP header 'Content-Type'
14472
+ content_type = @api_client.select_header_content_type(['application/json'])
14473
+ if !content_type.nil?
14474
+ header_params['Content-Type'] = content_type
14475
+ end
14476
+
14477
+ # form parameters
14478
+ form_params = opts[:form_params] || {}
14479
+
14480
+ # http body (model)
14481
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_update_request)
14482
+
14483
+ # return_type
14484
+ return_type = opts[:debug_return_type] || 'UserUpdateResponse'
14485
+
14486
+ # auth_names
14487
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
14488
+
14489
+ new_options = opts.merge(
14490
+ :operation => :"PlaidApi.user_update",
14491
+ :header_params => header_params,
14492
+ :query_params => query_params,
14493
+ :form_params => form_params,
14494
+ :body => post_body,
14495
+ :auth_names => auth_names,
14496
+ :return_type => return_type
14497
+ )
14498
+
14499
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
14500
+ if @api_client.config.debugging
14501
+ @api_client.config.logger.debug "API called: PlaidApi#user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14502
+ end
14503
+ return data, status_code, headers
14504
+ end
14505
+
13554
14506
  # Create an e-wallet
13555
14507
  # Create an e-wallet. The response is the newly created e-wallet object.
13556
14508
  # @param wallet_create_request [WalletCreateRequest]