plaid 29.0.0 → 31.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1645) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +236 -0
  3. data/Gemfile.lock +7 -5
  4. data/Makefile +1 -1
  5. data/README.md +34 -30
  6. data/lib/plaid/api/plaid_api.rb +1168 -297
  7. data/lib/plaid/api_client.rb +2 -2
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +4 -7
  10. data/lib/plaid/models/account_access.rb +1 -1
  11. data/lib/plaid/models/account_assets.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +2 -2
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_holder_category.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +6 -18
  18. data/lib/plaid/models/account_identity_all_of.rb +5 -17
  19. data/lib/plaid/models/account_identity_document_upload.rb +2 -2
  20. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score.rb +2 -2
  22. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  23. data/lib/plaid/models/account_product_access.rb +1 -1
  24. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  25. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  26. data/lib/plaid/models/account_subtype.rb +29 -33
  27. data/lib/plaid/models/account_type.rb +1 -1
  28. data/lib/plaid/models/account_verification_insights.rb +1 -1
  29. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  30. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  31. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  32. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  33. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  34. data/lib/plaid/models/accounts_balance_get_request_payment_details.rb +1 -1
  35. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +1 -1
  36. data/lib/plaid/models/accounts_get_request.rb +1 -1
  37. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  38. data/lib/plaid/models/accounts_get_response.rb +1 -1
  39. data/lib/plaid/models/ach_class.rb +1 -1
  40. data/lib/plaid/models/action_state.rb +1 -1
  41. data/lib/plaid/models/activity.rb +1 -1
  42. data/lib/plaid/models/activity_type.rb +1 -1
  43. data/lib/plaid/models/address.rb +1 -1
  44. data/lib/plaid/models/address_data.rb +1 -1
  45. data/lib/plaid/models/address_data_not_required.rb +1 -1
  46. data/lib/plaid/models/address_data_nullable.rb +1 -1
  47. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  48. data/lib/plaid/models/address_match_score.rb +1 -1
  49. data/lib/plaid/models/address_nullable.rb +1 -1
  50. data/lib/plaid/models/address_purpose_label.rb +1 -1
  51. data/lib/plaid/models/application.rb +1 -1
  52. data/lib/plaid/models/application_get_request.rb +1 -1
  53. data/lib/plaid/models/application_get_response.rb +1 -1
  54. data/lib/plaid/models/apr.rb +1 -1
  55. data/lib/plaid/models/asset.rb +1 -1
  56. data/lib/plaid/models/asset_detail.rb +1 -1
  57. data/lib/plaid/models/asset_holder.rb +1 -1
  58. data/lib/plaid/models/asset_holder_name.rb +1 -1
  59. data/lib/plaid/models/asset_owner.rb +1 -1
  60. data/lib/plaid/models/asset_owners.rb +1 -1
  61. data/lib/plaid/models/asset_report.rb +1 -1
  62. data/lib/plaid/models/asset_report_account_balance.rb +1 -1
  63. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  64. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  67. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_create_request_options.rb +18 -5
  71. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  75. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  77. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  79. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  80. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  81. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  82. data/lib/plaid/models/asset_report_investments.rb +1 -1
  83. data/lib/plaid/models/asset_report_item.rb +1 -1
  84. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  85. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  86. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  88. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  90. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  91. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  92. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  93. data/lib/plaid/models/asset_report_type.rb +1 -1
  94. data/lib/plaid/models/asset_report_user.rb +1 -1
  95. data/lib/plaid/models/asset_transaction.rb +1 -1
  96. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  97. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  98. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  99. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  100. data/lib/plaid/models/asset_transactions.rb +1 -1
  101. data/lib/plaid/models/asset_type.rb +1 -1
  102. data/lib/plaid/models/assets.rb +1 -1
  103. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  104. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  105. data/lib/plaid/models/auth_default_update_webhook.rb +3 -3
  106. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  107. data/lib/plaid/models/auth_get_request.rb +1 -1
  108. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  109. data/lib/plaid/models/auth_get_response.rb +1 -1
  110. data/lib/plaid/models/auth_metadata.rb +1 -1
  111. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  112. data/lib/plaid/models/auth_update_types.rb +1 -1
  113. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  114. data/lib/plaid/models/balance_plus_attributes.rb +1 -1
  115. data/lib/plaid/models/balance_plus_risk_level.rb +1 -1
  116. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  117. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  118. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  119. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  120. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  121. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  122. data/lib/plaid/models/bank_transfer.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  155. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  156. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  157. data/lib/plaid/models/base_report.rb +1 -1
  158. data/lib/plaid/models/base_report_account.rb +20 -3
  159. data/lib/plaid/models/base_report_account_balances.rb +1 -9
  160. data/lib/plaid/models/base_report_account_insights.rb +45 -11
  161. data/lib/plaid/models/base_report_average_flow_insights.rb +17 -2
  162. data/lib/plaid/models/base_report_average_monthly_balances.rb +16 -1
  163. data/lib/plaid/models/base_report_historical_balance.rb +263 -0
  164. data/lib/plaid/models/base_report_item.rb +1 -1
  165. data/lib/plaid/models/base_report_longest_gap_insights.rb +2 -1
  166. data/lib/plaid/models/base_report_number_flow_insights.rb +17 -2
  167. data/lib/plaid/models/base_report_transaction.rb +2 -3
  168. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  169. data/lib/plaid/models/base_report_warning.rb +1 -1
  170. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  171. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  172. data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
  173. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  174. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  175. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  176. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  178. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  179. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  180. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  181. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  182. data/lib/plaid/models/beacon_bank_account_insights.rb +286 -0
  183. data/lib/plaid/models/beacon_bank_accounts.rb +242 -0
  184. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  185. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  186. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  187. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  188. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  189. data/lib/plaid/models/beacon_report.rb +16 -5
  190. data/lib/plaid/models/beacon_report_create_request.rb +2 -2
  191. data/lib/plaid/models/beacon_report_create_response.rb +16 -5
  192. data/lib/plaid/models/beacon_report_create_type.rb +43 -0
  193. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  194. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  195. data/lib/plaid/models/beacon_report_get_response.rb +16 -5
  196. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  197. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  198. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  199. data/lib/plaid/models/beacon_report_syndication_analysis.rb +21 -5
  200. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  202. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  205. data/lib/plaid/models/beacon_report_syndication_original_report.rb +19 -8
  206. data/lib/plaid/models/beacon_report_type.rb +2 -1
  207. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  208. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +277 -0
  209. data/lib/plaid/models/beacon_user.rb +1 -1
  210. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +261 -0
  211. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +285 -0
  212. data/lib/plaid/models/beacon_user_address.rb +2 -2
  213. data/lib/plaid/models/beacon_user_create_request.rb +2 -1
  214. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  215. data/lib/plaid/models/beacon_user_data.rb +23 -7
  216. data/lib/plaid/models/beacon_user_depository_account.rb +256 -0
  217. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  218. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  219. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  220. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  221. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  222. data/lib/plaid/models/beacon_user_name.rb +1 -1
  223. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  224. data/lib/plaid/models/beacon_user_request_address.rb +2 -2
  225. data/lib/plaid/models/beacon_user_request_address_nullable.rb +2 -2
  226. data/lib/plaid/models/beacon_user_request_data.rb +20 -13
  227. data/lib/plaid/models/beacon_user_request_depository_account.rb +241 -0
  228. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  229. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  230. data/lib/plaid/models/beacon_user_status.rb +1 -1
  231. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  232. data/lib/plaid/models/beacon_user_update_request.rb +3 -6
  233. data/lib/plaid/models/beacon_user_update_request_data.rb +19 -8
  234. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  235. data/lib/plaid/models/cashflow_attributes_version.rb +38 -0
  236. data/lib/plaid/models/categories_get_response.rb +1 -1
  237. data/lib/plaid/models/category.rb +1 -1
  238. data/lib/plaid/models/category_insight_details.rb +1 -1
  239. data/lib/plaid/models/category_insights.rb +1 -1
  240. data/lib/plaid/models/cause.rb +14 -3
  241. data/lib/plaid/models/cause_all_of.rb +1 -1
  242. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  243. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  244. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  245. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  246. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  247. data/lib/plaid/models/connected_application.rb +1 -1
  248. data/lib/plaid/models/consumer_dispute.rb +292 -0
  249. data/lib/plaid/models/consumer_dispute_category.rb +41 -0
  250. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  251. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  252. data/lib/plaid/models/consumer_report_user_identity.rb +3 -3
  253. data/lib/plaid/models/counterparty.rb +1 -1
  254. data/lib/plaid/models/counterparty_insights.rb +1 -1
  255. data/lib/plaid/models/counterparty_type.rb +1 -1
  256. data/lib/plaid/models/country_code.rb +1 -1
  257. data/lib/plaid/models/cra_bank_income.rb +6 -6
  258. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  259. data/lib/plaid/models/cra_bank_income_bonus_type.rb +4 -3
  260. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  261. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  262. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  263. data/lib/plaid/models/cra_bank_income_create_request.rb +2 -2
  264. data/lib/plaid/models/cra_bank_income_create_response.rb +1 -1
  265. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  266. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  267. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  268. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  269. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  270. data/lib/plaid/models/cra_bank_income_item.rb +2 -2
  271. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  272. data/lib/plaid/models/cra_bank_income_summary.rb +2 -2
  273. data/lib/plaid/models/cra_bank_income_transaction.rb +21 -1
  274. data/lib/plaid/models/cra_bank_income_warning.rb +2 -2
  275. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  276. data/lib/plaid/models/{base_report_create_request.rb → cra_base_report_create_request.rb} +5 -5
  277. data/lib/plaid/models/cra_base_report_create_response.rb +226 -0
  278. data/lib/plaid/models/cra_base_report_get_request.rb +246 -0
  279. data/lib/plaid/models/{base_report_get_response.rb → cra_base_report_get_response.rb} +10 -5
  280. data/lib/plaid/models/cra_cashflow_insights_report.rb +261 -0
  281. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +18 -5
  282. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +6 -1
  283. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +254 -0
  284. data/lib/plaid/models/cra_check_report_create_request.rb +15 -3
  285. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  286. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  287. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
  288. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  289. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +246 -0
  290. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +240 -0
  291. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +15 -5
  292. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +1 -1
  293. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
  294. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
  295. data/lib/plaid/models/cra_check_report_product.rb +41 -0
  296. data/lib/plaid/models/cra_check_report_ready_webhook.rb +15 -2
  297. data/lib/plaid/models/cra_income_insights.rb +6 -6
  298. data/lib/plaid/models/cra_loan_application.rb +1 -1
  299. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  300. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  301. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  302. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  303. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  304. data/lib/plaid/models/cra_loan_register.rb +1 -1
  305. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  306. data/lib/plaid/models/cra_loan_status.rb +1 -1
  307. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  308. data/lib/plaid/models/cra_loan_type.rb +1 -1
  309. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  310. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  311. data/lib/plaid/models/cra_loan_update.rb +1 -1
  312. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  313. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  314. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  315. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  316. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  317. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  318. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  319. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +246 -0
  320. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +243 -0
  321. data/lib/plaid/models/cra_monitoring_insights_item.rb +269 -0
  322. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +261 -0
  323. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +241 -0
  324. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +246 -0
  325. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +226 -0
  326. data/lib/plaid/models/cra_network_insights_item.rb +256 -0
  327. data/lib/plaid/models/cra_network_insights_report.rb +273 -0
  328. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  329. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  330. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  331. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  332. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  333. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  334. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  335. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  336. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  337. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  338. data/lib/plaid/models/credit1099.rb +1 -1
  339. data/lib/plaid/models/credit1099_filer.rb +1 -1
  340. data/lib/plaid/models/credit1099_payer.rb +1 -1
  341. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  342. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  343. data/lib/plaid/models/credit_ach_class.rb +1 -1
  344. data/lib/plaid/models/credit_amount_with_currency.rb +6 -1
  345. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  346. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  347. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  348. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  349. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  350. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  351. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  352. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  353. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  354. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  355. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  356. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  357. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  358. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  359. data/lib/plaid/models/credit_bank_income.rb +4 -4
  360. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  361. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  362. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  363. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  364. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  365. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  366. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  367. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  368. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  369. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  370. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  371. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  372. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  373. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  374. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  375. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  376. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  377. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  378. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  379. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  380. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  381. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  382. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  383. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  384. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  385. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  386. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  387. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  388. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  389. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  390. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  391. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  392. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  393. data/lib/plaid/models/credit_card_liability.rb +1 -1
  394. data/lib/plaid/models/credit_category.rb +1 -1
  395. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  396. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  397. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  398. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  399. data/lib/plaid/models/credit_employment_item.rb +1 -1
  400. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  401. data/lib/plaid/models/credit_filter.rb +1 -1
  402. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  403. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  404. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  405. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  406. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  407. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  408. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  409. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  410. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  411. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  412. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  413. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  414. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  415. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  416. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  417. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  418. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  419. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  420. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  421. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  422. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  423. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  424. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  425. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  426. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  427. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  428. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  429. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  430. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  431. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  432. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  433. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  434. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  435. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  436. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  437. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  438. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  439. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  440. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  441. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  442. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  443. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  444. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  445. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  446. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  447. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  448. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  449. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  450. data/lib/plaid/models/credit_session.rb +1 -1
  451. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  452. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  453. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  454. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  455. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  456. data/lib/plaid/models/credit_session_error.rb +1 -1
  457. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  458. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  459. data/lib/plaid/models/credit_session_results.rb +1 -1
  460. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  461. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  462. data/lib/plaid/models/credit_w2.rb +1 -1
  463. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  464. data/lib/plaid/models/dashboard_user.rb +2 -2
  465. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  466. data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
  467. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  468. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  469. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  470. data/lib/plaid/models/date_range.rb +1 -1
  471. data/lib/plaid/models/deductions.rb +1 -1
  472. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  473. data/lib/plaid/models/deductions_total.rb +1 -1
  474. data/lib/plaid/models/default_update_webhook.rb +1 -1
  475. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  476. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  477. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  478. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  479. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  480. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  481. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  482. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  483. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  484. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  485. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  486. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  487. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  488. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  489. data/lib/plaid/models/depository_filter.rb +1 -1
  490. data/lib/plaid/models/detailed_originator.rb +1 -1
  491. data/lib/plaid/models/detected_account.rb +1 -1
  492. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  493. data/lib/plaid/models/doc_type.rb +1 -1
  494. data/lib/plaid/models/document_analysis.rb +1 -1
  495. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  496. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  497. data/lib/plaid/models/document_metadata.rb +1 -1
  498. data/lib/plaid/models/document_name_match_code.rb +1 -1
  499. data/lib/plaid/models/document_risk_signal.rb +1 -1
  500. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  501. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  502. data/lib/plaid/models/document_risk_summary.rb +1 -1
  503. data/lib/plaid/models/document_status.rb +1 -1
  504. data/lib/plaid/models/documentary_verification.rb +1 -1
  505. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  506. data/lib/plaid/models/earnings.rb +1 -1
  507. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  508. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  509. data/lib/plaid/models/earnings_total.rb +1 -1
  510. data/lib/plaid/models/email.rb +1 -1
  511. data/lib/plaid/models/email_address_match_score.rb +1 -1
  512. data/lib/plaid/models/employee.rb +1 -1
  513. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  514. data/lib/plaid/models/employer.rb +1 -1
  515. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  516. data/lib/plaid/models/employer_verification.rb +1 -1
  517. data/lib/plaid/models/employers_search_request.rb +1 -1
  518. data/lib/plaid/models/employers_search_response.rb +1 -1
  519. data/lib/plaid/models/employment_details.rb +1 -1
  520. data/lib/plaid/models/employment_source_type.rb +1 -1
  521. data/lib/plaid/models/employment_verification.rb +1 -1
  522. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  523. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  524. data/lib/plaid/models/employment_verification_status.rb +1 -1
  525. data/lib/plaid/models/enhancements.rb +1 -1
  526. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  527. data/lib/plaid/models/enrichments.rb +1 -1
  528. data/lib/plaid/models/entity_document.rb +2 -2
  529. data/lib/plaid/models/entity_document_type.rb +1 -1
  530. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  531. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  532. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  533. data/lib/plaid/models/entity_screening_hit_emails.rb +2 -2
  534. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  535. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  536. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  537. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  538. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  539. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  540. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  541. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  542. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  543. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  544. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  545. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  546. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  547. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +4 -4
  548. data/lib/plaid/models/entity_watchlist_search_terms.rb +4 -4
  549. data/lib/plaid/models/expiration_date.rb +1 -1
  550. data/lib/plaid/models/extended_recipient_metadata.rb +383 -0
  551. data/lib/plaid/models/{base_report_account_balances_all_of.rb → extended_recipient_metadata_all_of.rb} +41 -30
  552. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  553. data/lib/plaid/models/external_payment_options.rb +1 -1
  554. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  555. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  556. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  557. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  558. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  559. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  560. data/lib/plaid/models/fdx_content_types.rb +1 -1
  561. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  562. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  563. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  564. data/lib/plaid/models/fdx_notification.rb +1 -1
  565. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  566. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  567. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  568. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  569. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  570. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  571. data/lib/plaid/models/fdx_party.rb +1 -1
  572. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  573. data/lib/plaid/models/fdx_party_type.rb +1 -1
  574. data/lib/plaid/models/fdx_recipient_metadata.rb +330 -0
  575. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  576. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  577. data/lib/plaid/models/forecasted_monthly_income.rb +241 -0
  578. data/lib/plaid/models/form1099_type.rb +1 -1
  579. data/lib/plaid/models/{base_report_create_response.rb → forwarded_json_response.rb} +5 -5
  580. data/lib/plaid/models/fraud_amount.rb +1 -1
  581. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  582. data/lib/plaid/models/get_recipient_response.rb +337 -0
  583. data/lib/plaid/models/{identity_document.rb → get_recipients_response.rb} +19 -21
  584. data/lib/plaid/models/health_incident.rb +1 -1
  585. data/lib/plaid/models/hidden_match_summary_code.rb +42 -0
  586. data/lib/plaid/models/historical_balance.rb +1 -1
  587. data/lib/plaid/models/historical_update_webhook.rb +3 -3
  588. data/lib/plaid/models/holding.rb +1 -1
  589. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  590. data/lib/plaid/models/holdings_override.rb +1 -1
  591. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  592. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  593. data/lib/plaid/models/id_number_type.rb +1 -1
  594. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  595. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  596. data/lib/plaid/models/identity_document_upload.rb +1 -1
  597. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  598. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  599. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  600. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  601. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  602. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  603. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  604. data/lib/plaid/models/identity_get_request.rb +1 -1
  605. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  606. data/lib/plaid/models/identity_get_response.rb +1 -1
  607. data/lib/plaid/models/identity_match_request.rb +1 -1
  608. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  609. data/lib/plaid/models/identity_match_response.rb +1 -1
  610. data/lib/plaid/models/identity_match_user.rb +2 -2
  611. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  612. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  613. data/lib/plaid/models/identity_update_types.rb +1 -1
  614. data/lib/plaid/models/identity_verification.rb +1 -1
  615. data/lib/plaid/models/identity_verification_autofill_address.rb +2 -2
  616. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  617. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  618. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  619. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  620. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  621. data/lib/plaid/models/identity_verification_create_request_user.rb +3 -3
  622. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  623. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  624. data/lib/plaid/models/identity_verification_document_name_response.rb +241 -0
  625. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  626. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  627. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  628. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  629. data/lib/plaid/models/identity_verification_request_user.rb +3 -3
  630. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  631. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  632. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  633. data/lib/plaid/models/identity_verification_retry_request.rb +13 -2
  634. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  635. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  636. data/lib/plaid/models/identity_verification_status.rb +1 -1
  637. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  638. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  639. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  640. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  641. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  642. data/lib/plaid/models/identity_verification_user_address.rb +2 -2
  643. data/lib/plaid/models/identity_verification_user_data.rb +3 -3
  644. data/lib/plaid/models/image_quality.rb +1 -1
  645. data/lib/plaid/models/incident_update.rb +1 -1
  646. data/lib/plaid/models/income_breakdown.rb +1 -1
  647. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  648. data/lib/plaid/models/income_override.rb +1 -1
  649. data/lib/plaid/models/income_sources_counts.rb +241 -0
  650. data/lib/plaid/models/income_summary.rb +1 -1
  651. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  652. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  653. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  654. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  655. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  656. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  657. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  658. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  659. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  660. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  661. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  662. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  663. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  664. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  665. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  666. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  667. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  668. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  669. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  670. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  671. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  672. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  673. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  674. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  675. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  676. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  677. data/lib/plaid/models/individual_name.rb +1 -1
  678. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  679. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  680. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  681. data/lib/plaid/models/inflow_model.rb +1 -1
  682. data/lib/plaid/models/initial_update_webhook.rb +3 -3
  683. data/lib/plaid/models/institution.rb +1 -1
  684. data/lib/plaid/models/institution_status.rb +1 -1
  685. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  686. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  687. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  688. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  689. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  690. data/lib/plaid/models/institutions_get_request.rb +1 -1
  691. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  692. data/lib/plaid/models/institutions_get_response.rb +1 -1
  693. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  694. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  695. data/lib/plaid/models/institutions_search_request.rb +1 -1
  696. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  697. data/lib/plaid/models/institutions_search_response.rb +1 -1
  698. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  699. data/lib/plaid/models/investment_filter.rb +1 -1
  700. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  701. data/lib/plaid/models/investment_transaction.rb +1 -1
  702. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  703. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  704. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  705. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  706. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  707. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  708. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  709. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  710. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  711. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  712. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  713. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  714. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  715. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  716. data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
  717. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  718. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  719. data/lib/plaid/models/iso_currency_code.rb +1 -1
  720. data/lib/plaid/models/issue_resolved_webhook.rb +316 -0
  721. data/lib/plaid/models/issuing_country.rb +1 -1
  722. data/lib/plaid/models/item.rb +1 -1
  723. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  724. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  725. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  726. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  727. data/lib/plaid/models/item_add_result_webhook.rb +2 -2
  728. data/lib/plaid/models/item_application_list_request.rb +1 -1
  729. data/lib/plaid/models/item_application_list_response.rb +1 -1
  730. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  731. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  732. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  733. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  734. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  735. data/lib/plaid/models/item_error_webhook.rb +1 -1
  736. data/lib/plaid/models/item_get_request.rb +1 -1
  737. data/lib/plaid/models/item_get_response.rb +1 -1
  738. data/lib/plaid/models/item_import_request.rb +1 -1
  739. data/lib/plaid/models/item_import_request_options.rb +1 -1
  740. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  741. data/lib/plaid/models/item_import_response.rb +1 -1
  742. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  743. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  744. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  745. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  746. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  747. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  748. data/lib/plaid/models/item_remove_request.rb +1 -1
  749. data/lib/plaid/models/item_remove_response.rb +1 -1
  750. data/lib/plaid/models/item_status.rb +1 -1
  751. data/lib/plaid/models/item_status_investments.rb +1 -1
  752. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  753. data/lib/plaid/models/item_status_nullable.rb +1 -1
  754. data/lib/plaid/models/item_status_transactions.rb +1 -1
  755. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  756. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  757. data/lib/plaid/models/jwk_public_key.rb +1 -1
  758. data/lib/plaid/models/jwt_header.rb +1 -1
  759. data/lib/plaid/models/kyc_check_address_summary.rb +51 -5
  760. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +32 -5
  761. data/lib/plaid/models/kyc_check_details.rb +1 -1
  762. data/lib/plaid/models/kyc_check_details_international_address.rb +317 -0
  763. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  764. data/lib/plaid/models/kyc_check_name_summary.rb +23 -5
  765. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  766. data/lib/plaid/models/last_data_access_times.rb +1 -1
  767. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  768. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  769. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  770. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  771. data/lib/plaid/models/liabilities_object.rb +1 -1
  772. data/lib/plaid/models/liability_override.rb +1 -1
  773. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  774. data/lib/plaid/models/link_delivery_account.rb +1 -1
  775. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  776. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  777. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  778. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  779. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  780. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  781. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  782. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  783. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  784. data/lib/plaid/models/link_delivery_options.rb +1 -1
  785. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  786. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  787. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  788. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  789. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  790. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  791. data/lib/plaid/models/link_event.rb +1 -1
  792. data/lib/plaid/models/link_event_metadata.rb +2 -2
  793. data/lib/plaid/models/link_event_name.rb +2 -1
  794. data/lib/plaid/models/link_events_webhook.rb +1 -1
  795. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  796. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  797. data/lib/plaid/models/link_profile_eligibility_check_request.rb +1 -1
  798. data/lib/plaid/models/link_profile_eligibility_check_response.rb +1 -1
  799. data/lib/plaid/models/link_profile_eligibility_check_user.rb +1 -1
  800. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  801. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  802. data/lib/plaid/models/link_session_cra_item_add_result.rb +253 -0
  803. data/lib/plaid/models/link_session_exit.rb +1 -1
  804. data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
  805. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  806. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  807. data/lib/plaid/models/link_session_finished_webhook.rb +2 -2
  808. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  809. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  810. data/lib/plaid/models/link_session_results.rb +14 -2
  811. data/lib/plaid/models/link_session_success.rb +2 -2
  812. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  813. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  814. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  815. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +2 -1
  816. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  817. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  818. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  819. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  820. data/lib/plaid/models/link_token_create_hosted_link.rb +2 -2
  821. data/lib/plaid/models/link_token_create_identity.rb +17 -5
  822. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  823. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  824. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  825. data/lib/plaid/models/link_token_create_request.rb +4 -4
  826. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  827. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  828. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  829. data/lib/plaid/models/link_token_create_request_cra_options.rb +15 -6
  830. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  831. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +254 -0
  832. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +15 -5
  833. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +2 -2
  834. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  835. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  836. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  837. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  838. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  839. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
  840. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  841. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  842. data/lib/plaid/models/link_token_create_request_statements.rb +3 -3
  843. data/lib/plaid/models/link_token_create_request_transfer.rb +12 -2
  844. data/lib/plaid/models/link_token_create_request_update.rb +29 -6
  845. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  846. data/lib/plaid/models/link_token_create_request_user_address.rb +2 -2
  847. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  848. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  849. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  850. data/lib/plaid/models/link_token_create_response.rb +1 -1
  851. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  852. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  853. data/lib/plaid/models/link_token_get_request.rb +1 -1
  854. data/lib/plaid/models/link_token_get_response.rb +1 -1
  855. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  856. data/lib/plaid/models/link_token_investments.rb +1 -1
  857. data/lib/plaid/models/link_token_investments_auth.rb +19 -6
  858. data/lib/plaid/models/link_token_transactions.rb +2 -2
  859. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  860. data/lib/plaid/models/loan.rb +1 -1
  861. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  862. data/lib/plaid/models/loan_filter.rb +1 -1
  863. data/lib/plaid/models/loan_identifier.rb +1 -1
  864. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  865. data/lib/plaid/models/loan_identifiers.rb +1 -1
  866. data/lib/plaid/models/loan_payments_counts.rb +241 -0
  867. data/lib/plaid/models/loan_payments_merchant_counts.rb +241 -0
  868. data/lib/plaid/models/loans.rb +1 -1
  869. data/lib/plaid/models/location.rb +1 -1
  870. data/lib/plaid/models/match_summary.rb +1 -1
  871. data/lib/plaid/models/match_summary_code.rb +1 -1
  872. data/lib/plaid/models/merchant_insights.rb +1 -1
  873. data/lib/plaid/models/meta.rb +1 -1
  874. data/lib/plaid/models/mfa.rb +1 -1
  875. data/lib/plaid/models/monitoring_income_insights.rb +270 -0
  876. data/lib/plaid/models/monitoring_income_source.rb +307 -0
  877. data/lib/plaid/models/monitoring_insights.rb +239 -0
  878. data/lib/plaid/models/monitoring_insights_item_status.rb +258 -0
  879. data/lib/plaid/models/monitoring_insights_webhook.rb +303 -0
  880. data/lib/plaid/models/monitoring_item_status_code.rb +41 -0
  881. data/lib/plaid/models/monitoring_loan_insights.rb +254 -0
  882. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  883. data/lib/plaid/models/mortgage_liability.rb +1 -1
  884. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  885. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  886. data/lib/plaid/models/name_match_score.rb +2 -2
  887. data/lib/plaid/models/net_pay.rb +1 -1
  888. data/lib/plaid/models/network_insights_item.rb +256 -0
  889. data/lib/plaid/models/network_insights_report.rb +273 -0
  890. data/lib/plaid/models/network_insights_report_get_request.rb +248 -0
  891. data/lib/plaid/models/network_insights_report_get_response.rb +240 -0
  892. data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
  893. data/lib/plaid/models/numbers.rb +1 -1
  894. data/lib/plaid/models/numbers_acats.rb +1 -1
  895. data/lib/plaid/models/numbers_ach.rb +2 -2
  896. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  897. data/lib/plaid/models/numbers_aton.rb +1 -1
  898. data/lib/plaid/models/numbers_bacs.rb +1 -1
  899. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  900. data/lib/plaid/models/numbers_eft.rb +1 -1
  901. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  902. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  903. data/lib/plaid/models/numbers_international.rb +1 -1
  904. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  905. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  906. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  907. data/lib/plaid/models/option_contract.rb +1 -1
  908. data/lib/plaid/models/originator.rb +1 -1
  909. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  910. data/lib/plaid/models/other_account_subtype.rb +1 -1
  911. data/lib/plaid/models/other_filter.rb +1 -1
  912. data/lib/plaid/models/override_account_type.rb +1 -1
  913. data/lib/plaid/models/override_accounts.rb +1 -1
  914. data/lib/plaid/models/owner.rb +5 -16
  915. data/lib/plaid/models/owner_override.rb +1 -1
  916. data/lib/plaid/models/ownership_type.rb +1 -1
  917. data/lib/plaid/models/parties.rb +1 -1
  918. data/lib/plaid/models/partner_customer_create_request.rb +2 -2
  919. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  920. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  921. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  922. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  923. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  924. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  925. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  926. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  927. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  928. data/lib/plaid/models/partner_end_customer.rb +1 -1
  929. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  930. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  931. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  932. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  933. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  934. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  935. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  936. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  937. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  938. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  939. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  940. data/lib/plaid/models/partner_end_customer_secrets.rb +3 -3
  941. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  942. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  943. data/lib/plaid/models/partner_end_customer_with_secrets.rb +2 -2
  944. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  945. data/lib/plaid/models/party.rb +1 -1
  946. data/lib/plaid/models/party_individual.rb +1 -1
  947. data/lib/plaid/models/party_role_type.rb +1 -1
  948. data/lib/plaid/models/pay.rb +1 -1
  949. data/lib/plaid/models/pay_frequency.rb +1 -1
  950. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  951. data/lib/plaid/models/pay_period_details.rb +1 -1
  952. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  953. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  954. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  955. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  956. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  957. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  958. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  959. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  960. data/lib/plaid/models/payment_amount.rb +1 -1
  961. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  962. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  963. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  964. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  965. data/lib/plaid/models/payment_channel.rb +1 -1
  966. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  967. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  968. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  969. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  970. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  971. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  972. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  973. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  974. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  975. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  976. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  977. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  978. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  979. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
  980. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  981. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  982. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  983. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  984. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  985. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  986. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  987. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  988. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  989. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  990. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  991. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  992. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  993. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  994. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  995. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  996. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  997. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  998. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  999. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1000. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1001. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1002. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1003. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1004. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1005. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1006. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1007. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1008. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1009. data/lib/plaid/models/payment_meta.rb +1 -1
  1010. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1011. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1012. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1013. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1014. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1015. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1016. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1017. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1018. data/lib/plaid/models/payment_scheme.rb +1 -1
  1019. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1020. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1021. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1022. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1023. data/lib/plaid/models/payroll_item.rb +1 -1
  1024. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1025. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1026. data/lib/plaid/models/paystub.rb +1 -1
  1027. data/lib/plaid/models/paystub_address.rb +1 -1
  1028. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1029. data/lib/plaid/models/paystub_details.rb +1 -1
  1030. data/lib/plaid/models/paystub_employer.rb +1 -1
  1031. data/lib/plaid/models/paystub_override.rb +1 -1
  1032. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1033. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1034. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1035. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1036. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1037. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1038. data/lib/plaid/models/paystub_override_earnings_total.rb +17 -6
  1039. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1040. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1041. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1042. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1043. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1044. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1045. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1046. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1047. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1048. data/lib/plaid/models/pending_disconnect_webhook.rb +306 -0
  1049. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +38 -0
  1050. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1051. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1052. data/lib/plaid/models/phone_number.rb +1 -1
  1053. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1054. data/lib/plaid/models/phone_type.rb +1 -1
  1055. data/lib/plaid/models/physical_document_category.rb +1 -1
  1056. data/lib/plaid/models/physical_document_extracted_data.rb +16 -6
  1057. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1058. data/lib/plaid/models/physical_document_images.rb +1 -1
  1059. data/lib/plaid/models/plaid_check_score.rb +233 -0
  1060. data/lib/plaid/models/plaid_error.rb +14 -3
  1061. data/lib/plaid/models/plaid_error_type.rb +6 -1
  1062. data/lib/plaid/models/platform_ids.rb +1 -1
  1063. data/lib/plaid/models/po_box_status.rb +1 -1
  1064. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1065. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1066. data/lib/plaid/models/prism_cash_score_version.rb +39 -0
  1067. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1068. data/lib/plaid/models/prism_first_detect_version.rb +39 -0
  1069. data/lib/plaid/models/prism_insights.rb +1 -1
  1070. data/lib/plaid/models/prism_insights_version.rb +39 -0
  1071. data/lib/plaid/models/prism_product.rb +1 -1
  1072. data/lib/plaid/models/prism_versions.rb +263 -0
  1073. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1074. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1075. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1076. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1077. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1078. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1079. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1080. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1081. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1082. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1083. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1084. data/lib/plaid/models/processor_historical_update_webhook.rb +3 -3
  1085. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1086. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1087. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1088. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1089. data/lib/plaid/models/processor_initial_update_webhook.rb +3 -3
  1090. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1091. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1092. data/lib/plaid/models/processor_number.rb +1 -1
  1093. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1094. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1095. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1096. data/lib/plaid/models/processor_signal_evaluate_request.rb +16 -5
  1097. data/lib/plaid/models/processor_signal_evaluate_response.rb +12 -2
  1098. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1099. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1100. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1101. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1102. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1103. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1104. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1105. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1106. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1107. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1108. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1109. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1110. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1111. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1112. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1113. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1114. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1115. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1116. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1117. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1118. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1119. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1120. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1121. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1122. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1123. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1124. data/lib/plaid/models/product_access.rb +1 -1
  1125. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1126. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1127. data/lib/plaid/models/product_status.rb +1 -1
  1128. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  1129. data/lib/plaid/models/products.rb +4 -1
  1130. data/lib/plaid/models/profile_get_request.rb +1 -1
  1131. data/lib/plaid/models/profile_get_response.rb +1 -1
  1132. data/lib/plaid/models/profile_identity.rb +1 -1
  1133. data/lib/plaid/models/profile_identity_address.rb +1 -1
  1134. data/lib/plaid/models/profile_identity_name.rb +1 -1
  1135. data/lib/plaid/models/profile_item.rb +1 -1
  1136. data/lib/plaid/models/profile_network_status_get_network_status.rb +39 -0
  1137. data/lib/plaid/models/profile_network_status_get_request.rb +245 -0
  1138. data/lib/plaid/models/profile_network_status_get_response.rb +262 -0
  1139. data/lib/plaid/models/profile_network_status_get_user.rb +226 -0
  1140. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1141. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1142. data/lib/plaid/models/proxy_type.rb +1 -1
  1143. data/lib/plaid/models/pslf_status.rb +2 -2
  1144. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1145. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1146. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1147. data/lib/plaid/models/recurrence.rb +1 -1
  1148. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1149. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1150. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1151. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1152. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1153. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1154. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1155. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1156. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1157. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1158. data/lib/plaid/models/removed_transaction.rb +1 -1
  1159. data/lib/plaid/models/report_type.rb +1 -1
  1160. data/lib/plaid/models/reporting_information.rb +1 -1
  1161. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1162. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1163. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1164. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1165. data/lib/plaid/models/risk_check_details.rb +1 -1
  1166. data/lib/plaid/models/risk_check_device.rb +1 -1
  1167. data/lib/plaid/models/risk_check_email.rb +1 -1
  1168. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1169. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1170. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1171. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1172. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1173. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1174. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1175. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1176. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1177. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1178. data/lib/plaid/models/risk_profile.rb +1 -1
  1179. data/lib/plaid/models/risk_reason.rb +1 -1
  1180. data/lib/plaid/models/risk_signal_document_reference.rb +16 -6
  1181. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1182. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1183. data/lib/plaid/models/risk_signal_file_type.rb +45 -0
  1184. data/lib/plaid/models/role.rb +1 -1
  1185. data/lib/plaid/models/role_detail.rb +1 -1
  1186. data/lib/plaid/models/roles.rb +1 -1
  1187. data/lib/plaid/models/ruleset.rb +1 -1
  1188. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1189. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1190. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1191. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1192. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1193. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1194. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1195. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1196. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1197. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1198. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1199. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  1200. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1201. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1202. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1203. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1204. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1205. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1206. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1207. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1208. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1209. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1210. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1211. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1212. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1213. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1214. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1215. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1216. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1217. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1218. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1219. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1220. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1221. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1222. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +13 -2
  1223. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1224. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1225. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1226. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1227. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1228. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1229. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1230. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1231. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1232. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1233. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1234. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1235. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1236. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1237. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1238. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1239. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1240. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1241. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1242. data/lib/plaid/models/sandbox_user_reset_login_request.rb +259 -0
  1243. data/lib/plaid/models/sandbox_user_reset_login_response.rb +226 -0
  1244. data/lib/plaid/models/scopes.rb +1 -1
  1245. data/lib/plaid/models/scopes_context.rb +1 -1
  1246. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1247. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1248. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1249. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1250. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1251. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1252. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1253. data/lib/plaid/models/security.rb +24 -2
  1254. data/lib/plaid/models/security_override.rb +1 -1
  1255. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1256. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1257. data/lib/plaid/models/selfie_capture.rb +1 -1
  1258. data/lib/plaid/models/selfie_check.rb +1 -1
  1259. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1260. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1261. data/lib/plaid/models/selfie_status.rb +1 -1
  1262. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1263. data/lib/plaid/models/service.rb +1 -1
  1264. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1265. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1266. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1267. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1268. data/lib/plaid/models/services.rb +1 -1
  1269. data/lib/plaid/models/signal_address_data.rb +1 -1
  1270. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1271. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1272. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1273. data/lib/plaid/models/signal_device.rb +1 -1
  1274. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1275. data/lib/plaid/models/signal_evaluate_request.rb +1 -53
  1276. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1277. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1278. data/lib/plaid/models/signal_person_name.rb +1 -1
  1279. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1280. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1281. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1282. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1283. data/lib/plaid/models/signal_scores.rb +1 -1
  1284. data/lib/plaid/models/signal_user.rb +1 -1
  1285. data/lib/plaid/models/signal_warning.rb +1 -1
  1286. data/lib/plaid/models/simulated_transfer_sweep.rb +13 -2
  1287. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1288. data/lib/plaid/models/source.rb +1 -1
  1289. data/lib/plaid/models/standalone_account_type.rb +5 -5
  1290. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1291. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1292. data/lib/plaid/models/statements_account.rb +1 -1
  1293. data/lib/plaid/models/statements_download_request.rb +1 -1
  1294. data/lib/plaid/models/statements_list_request.rb +1 -1
  1295. data/lib/plaid/models/statements_list_response.rb +1 -1
  1296. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1297. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1298. data/lib/plaid/models/statements_refresh_request.rb +3 -3
  1299. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1300. data/lib/plaid/models/statements_statement.rb +1 -1
  1301. data/lib/plaid/models/status.rb +1 -1
  1302. data/lib/plaid/models/statuses.rb +1 -1
  1303. data/lib/plaid/models/strategy.rb +1 -1
  1304. data/lib/plaid/models/student_loan.rb +2 -2
  1305. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1306. data/lib/plaid/models/student_loan_status.rb +1 -1
  1307. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1308. data/lib/plaid/models/sweep_status.rb +1 -1
  1309. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1310. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1311. data/lib/plaid/models/taxform.rb +1 -1
  1312. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1313. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1314. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1315. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1316. data/lib/plaid/models/total.rb +1 -1
  1317. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1318. data/lib/plaid/models/total_monthly_income_insights.rb +241 -0
  1319. data/lib/plaid/models/transaction.rb +4 -4
  1320. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1321. data/lib/plaid/models/transaction_base.rb +4 -4
  1322. data/lib/plaid/models/transaction_code.rb +1 -1
  1323. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1324. data/lib/plaid/models/transaction_data.rb +1 -1
  1325. data/lib/plaid/models/transaction_override.rb +1 -1
  1326. data/lib/plaid/models/transaction_stream.rb +1 -1
  1327. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1328. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1329. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1330. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1331. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1332. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1333. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1334. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1335. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1336. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1337. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1338. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1339. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1340. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1341. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1342. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1343. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1344. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1345. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1346. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1347. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1348. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1349. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1350. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1351. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1352. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1353. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1354. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1355. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1356. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1357. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1358. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1359. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1360. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1361. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1362. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1363. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  1364. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1365. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1366. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1367. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1368. data/lib/plaid/models/transfer.rb +13 -2
  1369. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1370. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1371. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1372. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1373. data/lib/plaid/models/transfer_authorization_create_request.rb +14 -3
  1374. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1375. data/lib/plaid/models/transfer_authorization_decision.rb +2 -1
  1376. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1377. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1378. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1379. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1380. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1381. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1382. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1383. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +13 -2
  1384. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1385. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1386. data/lib/plaid/models/transfer_balance.rb +1 -1
  1387. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1388. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1389. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1390. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1391. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1392. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1393. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1394. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1395. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1396. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1397. data/lib/plaid/models/transfer_create_request.rb +1 -1
  1398. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1399. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1400. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1401. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1402. data/lib/plaid/models/transfer_device.rb +1 -1
  1403. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1404. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1405. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1406. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1407. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1408. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1409. data/lib/plaid/models/transfer_event.rb +13 -2
  1410. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1411. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1412. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1413. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1414. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1415. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1416. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1417. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1418. data/lib/plaid/models/transfer_failure.rb +1 -1
  1419. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1420. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1421. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1422. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1423. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1424. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1425. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1426. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1427. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1428. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1429. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1430. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1431. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1432. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1433. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1434. data/lib/plaid/models/transfer_ledger_deposit_request.rb +13 -2
  1435. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1436. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1437. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1438. data/lib/plaid/models/transfer_ledger_get_request.rb +13 -2
  1439. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1440. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1441. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +13 -2
  1442. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1443. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1444. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1445. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +251 -0
  1446. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1447. data/lib/plaid/models/transfer_metrics_get_response.rb +16 -6
  1448. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1449. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1450. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1451. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1452. data/lib/plaid/models/transfer_network.rb +1 -1
  1453. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1454. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1455. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1456. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1457. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1458. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1459. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1460. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1461. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1462. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1463. data/lib/plaid/models/transfer_platform_originator_create_request.rb +275 -0
  1464. data/lib/plaid/models/transfer_platform_originator_create_response.rb +226 -0
  1465. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +256 -0
  1466. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1467. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1468. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1469. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1470. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1471. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1472. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1473. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1474. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1475. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1476. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1477. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1478. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1479. data/lib/plaid/models/transfer_refund.rb +13 -2
  1480. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1481. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1482. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1483. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1484. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1485. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1486. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1487. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1488. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1489. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1490. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1491. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1492. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1493. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1494. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1495. data/lib/plaid/models/transfer_status.rb +1 -1
  1496. data/lib/plaid/models/transfer_sweep.rb +13 -2
  1497. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1498. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1499. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1500. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1501. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1502. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1503. data/lib/plaid/models/transfer_type.rb +1 -1
  1504. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1505. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1506. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1507. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1508. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1509. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1510. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +4 -4
  1511. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +3 -3
  1512. data/lib/plaid/models/user_account_identity.rb +2 -2
  1513. data/lib/plaid/models/user_account_identity_address.rb +2 -2
  1514. data/lib/plaid/models/user_account_identity_name.rb +2 -2
  1515. data/lib/plaid/models/user_account_item.rb +2 -2
  1516. data/lib/plaid/models/user_account_revoked_webhook.rb +2 -2
  1517. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1518. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1519. data/lib/plaid/models/user_address.rb +2 -2
  1520. data/lib/plaid/models/user_create_request.rb +1 -1
  1521. data/lib/plaid/models/user_create_response.rb +1 -1
  1522. data/lib/plaid/models/user_custom_password.rb +1 -1
  1523. data/lib/plaid/models/user_data_overview.rb +1 -1
  1524. data/lib/plaid/models/user_id_number.rb +1 -1
  1525. data/lib/plaid/models/{base_report_get_request.rb → user_items_get_request.rb} +5 -5
  1526. data/lib/plaid/models/user_items_get_response.rb +242 -0
  1527. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1528. data/lib/plaid/models/user_remove_request.rb +246 -0
  1529. data/lib/plaid/models/user_remove_response.rb +226 -0
  1530. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1531. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1532. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1533. data/lib/plaid/models/user_update_request.rb +1 -1
  1534. data/lib/plaid/models/user_update_response.rb +1 -1
  1535. data/lib/plaid/models/validation_source.rb +1 -1
  1536. data/lib/plaid/models/validation_sources.rb +1 -1
  1537. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1538. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1539. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1540. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1541. data/lib/plaid/models/verification_status.rb +1 -1
  1542. data/lib/plaid/models/w2.rb +1 -1
  1543. data/lib/plaid/models/w2_box12.rb +1 -1
  1544. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1545. data/lib/plaid/models/w2_override.rb +2 -2
  1546. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1547. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1548. data/lib/plaid/models/wallet.rb +1 -1
  1549. data/lib/plaid/models/wallet_balance.rb +1 -1
  1550. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1551. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1552. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1553. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1554. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1555. data/lib/plaid/models/wallet_list_request.rb +6 -6
  1556. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1557. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1558. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1559. data/lib/plaid/models/wallet_status.rb +1 -1
  1560. data/lib/plaid/models/wallet_transaction.rb +18 -6
  1561. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1562. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1563. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1564. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1565. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1566. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1567. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1568. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1569. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1570. data/lib/plaid/models/wallet_transaction_get_response.rb +14 -2
  1571. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1572. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1573. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1574. data/lib/plaid/models/wallet_transaction_relation.rb +265 -0
  1575. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1576. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1577. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1578. data/lib/plaid/models/warning.rb +1 -1
  1579. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1580. data/lib/plaid/models/watchlist_screening_document.rb +2 -2
  1581. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1582. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1583. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1584. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1585. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1586. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1587. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1588. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1589. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1590. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1591. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1592. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1593. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1594. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1595. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1596. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1597. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1598. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1599. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1600. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1601. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1602. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1603. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1604. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1605. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1606. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1607. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1608. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1609. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1610. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1611. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1612. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1613. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1614. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1615. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1616. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1617. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1618. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1619. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1620. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1621. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1622. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1623. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1624. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1625. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1626. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1627. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1628. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +3 -3
  1629. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1630. data/lib/plaid/models/watchlist_screening_search_terms.rb +3 -3
  1631. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1632. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1633. data/lib/plaid/models/webhook_environment_values.rb +1 -2
  1634. data/lib/plaid/models/webhook_type.rb +1 -1
  1635. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1636. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1637. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1638. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1639. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1640. data/lib/plaid/version.rb +2 -2
  1641. data/lib/plaid.rb +82 -7
  1642. data/plaid.gemspec +1 -1
  1643. data/templates/ruby/configuration.mustache +3 -2
  1644. data/test/test_configuration.rb +7 -6
  1645. metadata +83 -8
@@ -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.525.1
6
+ The version of the OpenAPI document: 2020-09-14_1.556.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -836,7 +836,7 @@ module Plaid
836
836
  end
837
837
 
838
838
  # Retrieve auth data
839
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
839
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
840
840
  # @param auth_get_request [AuthGetRequest]
841
841
  # @param [Hash] opts the optional parameters
842
842
  # @return [AuthGetResponse]
@@ -846,7 +846,7 @@ module Plaid
846
846
  end
847
847
 
848
848
  # Retrieve auth data
849
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
849
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
850
850
  # @param auth_get_request [AuthGetRequest]
851
851
  # @param [Hash] opts the optional parameters
852
852
  # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
@@ -1583,142 +1583,6 @@ module Plaid
1583
1583
  return data, status_code, headers
1584
1584
  end
1585
1585
 
1586
- # Create a Base Report
1587
- # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
1588
- # @param base_report_create_request [BaseReportCreateRequest]
1589
- # @param [Hash] opts the optional parameters
1590
- # @return [BaseReportCreateResponse]
1591
- def base_report_create(base_report_create_request, opts = {})
1592
- data, _status_code, _headers = base_report_create_with_http_info(base_report_create_request, opts)
1593
- data
1594
- end
1595
-
1596
- # Create a Base Report
1597
- # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
1598
- # @param base_report_create_request [BaseReportCreateRequest]
1599
- # @param [Hash] opts the optional parameters
1600
- # @return [Array<(BaseReportCreateResponse, Integer, Hash)>] BaseReportCreateResponse data, response status code and response headers
1601
- def base_report_create_with_http_info(base_report_create_request, opts = {})
1602
- if @api_client.config.debugging
1603
- @api_client.config.logger.debug 'Calling API: PlaidApi.base_report_create ...'
1604
- end
1605
- # verify the required parameter 'base_report_create_request' is set
1606
- if @api_client.config.client_side_validation && base_report_create_request.nil?
1607
- fail ArgumentError, "Missing the required parameter 'base_report_create_request' when calling PlaidApi.base_report_create"
1608
- end
1609
- # resource path
1610
- local_var_path = '/cra/base_report/create'
1611
-
1612
- # query parameters
1613
- query_params = opts[:query_params] || {}
1614
-
1615
- # header parameters
1616
- header_params = opts[:header_params] || {}
1617
- # HTTP header 'Accept' (if needed)
1618
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1619
- # HTTP header 'Content-Type'
1620
- content_type = @api_client.select_header_content_type(['application/json'])
1621
- if !content_type.nil?
1622
- header_params['Content-Type'] = content_type
1623
- end
1624
-
1625
- # form parameters
1626
- form_params = opts[:form_params] || {}
1627
-
1628
- # http body (model)
1629
- post_body = opts[:debug_body] || @api_client.object_to_http_body(base_report_create_request)
1630
-
1631
- # return_type
1632
- return_type = opts[:debug_return_type] || 'BaseReportCreateResponse'
1633
-
1634
- # auth_names
1635
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1636
-
1637
- new_options = opts.merge(
1638
- :operation => :"PlaidApi.base_report_create",
1639
- :header_params => header_params,
1640
- :query_params => query_params,
1641
- :form_params => form_params,
1642
- :body => post_body,
1643
- :auth_names => auth_names,
1644
- :return_type => return_type
1645
- )
1646
-
1647
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1648
- if @api_client.config.debugging
1649
- @api_client.config.logger.debug "API called: PlaidApi#base_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1650
- end
1651
- return data, status_code, headers
1652
- end
1653
-
1654
- # Retrieve a Base Report
1655
- # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`.
1656
- # @param base_report_get_request [BaseReportGetRequest]
1657
- # @param [Hash] opts the optional parameters
1658
- # @return [BaseReportGetResponse]
1659
- def base_report_get(base_report_get_request, opts = {})
1660
- data, _status_code, _headers = base_report_get_with_http_info(base_report_get_request, opts)
1661
- data
1662
- end
1663
-
1664
- # Retrieve a Base Report
1665
- # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the &#x60;user_token&#x60; created in &#x60;/link/token/create&#x60;.
1666
- # @param base_report_get_request [BaseReportGetRequest]
1667
- # @param [Hash] opts the optional parameters
1668
- # @return [Array<(BaseReportGetResponse, Integer, Hash)>] BaseReportGetResponse data, response status code and response headers
1669
- def base_report_get_with_http_info(base_report_get_request, opts = {})
1670
- if @api_client.config.debugging
1671
- @api_client.config.logger.debug 'Calling API: PlaidApi.base_report_get ...'
1672
- end
1673
- # verify the required parameter 'base_report_get_request' is set
1674
- if @api_client.config.client_side_validation && base_report_get_request.nil?
1675
- fail ArgumentError, "Missing the required parameter 'base_report_get_request' when calling PlaidApi.base_report_get"
1676
- end
1677
- # resource path
1678
- local_var_path = '/cra/base_report/get'
1679
-
1680
- # query parameters
1681
- query_params = opts[:query_params] || {}
1682
-
1683
- # header parameters
1684
- header_params = opts[:header_params] || {}
1685
- # HTTP header 'Accept' (if needed)
1686
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1687
- # HTTP header 'Content-Type'
1688
- content_type = @api_client.select_header_content_type(['application/json'])
1689
- if !content_type.nil?
1690
- header_params['Content-Type'] = content_type
1691
- end
1692
-
1693
- # form parameters
1694
- form_params = opts[:form_params] || {}
1695
-
1696
- # http body (model)
1697
- post_body = opts[:debug_body] || @api_client.object_to_http_body(base_report_get_request)
1698
-
1699
- # return_type
1700
- return_type = opts[:debug_return_type] || 'BaseReportGetResponse'
1701
-
1702
- # auth_names
1703
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1704
-
1705
- new_options = opts.merge(
1706
- :operation => :"PlaidApi.base_report_get",
1707
- :header_params => header_params,
1708
- :query_params => query_params,
1709
- :form_params => form_params,
1710
- :body => post_body,
1711
- :auth_names => auth_names,
1712
- :return_type => return_type
1713
- )
1714
-
1715
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1716
- if @api_client.config.debugging
1717
- @api_client.config.logger.debug "API called: PlaidApi#base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1718
- end
1719
- return data, status_code, headers
1720
- end
1721
-
1722
1586
  # Evaluate risk of a bank account
1723
1587
  # Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.
1724
1588
  # @param beacon_account_risk_evaluate_request [BeaconAccountRiskEvaluateRequest]
@@ -2195,6 +2059,74 @@ module Plaid
2195
2059
  return data, status_code, headers
2196
2060
  end
2197
2061
 
2062
+ # Get Account Insights for a Beacon User
2063
+ # Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
2064
+ # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2065
+ # @param [Hash] opts the optional parameters
2066
+ # @return [BeaconUserAccountInsightsGetResponse]
2067
+ def beacon_user_account_insights_get(beacon_user_account_insights_get_request, opts = {})
2068
+ data, _status_code, _headers = beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts)
2069
+ data
2070
+ end
2071
+
2072
+ # Get Account Insights for a Beacon User
2073
+ # Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
2074
+ # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2075
+ # @param [Hash] opts the optional parameters
2076
+ # @return [Array<(BeaconUserAccountInsightsGetResponse, Integer, Hash)>] BeaconUserAccountInsightsGetResponse data, response status code and response headers
2077
+ def beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts = {})
2078
+ if @api_client.config.debugging
2079
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_account_insights_get ...'
2080
+ end
2081
+ # verify the required parameter 'beacon_user_account_insights_get_request' is set
2082
+ if @api_client.config.client_side_validation && beacon_user_account_insights_get_request.nil?
2083
+ fail ArgumentError, "Missing the required parameter 'beacon_user_account_insights_get_request' when calling PlaidApi.beacon_user_account_insights_get"
2084
+ end
2085
+ # resource path
2086
+ local_var_path = '/beacon/user/account_insights/get'
2087
+
2088
+ # query parameters
2089
+ query_params = opts[:query_params] || {}
2090
+
2091
+ # header parameters
2092
+ header_params = opts[:header_params] || {}
2093
+ # HTTP header 'Accept' (if needed)
2094
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2095
+ # HTTP header 'Content-Type'
2096
+ content_type = @api_client.select_header_content_type(['application/json'])
2097
+ if !content_type.nil?
2098
+ header_params['Content-Type'] = content_type
2099
+ end
2100
+
2101
+ # form parameters
2102
+ form_params = opts[:form_params] || {}
2103
+
2104
+ # http body (model)
2105
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_account_insights_get_request)
2106
+
2107
+ # return_type
2108
+ return_type = opts[:debug_return_type] || 'BeaconUserAccountInsightsGetResponse'
2109
+
2110
+ # auth_names
2111
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2112
+
2113
+ new_options = opts.merge(
2114
+ :operation => :"PlaidApi.beacon_user_account_insights_get",
2115
+ :header_params => header_params,
2116
+ :query_params => query_params,
2117
+ :form_params => form_params,
2118
+ :body => post_body,
2119
+ :auth_names => auth_names,
2120
+ :return_type => return_type
2121
+ )
2122
+
2123
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2124
+ if @api_client.config.debugging
2125
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_user_account_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2126
+ end
2127
+ return data, status_code, headers
2128
+ end
2129
+
2198
2130
  # Create a Beacon User
2199
2131
  # 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.
2200
2132
  # @param beacon_user_create_request [BeaconUserCreateRequest]
@@ -2468,7 +2400,7 @@ module Plaid
2468
2400
  end
2469
2401
 
2470
2402
  # Update the identity data of a Beacon User
2471
- # Update the identity data for a Beacon User in your Beacon Program. Similar to `/beacon/user/create`, several checks are performed immediately when you submit a change to `/beacon/user/update`: - The user's updated PII 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 updated 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. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
2403
+ # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`: - The user's updated PII 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 updated 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. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
2472
2404
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2473
2405
  # @param [Hash] opts the optional parameters
2474
2406
  # @return [BeaconUserUpdateResponse]
@@ -2478,7 +2410,7 @@ module Plaid
2478
2410
  end
2479
2411
 
2480
2412
  # Update the identity data of a Beacon User
2481
- # Update the identity data for a Beacon User in your Beacon Program. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit a change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;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 &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
2413
+ # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit an identity data change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;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 &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
2482
2414
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2483
2415
  # @param [Hash] opts the optional parameters
2484
2416
  # @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
@@ -2807,6 +2739,142 @@ module Plaid
2807
2739
  return data, status_code, headers
2808
2740
  end
2809
2741
 
2742
+ # Create a Base Report
2743
+ # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
2744
+ # @param cra_base_report_create_request [CraBaseReportCreateRequest]
2745
+ # @param [Hash] opts the optional parameters
2746
+ # @return [CraBaseReportCreateResponse]
2747
+ def cra_base_report_create(cra_base_report_create_request, opts = {})
2748
+ data, _status_code, _headers = cra_base_report_create_with_http_info(cra_base_report_create_request, opts)
2749
+ data
2750
+ end
2751
+
2752
+ # Create a Base Report
2753
+ # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
2754
+ # @param cra_base_report_create_request [CraBaseReportCreateRequest]
2755
+ # @param [Hash] opts the optional parameters
2756
+ # @return [Array<(CraBaseReportCreateResponse, Integer, Hash)>] CraBaseReportCreateResponse data, response status code and response headers
2757
+ def cra_base_report_create_with_http_info(cra_base_report_create_request, opts = {})
2758
+ if @api_client.config.debugging
2759
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_create ...'
2760
+ end
2761
+ # verify the required parameter 'cra_base_report_create_request' is set
2762
+ if @api_client.config.client_side_validation && cra_base_report_create_request.nil?
2763
+ fail ArgumentError, "Missing the required parameter 'cra_base_report_create_request' when calling PlaidApi.cra_base_report_create"
2764
+ end
2765
+ # resource path
2766
+ local_var_path = '/cra/base_report/create'
2767
+
2768
+ # query parameters
2769
+ query_params = opts[:query_params] || {}
2770
+
2771
+ # header parameters
2772
+ header_params = opts[:header_params] || {}
2773
+ # HTTP header 'Accept' (if needed)
2774
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2775
+ # HTTP header 'Content-Type'
2776
+ content_type = @api_client.select_header_content_type(['application/json'])
2777
+ if !content_type.nil?
2778
+ header_params['Content-Type'] = content_type
2779
+ end
2780
+
2781
+ # form parameters
2782
+ form_params = opts[:form_params] || {}
2783
+
2784
+ # http body (model)
2785
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_create_request)
2786
+
2787
+ # return_type
2788
+ return_type = opts[:debug_return_type] || 'CraBaseReportCreateResponse'
2789
+
2790
+ # auth_names
2791
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2792
+
2793
+ new_options = opts.merge(
2794
+ :operation => :"PlaidApi.cra_base_report_create",
2795
+ :header_params => header_params,
2796
+ :query_params => query_params,
2797
+ :form_params => form_params,
2798
+ :body => post_body,
2799
+ :auth_names => auth_names,
2800
+ :return_type => return_type
2801
+ )
2802
+
2803
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2804
+ if @api_client.config.debugging
2805
+ @api_client.config.logger.debug "API called: PlaidApi#cra_base_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2806
+ end
2807
+ return data, status_code, headers
2808
+ end
2809
+
2810
+ # Retrieve a Base Report
2811
+ # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
2812
+ # @param cra_base_report_get_request [CraBaseReportGetRequest]
2813
+ # @param [Hash] opts the optional parameters
2814
+ # @return [CraBaseReportGetResponse]
2815
+ def cra_base_report_get(cra_base_report_get_request, opts = {})
2816
+ data, _status_code, _headers = cra_base_report_get_with_http_info(cra_base_report_get_request, opts)
2817
+ data
2818
+ end
2819
+
2820
+ # Retrieve a Base Report
2821
+ # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the &#x60;user_token&#x60; created in &#x60;/user/create&#x60;.
2822
+ # @param cra_base_report_get_request [CraBaseReportGetRequest]
2823
+ # @param [Hash] opts the optional parameters
2824
+ # @return [Array<(CraBaseReportGetResponse, Integer, Hash)>] CraBaseReportGetResponse data, response status code and response headers
2825
+ def cra_base_report_get_with_http_info(cra_base_report_get_request, opts = {})
2826
+ if @api_client.config.debugging
2827
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_get ...'
2828
+ end
2829
+ # verify the required parameter 'cra_base_report_get_request' is set
2830
+ if @api_client.config.client_side_validation && cra_base_report_get_request.nil?
2831
+ fail ArgumentError, "Missing the required parameter 'cra_base_report_get_request' when calling PlaidApi.cra_base_report_get"
2832
+ end
2833
+ # resource path
2834
+ local_var_path = '/cra/base_report/get'
2835
+
2836
+ # query parameters
2837
+ query_params = opts[:query_params] || {}
2838
+
2839
+ # header parameters
2840
+ header_params = opts[:header_params] || {}
2841
+ # HTTP header 'Accept' (if needed)
2842
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2843
+ # HTTP header 'Content-Type'
2844
+ content_type = @api_client.select_header_content_type(['application/json'])
2845
+ if !content_type.nil?
2846
+ header_params['Content-Type'] = content_type
2847
+ end
2848
+
2849
+ # form parameters
2850
+ form_params = opts[:form_params] || {}
2851
+
2852
+ # http body (model)
2853
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_get_request)
2854
+
2855
+ # return_type
2856
+ return_type = opts[:debug_return_type] || 'CraBaseReportGetResponse'
2857
+
2858
+ # auth_names
2859
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2860
+
2861
+ new_options = opts.merge(
2862
+ :operation => :"PlaidApi.cra_base_report_get",
2863
+ :header_params => header_params,
2864
+ :query_params => query_params,
2865
+ :form_params => form_params,
2866
+ :body => post_body,
2867
+ :auth_names => auth_names,
2868
+ :return_type => return_type
2869
+ )
2870
+
2871
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2872
+ if @api_client.config.debugging
2873
+ @api_client.config.logger.debug "API called: PlaidApi#cra_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2874
+ end
2875
+ return data, status_code, headers
2876
+ end
2877
+
2810
2878
  # Retrieve a Base Report
2811
2879
  # This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
2812
2880
  # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
@@ -3011,8 +3079,76 @@ module Plaid
3011
3079
  return data, status_code, headers
3012
3080
  end
3013
3081
 
3082
+ # Retrieve network attributes for the user
3083
+ # This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_attributes` product or have generated a report using `/cra/check_report/create`, we will generate the attributes when you call this endpoint.
3084
+ # @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
3085
+ # @param [Hash] opts the optional parameters
3086
+ # @return [CraCheckReportNetworkInsightsGetResponse]
3087
+ def cra_check_report_network_insights_get(cra_check_report_network_insights_get_request, opts = {})
3088
+ data, _status_code, _headers = cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts)
3089
+ data
3090
+ end
3091
+
3092
+ # Retrieve network attributes for the user
3093
+ # This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you&#39;ve received the &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;cra_network_attributes&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will generate the attributes when you call this endpoint.
3094
+ # @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
3095
+ # @param [Hash] opts the optional parameters
3096
+ # @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
3097
+ def cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts = {})
3098
+ if @api_client.config.debugging
3099
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_insights_get ...'
3100
+ end
3101
+ # verify the required parameter 'cra_check_report_network_insights_get_request' is set
3102
+ if @api_client.config.client_side_validation && cra_check_report_network_insights_get_request.nil?
3103
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_network_insights_get_request' when calling PlaidApi.cra_check_report_network_insights_get"
3104
+ end
3105
+ # resource path
3106
+ local_var_path = '/cra/check_report/network_insights/get'
3107
+
3108
+ # query parameters
3109
+ query_params = opts[:query_params] || {}
3110
+
3111
+ # header parameters
3112
+ header_params = opts[:header_params] || {}
3113
+ # HTTP header 'Accept' (if needed)
3114
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3115
+ # HTTP header 'Content-Type'
3116
+ content_type = @api_client.select_header_content_type(['application/json'])
3117
+ if !content_type.nil?
3118
+ header_params['Content-Type'] = content_type
3119
+ end
3120
+
3121
+ # form parameters
3122
+ form_params = opts[:form_params] || {}
3123
+
3124
+ # http body (model)
3125
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_insights_get_request)
3126
+
3127
+ # return_type
3128
+ return_type = opts[:debug_return_type] || 'CraCheckReportNetworkInsightsGetResponse'
3129
+
3130
+ # auth_names
3131
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3132
+
3133
+ new_options = opts.merge(
3134
+ :operation => :"PlaidApi.cra_check_report_network_insights_get",
3135
+ :header_params => header_params,
3136
+ :query_params => query_params,
3137
+ :form_params => form_params,
3138
+ :body => post_body,
3139
+ :auth_names => auth_names,
3140
+ :return_type => return_type
3141
+ )
3142
+
3143
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3144
+ if @api_client.config.debugging
3145
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3146
+ end
3147
+ return data, status_code, headers
3148
+ end
3149
+
3014
3150
  # Retrieve cash flow insights from partners
3015
- # This endpoint allows you to retrieve the Partner Insights product for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
3151
+ # This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
3016
3152
  # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
3017
3153
  # @param [Hash] opts the optional parameters
3018
3154
  # @return [CraCheckReportPartnerInsightsGetResponse]
@@ -3022,7 +3158,7 @@ module Plaid
3022
3158
  end
3023
3159
 
3024
3160
  # Retrieve cash flow insights from partners
3025
- # This endpoint allows you to retrieve the Partner Insights product for your user. You should call this endpoint after you&#39;ve received the &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;credit_partner_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
3161
+ # This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you&#39;ve received the &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;credit_partner_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
3026
3162
  # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
3027
3163
  # @param [Hash] opts the optional parameters
3028
3164
  # @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
@@ -3079,8 +3215,8 @@ module Plaid
3079
3215
  return data, status_code, headers
3080
3216
  end
3081
3217
 
3082
- # Retrieve the most recent Base Report in PDF format. You can also include other reports in the same PDF if you specify `add_ons`.
3083
- # `/cra/check_report/pdf/get` retrieve the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format
3218
+ # Retrieve Consumer Reports as a PDF
3219
+ # `/cra/check_report/pdf/get` retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
3084
3220
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
3085
3221
  # @param [Hash] opts the optional parameters
3086
3222
  # @return [File]
@@ -3089,8 +3225,8 @@ module Plaid
3089
3225
  data
3090
3226
  end
3091
3227
 
3092
- # Retrieve the most recent Base Report in PDF format. You can also include other reports in the same PDF if you specify &#x60;add_ons&#x60;.
3093
- # &#x60;/cra/check_report/pdf/get&#x60; retrieve the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format
3228
+ # Retrieve Consumer Reports as a PDF
3229
+ # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
3094
3230
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
3095
3231
  # @param [Hash] opts the optional parameters
3096
3232
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -3219,27 +3355,231 @@ module Plaid
3219
3355
  # `/cra/loans/register` registers a list of loans to their applicants.
3220
3356
  # @param cra_loans_register_request [CRALoansRegisterRequest]
3221
3357
  # @param [Hash] opts the optional parameters
3222
- # @return [CraLoansRegisterResponse]
3223
- def cra_loans_register(cra_loans_register_request, opts = {})
3224
- data, _status_code, _headers = cra_loans_register_with_http_info(cra_loans_register_request, opts)
3358
+ # @return [CraLoansRegisterResponse]
3359
+ def cra_loans_register(cra_loans_register_request, opts = {})
3360
+ data, _status_code, _headers = cra_loans_register_with_http_info(cra_loans_register_request, opts)
3361
+ data
3362
+ end
3363
+
3364
+ # Register a list of loans to their applicants.
3365
+ # &#x60;/cra/loans/register&#x60; registers a list of loans to their applicants.
3366
+ # @param cra_loans_register_request [CRALoansRegisterRequest]
3367
+ # @param [Hash] opts the optional parameters
3368
+ # @return [Array<(CraLoansRegisterResponse, Integer, Hash)>] CraLoansRegisterResponse data, response status code and response headers
3369
+ def cra_loans_register_with_http_info(cra_loans_register_request, opts = {})
3370
+ if @api_client.config.debugging
3371
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_register ...'
3372
+ end
3373
+ # verify the required parameter 'cra_loans_register_request' is set
3374
+ if @api_client.config.client_side_validation && cra_loans_register_request.nil?
3375
+ fail ArgumentError, "Missing the required parameter 'cra_loans_register_request' when calling PlaidApi.cra_loans_register"
3376
+ end
3377
+ # resource path
3378
+ local_var_path = '/cra/loans/register'
3379
+
3380
+ # query parameters
3381
+ query_params = opts[:query_params] || {}
3382
+
3383
+ # header parameters
3384
+ header_params = opts[:header_params] || {}
3385
+ # HTTP header 'Accept' (if needed)
3386
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3387
+ # HTTP header 'Content-Type'
3388
+ content_type = @api_client.select_header_content_type(['application/json'])
3389
+ if !content_type.nil?
3390
+ header_params['Content-Type'] = content_type
3391
+ end
3392
+
3393
+ # form parameters
3394
+ form_params = opts[:form_params] || {}
3395
+
3396
+ # http body (model)
3397
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_register_request)
3398
+
3399
+ # return_type
3400
+ return_type = opts[:debug_return_type] || 'CraLoansRegisterResponse'
3401
+
3402
+ # auth_names
3403
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3404
+
3405
+ new_options = opts.merge(
3406
+ :operation => :"PlaidApi.cra_loans_register",
3407
+ :header_params => header_params,
3408
+ :query_params => query_params,
3409
+ :form_params => form_params,
3410
+ :body => post_body,
3411
+ :auth_names => auth_names,
3412
+ :return_type => return_type
3413
+ )
3414
+
3415
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3416
+ if @api_client.config.debugging
3417
+ @api_client.config.logger.debug "API called: PlaidApi#cra_loans_register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3418
+ end
3419
+ return data, status_code, headers
3420
+ end
3421
+
3422
+ # Unregister a list of loans.
3423
+ # `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.
3424
+ # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
3425
+ # @param [Hash] opts the optional parameters
3426
+ # @return [CraLoanUnregisterResponse]
3427
+ def cra_loans_unregister(cra_loans_unregister_request, opts = {})
3428
+ data, _status_code, _headers = cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts)
3429
+ data
3430
+ end
3431
+
3432
+ # Unregister a list of loans.
3433
+ # &#x60;/cra/loans/unregister&#x60; indicates the loans have reached a final status and no further updates are expected.
3434
+ # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
3435
+ # @param [Hash] opts the optional parameters
3436
+ # @return [Array<(CraLoanUnregisterResponse, Integer, Hash)>] CraLoanUnregisterResponse data, response status code and response headers
3437
+ def cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts = {})
3438
+ if @api_client.config.debugging
3439
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_unregister ...'
3440
+ end
3441
+ # verify the required parameter 'cra_loans_unregister_request' is set
3442
+ if @api_client.config.client_side_validation && cra_loans_unregister_request.nil?
3443
+ fail ArgumentError, "Missing the required parameter 'cra_loans_unregister_request' when calling PlaidApi.cra_loans_unregister"
3444
+ end
3445
+ # resource path
3446
+ local_var_path = '/cra/loans/unregister'
3447
+
3448
+ # query parameters
3449
+ query_params = opts[:query_params] || {}
3450
+
3451
+ # header parameters
3452
+ header_params = opts[:header_params] || {}
3453
+ # HTTP header 'Accept' (if needed)
3454
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3455
+ # HTTP header 'Content-Type'
3456
+ content_type = @api_client.select_header_content_type(['application/json'])
3457
+ if !content_type.nil?
3458
+ header_params['Content-Type'] = content_type
3459
+ end
3460
+
3461
+ # form parameters
3462
+ form_params = opts[:form_params] || {}
3463
+
3464
+ # http body (model)
3465
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_unregister_request)
3466
+
3467
+ # return_type
3468
+ return_type = opts[:debug_return_type] || 'CraLoanUnregisterResponse'
3469
+
3470
+ # auth_names
3471
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3472
+
3473
+ new_options = opts.merge(
3474
+ :operation => :"PlaidApi.cra_loans_unregister",
3475
+ :header_params => header_params,
3476
+ :query_params => query_params,
3477
+ :form_params => form_params,
3478
+ :body => post_body,
3479
+ :auth_names => auth_names,
3480
+ :return_type => return_type
3481
+ )
3482
+
3483
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3484
+ if @api_client.config.debugging
3485
+ @api_client.config.logger.debug "API called: PlaidApi#cra_loans_unregister\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3486
+ end
3487
+ return data, status_code, headers
3488
+ end
3489
+
3490
+ # Updates loan data.
3491
+ # `/cra/loans/update` updates loan information such as the status and payment history.
3492
+ # @param cra_loans_update_request [CraLoansUpdateRequest]
3493
+ # @param [Hash] opts the optional parameters
3494
+ # @return [CraLoansUpdateResponse]
3495
+ def cra_loans_update(cra_loans_update_request, opts = {})
3496
+ data, _status_code, _headers = cra_loans_update_with_http_info(cra_loans_update_request, opts)
3497
+ data
3498
+ end
3499
+
3500
+ # Updates loan data.
3501
+ # &#x60;/cra/loans/update&#x60; updates loan information such as the status and payment history.
3502
+ # @param cra_loans_update_request [CraLoansUpdateRequest]
3503
+ # @param [Hash] opts the optional parameters
3504
+ # @return [Array<(CraLoansUpdateResponse, Integer, Hash)>] CraLoansUpdateResponse data, response status code and response headers
3505
+ def cra_loans_update_with_http_info(cra_loans_update_request, opts = {})
3506
+ if @api_client.config.debugging
3507
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_update ...'
3508
+ end
3509
+ # verify the required parameter 'cra_loans_update_request' is set
3510
+ if @api_client.config.client_side_validation && cra_loans_update_request.nil?
3511
+ fail ArgumentError, "Missing the required parameter 'cra_loans_update_request' when calling PlaidApi.cra_loans_update"
3512
+ end
3513
+ # resource path
3514
+ local_var_path = '/cra/loans/update'
3515
+
3516
+ # query parameters
3517
+ query_params = opts[:query_params] || {}
3518
+
3519
+ # header parameters
3520
+ header_params = opts[:header_params] || {}
3521
+ # HTTP header 'Accept' (if needed)
3522
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3523
+ # HTTP header 'Content-Type'
3524
+ content_type = @api_client.select_header_content_type(['application/json'])
3525
+ if !content_type.nil?
3526
+ header_params['Content-Type'] = content_type
3527
+ end
3528
+
3529
+ # form parameters
3530
+ form_params = opts[:form_params] || {}
3531
+
3532
+ # http body (model)
3533
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_update_request)
3534
+
3535
+ # return_type
3536
+ return_type = opts[:debug_return_type] || 'CraLoansUpdateResponse'
3537
+
3538
+ # auth_names
3539
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3540
+
3541
+ new_options = opts.merge(
3542
+ :operation => :"PlaidApi.cra_loans_update",
3543
+ :header_params => header_params,
3544
+ :query_params => query_params,
3545
+ :form_params => form_params,
3546
+ :body => post_body,
3547
+ :auth_names => auth_names,
3548
+ :return_type => return_type
3549
+ )
3550
+
3551
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3552
+ if @api_client.config.debugging
3553
+ @api_client.config.logger.debug "API called: PlaidApi#cra_loans_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3554
+ end
3555
+ return data, status_code, headers
3556
+ end
3557
+
3558
+ # Retrieve a Monitoring Insights Report
3559
+ # This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received.
3560
+ # @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
3561
+ # @param [Hash] opts the optional parameters
3562
+ # @return [CraMonitoringInsightsGetResponse]
3563
+ def cra_monitoring_insights_get(cra_monitoring_insights_get_request, opts = {})
3564
+ data, _status_code, _headers = cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts)
3225
3565
  data
3226
3566
  end
3227
3567
 
3228
- # Register a list of loans to their applicants.
3229
- # &#x60;/cra/loans/register&#x60; registers a list of loans to their applicants.
3230
- # @param cra_loans_register_request [CRALoansRegisterRequest]
3568
+ # Retrieve a Monitoring Insights Report
3569
+ # This endpoint allows you to retrieve a Monitoring Insights report by passing in the &#x60;user_token&#x60; referred to in the webhook you received.
3570
+ # @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
3231
3571
  # @param [Hash] opts the optional parameters
3232
- # @return [Array<(CraLoansRegisterResponse, Integer, Hash)>] CraLoansRegisterResponse data, response status code and response headers
3233
- def cra_loans_register_with_http_info(cra_loans_register_request, opts = {})
3572
+ # @return [Array<(CraMonitoringInsightsGetResponse, Integer, Hash)>] CraMonitoringInsightsGetResponse data, response status code and response headers
3573
+ def cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts = {})
3234
3574
  if @api_client.config.debugging
3235
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_register ...'
3575
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_get ...'
3236
3576
  end
3237
- # verify the required parameter 'cra_loans_register_request' is set
3238
- if @api_client.config.client_side_validation && cra_loans_register_request.nil?
3239
- fail ArgumentError, "Missing the required parameter 'cra_loans_register_request' when calling PlaidApi.cra_loans_register"
3577
+ # verify the required parameter 'cra_monitoring_insights_get_request' is set
3578
+ if @api_client.config.client_side_validation && cra_monitoring_insights_get_request.nil?
3579
+ fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_get_request' when calling PlaidApi.cra_monitoring_insights_get"
3240
3580
  end
3241
3581
  # resource path
3242
- local_var_path = '/cra/loans/register'
3582
+ local_var_path = '/cra/monitoring_insights/get'
3243
3583
 
3244
3584
  # query parameters
3245
3585
  query_params = opts[:query_params] || {}
@@ -3258,16 +3598,16 @@ module Plaid
3258
3598
  form_params = opts[:form_params] || {}
3259
3599
 
3260
3600
  # http body (model)
3261
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_register_request)
3601
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_get_request)
3262
3602
 
3263
3603
  # return_type
3264
- return_type = opts[:debug_return_type] || 'CraLoansRegisterResponse'
3604
+ return_type = opts[:debug_return_type] || 'CraMonitoringInsightsGetResponse'
3265
3605
 
3266
3606
  # auth_names
3267
3607
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3268
3608
 
3269
3609
  new_options = opts.merge(
3270
- :operation => :"PlaidApi.cra_loans_register",
3610
+ :operation => :"PlaidApi.cra_monitoring_insights_get",
3271
3611
  :header_params => header_params,
3272
3612
  :query_params => query_params,
3273
3613
  :form_params => form_params,
@@ -3278,36 +3618,36 @@ module Plaid
3278
3618
 
3279
3619
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3280
3620
  if @api_client.config.debugging
3281
- @api_client.config.logger.debug "API called: PlaidApi#cra_loans_register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3621
+ @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3282
3622
  end
3283
3623
  return data, status_code, headers
3284
3624
  end
3285
3625
 
3286
- # Unregister a list of loans.
3287
- # `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.
3288
- # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
3626
+ # Subscribe to Monitoring Insights
3627
+ # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
3628
+ # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
3289
3629
  # @param [Hash] opts the optional parameters
3290
- # @return [CraLoanUnregisterResponse]
3291
- def cra_loans_unregister(cra_loans_unregister_request, opts = {})
3292
- data, _status_code, _headers = cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts)
3630
+ # @return [CraMonitoringInsightsSubscribeResponse]
3631
+ def cra_monitoring_insights_subscribe(cra_monitoring_insights_subscribe_request, opts = {})
3632
+ data, _status_code, _headers = cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts)
3293
3633
  data
3294
3634
  end
3295
3635
 
3296
- # Unregister a list of loans.
3297
- # &#x60;/cra/loans/unregister&#x60; indicates the loans have reached a final status and no further updates are expected.
3298
- # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
3636
+ # Subscribe to Monitoring Insights
3637
+ # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated every 14 days.
3638
+ # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
3299
3639
  # @param [Hash] opts the optional parameters
3300
- # @return [Array<(CraLoanUnregisterResponse, Integer, Hash)>] CraLoanUnregisterResponse data, response status code and response headers
3301
- def cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts = {})
3640
+ # @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
3641
+ def cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts = {})
3302
3642
  if @api_client.config.debugging
3303
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_unregister ...'
3643
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_subscribe ...'
3304
3644
  end
3305
- # verify the required parameter 'cra_loans_unregister_request' is set
3306
- if @api_client.config.client_side_validation && cra_loans_unregister_request.nil?
3307
- fail ArgumentError, "Missing the required parameter 'cra_loans_unregister_request' when calling PlaidApi.cra_loans_unregister"
3645
+ # verify the required parameter 'cra_monitoring_insights_subscribe_request' is set
3646
+ if @api_client.config.client_side_validation && cra_monitoring_insights_subscribe_request.nil?
3647
+ fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_subscribe_request' when calling PlaidApi.cra_monitoring_insights_subscribe"
3308
3648
  end
3309
3649
  # resource path
3310
- local_var_path = '/cra/loans/unregister'
3650
+ local_var_path = '/cra/monitoring_insights/subscribe'
3311
3651
 
3312
3652
  # query parameters
3313
3653
  query_params = opts[:query_params] || {}
@@ -3326,16 +3666,16 @@ module Plaid
3326
3666
  form_params = opts[:form_params] || {}
3327
3667
 
3328
3668
  # http body (model)
3329
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_unregister_request)
3669
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_subscribe_request)
3330
3670
 
3331
3671
  # return_type
3332
- return_type = opts[:debug_return_type] || 'CraLoanUnregisterResponse'
3672
+ return_type = opts[:debug_return_type] || 'CraMonitoringInsightsSubscribeResponse'
3333
3673
 
3334
3674
  # auth_names
3335
3675
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3336
3676
 
3337
3677
  new_options = opts.merge(
3338
- :operation => :"PlaidApi.cra_loans_unregister",
3678
+ :operation => :"PlaidApi.cra_monitoring_insights_subscribe",
3339
3679
  :header_params => header_params,
3340
3680
  :query_params => query_params,
3341
3681
  :form_params => form_params,
@@ -3346,36 +3686,36 @@ module Plaid
3346
3686
 
3347
3687
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3348
3688
  if @api_client.config.debugging
3349
- @api_client.config.logger.debug "API called: PlaidApi#cra_loans_unregister\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3689
+ @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3350
3690
  end
3351
3691
  return data, status_code, headers
3352
3692
  end
3353
3693
 
3354
- # Updates loan data.
3355
- # `/cra/loans/update` updates loan information such as the status and payment history.
3356
- # @param cra_loans_update_request [CraLoansUpdateRequest]
3694
+ # Unsubscribe from Monitoring Insights
3695
+ # This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
3696
+ # @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
3357
3697
  # @param [Hash] opts the optional parameters
3358
- # @return [CraLoansUpdateResponse]
3359
- def cra_loans_update(cra_loans_update_request, opts = {})
3360
- data, _status_code, _headers = cra_loans_update_with_http_info(cra_loans_update_request, opts)
3698
+ # @return [CraMonitoringInsightsUnsubscribeResponse]
3699
+ def cra_monitoring_insights_unsubscribe(cra_monitoring_insights_unsubscribe_request, opts = {})
3700
+ data, _status_code, _headers = cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts)
3361
3701
  data
3362
3702
  end
3363
3703
 
3364
- # Updates loan data.
3365
- # &#x60;/cra/loans/update&#x60; updates loan information such as the status and payment history.
3366
- # @param cra_loans_update_request [CraLoansUpdateRequest]
3704
+ # Unsubscribe from Monitoring Insights
3705
+ # This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
3706
+ # @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
3367
3707
  # @param [Hash] opts the optional parameters
3368
- # @return [Array<(CraLoansUpdateResponse, Integer, Hash)>] CraLoansUpdateResponse data, response status code and response headers
3369
- def cra_loans_update_with_http_info(cra_loans_update_request, opts = {})
3708
+ # @return [Array<(CraMonitoringInsightsUnsubscribeResponse, Integer, Hash)>] CraMonitoringInsightsUnsubscribeResponse data, response status code and response headers
3709
+ def cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts = {})
3370
3710
  if @api_client.config.debugging
3371
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_update ...'
3711
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_unsubscribe ...'
3372
3712
  end
3373
- # verify the required parameter 'cra_loans_update_request' is set
3374
- if @api_client.config.client_side_validation && cra_loans_update_request.nil?
3375
- fail ArgumentError, "Missing the required parameter 'cra_loans_update_request' when calling PlaidApi.cra_loans_update"
3713
+ # verify the required parameter 'cra_monitoring_insights_unsubscribe_request' is set
3714
+ if @api_client.config.client_side_validation && cra_monitoring_insights_unsubscribe_request.nil?
3715
+ fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_unsubscribe_request' when calling PlaidApi.cra_monitoring_insights_unsubscribe"
3376
3716
  end
3377
3717
  # resource path
3378
- local_var_path = '/cra/loans/update'
3718
+ local_var_path = '/cra/monitoring_insights/unsubscribe'
3379
3719
 
3380
3720
  # query parameters
3381
3721
  query_params = opts[:query_params] || {}
@@ -3394,16 +3734,16 @@ module Plaid
3394
3734
  form_params = opts[:form_params] || {}
3395
3735
 
3396
3736
  # http body (model)
3397
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_update_request)
3737
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_unsubscribe_request)
3398
3738
 
3399
3739
  # return_type
3400
- return_type = opts[:debug_return_type] || 'CraLoansUpdateResponse'
3740
+ return_type = opts[:debug_return_type] || 'CraMonitoringInsightsUnsubscribeResponse'
3401
3741
 
3402
3742
  # auth_names
3403
3743
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3404
3744
 
3405
3745
  new_options = opts.merge(
3406
- :operation => :"PlaidApi.cra_loans_update",
3746
+ :operation => :"PlaidApi.cra_monitoring_insights_unsubscribe",
3407
3747
  :header_params => header_params,
3408
3748
  :query_params => query_params,
3409
3749
  :form_params => form_params,
@@ -3414,7 +3754,7 @@ module Plaid
3414
3754
 
3415
3755
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3416
3756
  if @api_client.config.debugging
3417
- @api_client.config.logger.debug "API called: PlaidApi#cra_loans_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3757
+ @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3418
3758
  end
3419
3759
  return data, status_code, headers
3420
3760
  end
@@ -3828,7 +4168,7 @@ module Plaid
3828
4168
  end
3829
4169
 
3830
4170
  # Retrieve information from the bank accounts used for income verification
3831
- # `/credit/bank_income/get` returns the bank income report(s) for a specified user.
4171
+ # `/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link). To return older reports, use the `options.count` field.
3832
4172
  # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
3833
4173
  # @param [Hash] opts the optional parameters
3834
4174
  # @return [CreditBankIncomeGetResponse]
@@ -3838,7 +4178,7 @@ module Plaid
3838
4178
  end
3839
4179
 
3840
4180
  # Retrieve information from the bank accounts used for income verification
3841
- # &#x60;/credit/bank_income/get&#x60; returns the bank income report(s) for a specified user.
4181
+ # &#x60;/credit/bank_income/get&#x60; returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link). To return older reports, use the &#x60;options.count&#x60; field.
3842
4182
  # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
3843
4183
  # @param [Hash] opts the optional parameters
3844
4184
  # @return [Array<(CreditBankIncomeGetResponse, Integer, Hash)>] CreditBankIncomeGetResponse data, response status code and response headers
@@ -3896,7 +4236,7 @@ module Plaid
3896
4236
  end
3897
4237
 
3898
4238
  # Retrieve information from the bank accounts used for income verification in PDF format
3899
- # `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
4239
+ # `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link).
3900
4240
  # @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
3901
4241
  # @param [Hash] opts the optional parameters
3902
4242
  # @return [File]
@@ -3906,7 +4246,7 @@ module Plaid
3906
4246
  end
3907
4247
 
3908
4248
  # Retrieve information from the bank accounts used for income verification in PDF format
3909
- # &#x60;/credit/bank_income/pdf/get&#x60; returns the most recent bank income report for a specified user in PDF format.
4249
+ # &#x60;/credit/bank_income/pdf/get&#x60; returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link).
3910
4250
  # @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
3911
4251
  # @param [Hash] opts the optional parameters
3912
4252
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -3964,7 +4304,7 @@ module Plaid
3964
4304
  end
3965
4305
 
3966
4306
  # Refresh a user's bank income information
3967
- # `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
4307
+ # `/credit/bank_income/refresh` refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead.
3968
4308
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
3969
4309
  # @param [Hash] opts the optional parameters
3970
4310
  # @return [CreditBankIncomeRefreshResponse]
@@ -3974,7 +4314,7 @@ module Plaid
3974
4314
  end
3975
4315
 
3976
4316
  # Refresh a user&#39;s bank income information
3977
- # &#x60;/credit/bank_income/refresh&#x60; refreshes the bank income report data for a specific user.
4317
+ # &#x60;/credit/bank_income/refresh&#x60; refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead.
3978
4318
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
3979
4319
  # @param [Hash] opts the optional parameters
3980
4320
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
@@ -5731,6 +6071,129 @@ module Plaid
5731
6071
  return data, status_code, headers
5732
6072
  end
5733
6073
 
6074
+ # Get Recipient
6075
+ # Get a specific recipient
6076
+ # @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
6077
+ # @param [Hash] opts the optional parameters
6078
+ # @option opts [String] :oauth_state_id The value that is passed into the OAuth URI &#39;state&#39; query parameter.
6079
+ # @return [GetRecipientResponse]
6080
+ def get_recipient(recipient_id, opts = {})
6081
+ data, _status_code, _headers = get_recipient_with_http_info(recipient_id, opts)
6082
+ data
6083
+ end
6084
+
6085
+ # Get Recipient
6086
+ # Get a specific recipient
6087
+ # @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
6088
+ # @param [Hash] opts the optional parameters
6089
+ # @option opts [String] :oauth_state_id The value that is passed into the OAuth URI &#39;state&#39; query parameter.
6090
+ # @return [Array<(GetRecipientResponse, Integer, Hash)>] GetRecipientResponse data, response status code and response headers
6091
+ def get_recipient_with_http_info(recipient_id, opts = {})
6092
+ if @api_client.config.debugging
6093
+ @api_client.config.logger.debug 'Calling API: PlaidApi.get_recipient ...'
6094
+ end
6095
+ # verify the required parameter 'recipient_id' is set
6096
+ if @api_client.config.client_side_validation && recipient_id.nil?
6097
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling PlaidApi.get_recipient"
6098
+ end
6099
+ # resource path
6100
+ local_var_path = '/fdx/recipient/{recipientId}'.sub('{' + 'recipientId' + '}', CGI.escape(recipient_id.to_s))
6101
+
6102
+ # query parameters
6103
+ query_params = opts[:query_params] || {}
6104
+
6105
+ # header parameters
6106
+ header_params = opts[:header_params] || {}
6107
+ # HTTP header 'Accept' (if needed)
6108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6109
+ header_params[:'OAUTH-STATE-ID'] = opts[:'oauth_state_id'] if !opts[:'oauth_state_id'].nil?
6110
+
6111
+ # form parameters
6112
+ form_params = opts[:form_params] || {}
6113
+
6114
+ # http body (model)
6115
+ post_body = opts[:debug_body]
6116
+
6117
+ # return_type
6118
+ return_type = opts[:debug_return_type] || 'GetRecipientResponse'
6119
+
6120
+ # auth_names
6121
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6122
+
6123
+ new_options = opts.merge(
6124
+ :operation => :"PlaidApi.get_recipient",
6125
+ :header_params => header_params,
6126
+ :query_params => query_params,
6127
+ :form_params => form_params,
6128
+ :body => post_body,
6129
+ :auth_names => auth_names,
6130
+ :return_type => return_type
6131
+ )
6132
+
6133
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6134
+ if @api_client.config.debugging
6135
+ @api_client.config.logger.debug "API called: PlaidApi#get_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6136
+ end
6137
+ return data, status_code, headers
6138
+ end
6139
+
6140
+ # Get Recipients
6141
+ # Returns a list of Recipients
6142
+ # @param [Hash] opts the optional parameters
6143
+ # @return [GetRecipientsResponse]
6144
+ def get_recipients(opts = {})
6145
+ data, _status_code, _headers = get_recipients_with_http_info(opts)
6146
+ data
6147
+ end
6148
+
6149
+ # Get Recipients
6150
+ # Returns a list of Recipients
6151
+ # @param [Hash] opts the optional parameters
6152
+ # @return [Array<(GetRecipientsResponse, Integer, Hash)>] GetRecipientsResponse data, response status code and response headers
6153
+ def get_recipients_with_http_info(opts = {})
6154
+ if @api_client.config.debugging
6155
+ @api_client.config.logger.debug 'Calling API: PlaidApi.get_recipients ...'
6156
+ end
6157
+ # resource path
6158
+ local_var_path = '/fdx/recipients'
6159
+
6160
+ # query parameters
6161
+ query_params = opts[:query_params] || {}
6162
+
6163
+ # header parameters
6164
+ header_params = opts[:header_params] || {}
6165
+ # HTTP header 'Accept' (if needed)
6166
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6167
+
6168
+ # form parameters
6169
+ form_params = opts[:form_params] || {}
6170
+
6171
+ # http body (model)
6172
+ post_body = opts[:debug_body]
6173
+
6174
+ # return_type
6175
+ return_type = opts[:debug_return_type] || 'GetRecipientsResponse'
6176
+
6177
+ # auth_names
6178
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6179
+
6180
+ new_options = opts.merge(
6181
+ :operation => :"PlaidApi.get_recipients",
6182
+ :header_params => header_params,
6183
+ :query_params => query_params,
6184
+ :form_params => form_params,
6185
+ :body => post_body,
6186
+ :auth_names => auth_names,
6187
+ :return_type => return_type
6188
+ )
6189
+
6190
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6191
+ if @api_client.config.debugging
6192
+ @api_client.config.logger.debug "API called: PlaidApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6193
+ end
6194
+ return data, status_code, headers
6195
+ end
6196
+
5734
6197
  # Returns uploaded document identity
5735
6198
  # Use `/identity/documents/uploads/get` to retrieve document uploaded identity.
5736
6199
  # @param identity_documents_uploads_get_request [IdentityDocumentsUploadsGetRequest]
@@ -5800,7 +6263,7 @@ module Plaid
5800
6263
  end
5801
6264
 
5802
6265
  # Retrieve identity data
5803
- # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
6266
+ # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
5804
6267
  # @param identity_get_request [IdentityGetRequest]
5805
6268
  # @param [Hash] opts the optional parameters
5806
6269
  # @return [IdentityGetResponse]
@@ -5810,7 +6273,7 @@ module Plaid
5810
6273
  end
5811
6274
 
5812
6275
  # Retrieve identity data
5813
- # The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the &#x60;owners&#x60; object is not returned, and instead identity information is returned in the top level &#x60;identity&#x60; object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
6276
+ # The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: In API versions 2018-05-22 and earlier, the &#x60;owners&#x60; object is not returned, and instead identity information is returned in the top level &#x60;identity&#x60; object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
5814
6277
  # @param identity_get_request [IdentityGetRequest]
5815
6278
  # @param [Hash] opts the optional parameters
5816
6279
  # @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
@@ -5868,7 +6331,7 @@ module Plaid
5868
6331
  end
5869
6332
 
5870
6333
  # Retrieve identity match score
5871
- # The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
6334
+ # The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
5872
6335
  # @param identity_match_request [IdentityMatchRequest]
5873
6336
  # @param [Hash] opts the optional parameters
5874
6337
  # @return [IdentityMatchResponse]
@@ -5878,7 +6341,7 @@ module Plaid
5878
6341
  end
5879
6342
 
5880
6343
  # Retrieve identity match score
5881
- # The &#x60;/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
6344
+ # The &#x60;/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data.
5882
6345
  # @param identity_match_request [IdentityMatchRequest]
5883
6346
  # @param [Hash] opts the optional parameters
5884
6347
  # @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
@@ -7024,7 +7487,7 @@ module Plaid
7024
7487
  end
7025
7488
 
7026
7489
  # Refresh investment data
7027
- # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. \"Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7490
+ # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7028
7491
  # @param investments_refresh_request [InvestmentsRefreshRequest]
7029
7492
  # @param [Hash] opts the optional parameters
7030
7493
  # @return [InvestmentsRefreshResponse]
@@ -7034,7 +7497,7 @@ module Plaid
7034
7497
  end
7035
7498
 
7036
7499
  # Refresh investment data
7037
- # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. \&quot;Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7500
+ # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7038
7501
  # @param investments_refresh_request [InvestmentsRefreshRequest]
7039
7502
  # @param [Hash] opts the optional parameters
7040
7503
  # @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
@@ -7908,7 +8371,7 @@ module Plaid
7908
8371
  end
7909
8372
 
7910
8373
  # Retrieve Liabilities data
7911
- # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
8374
+ # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
7912
8375
  # @param liabilities_get_request [LiabilitiesGetRequest]
7913
8376
  # @param [Hash] opts the optional parameters
7914
8377
  # @return [LiabilitiesGetResponse]
@@ -7918,7 +8381,7 @@ module Plaid
7918
8381
  end
7919
8382
 
7920
8383
  # Retrieve Liabilities data
7921
- # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
8384
+ # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;.
7922
8385
  # @param liabilities_get_request [LiabilitiesGetRequest]
7923
8386
  # @param [Hash] opts the optional parameters
7924
8387
  # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
@@ -8248,7 +8711,7 @@ module Plaid
8248
8711
  end
8249
8712
 
8250
8713
  # Create Link Token
8251
- # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
8714
+ # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. For most Plaid products, the `public_token` is saved and exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the [update mode](https://plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow.
8252
8715
  # @param link_token_create_request [LinkTokenCreateRequest]
8253
8716
  # @param [Hash] opts the optional parameters
8254
8717
  # @return [LinkTokenCreateResponse]
@@ -8258,7 +8721,7 @@ module Plaid
8258
8721
  end
8259
8722
 
8260
8723
  # Create Link Token
8261
- # The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;, which can then be exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
8724
+ # The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;. For most Plaid products, the &#x60;public_token&#x60; is saved and exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; is also used to initialize other Link flows, such as the [update mode](https://plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow.
8262
8725
  # @param link_token_create_request [LinkTokenCreateRequest]
8263
8726
  # @param [Hash] opts the optional parameters
8264
8727
  # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
@@ -8316,7 +8779,7 @@ module Plaid
8316
8779
  end
8317
8780
 
8318
8781
  # Get Link Token
8319
- # The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
8782
+ # The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
8320
8783
  # @param link_token_get_request [LinkTokenGetRequest]
8321
8784
  # @param [Hash] opts the optional parameters
8322
8785
  # @return [LinkTokenGetResponse]
@@ -8326,7 +8789,7 @@ module Plaid
8326
8789
  end
8327
8790
 
8328
8791
  # Get Link Token
8329
- # The &#x60;/link/token/get&#x60; endpoint gets information about a previously-created &#x60;link_token&#x60; using the &#x60;/link/token/create&#x60; endpoint. It can be useful for debugging purposes.
8792
+ # The &#x60;/link/token/get&#x60; endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don&#39;t provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
8330
8793
  # @param link_token_get_request [LinkTokenGetRequest]
8331
8794
  # @param [Hash] opts the optional parameters
8332
8795
  # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
@@ -8383,6 +8846,74 @@ module Plaid
8383
8846
  return data, status_code, headers
8384
8847
  end
8385
8848
 
8849
+ # Retrieve network insights for the provided `access_tokens`
8850
+ # This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
8851
+ # @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
8852
+ # @param [Hash] opts the optional parameters
8853
+ # @return [NetworkInsightsReportGetResponse]
8854
+ def network_insights_report_get(network_insights_report_get_request, opts = {})
8855
+ data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
8856
+ data
8857
+ end
8858
+
8859
+ # Retrieve network insights for the provided &#x60;access_tokens&#x60;
8860
+ # This endpoint allows you to retrieve the Network Insights from a list of &#x60;access_tokens&#x60;.
8861
+ # @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
8862
+ # @param [Hash] opts the optional parameters
8863
+ # @return [Array<(NetworkInsightsReportGetResponse, Integer, Hash)>] NetworkInsightsReportGetResponse data, response status code and response headers
8864
+ def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
8865
+ if @api_client.config.debugging
8866
+ @api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
8867
+ end
8868
+ # verify the required parameter 'network_insights_report_get_request' is set
8869
+ if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
8870
+ fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
8871
+ end
8872
+ # resource path
8873
+ local_var_path = '/network_insights/report/get'
8874
+
8875
+ # query parameters
8876
+ query_params = opts[:query_params] || {}
8877
+
8878
+ # header parameters
8879
+ header_params = opts[:header_params] || {}
8880
+ # HTTP header 'Accept' (if needed)
8881
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8882
+ # HTTP header 'Content-Type'
8883
+ content_type = @api_client.select_header_content_type(['application/json'])
8884
+ if !content_type.nil?
8885
+ header_params['Content-Type'] = content_type
8886
+ end
8887
+
8888
+ # form parameters
8889
+ form_params = opts[:form_params] || {}
8890
+
8891
+ # http body (model)
8892
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)
8893
+
8894
+ # return_type
8895
+ return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'
8896
+
8897
+ # auth_names
8898
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8899
+
8900
+ new_options = opts.merge(
8901
+ :operation => :"PlaidApi.network_insights_report_get",
8902
+ :header_params => header_params,
8903
+ :query_params => query_params,
8904
+ :form_params => form_params,
8905
+ :body => post_body,
8906
+ :auth_names => auth_names,
8907
+ :return_type => return_type
8908
+ )
8909
+
8910
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8911
+ if @api_client.config.debugging
8912
+ @api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8913
+ end
8914
+ return data, status_code, headers
8915
+ end
8916
+
8386
8917
  # Creates a new end customer for a Plaid reseller.
8387
8918
  # The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
8388
8919
  # @param partner_customer_create_request [PartnerCustomerCreateRequest]
@@ -8452,7 +8983,7 @@ module Plaid
8452
8983
  end
8453
8984
 
8454
8985
  # Enables a Plaid reseller's end customer in the Production environment.
8455
- # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
8986
+ # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
8456
8987
  # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
8457
8988
  # @param [Hash] opts the optional parameters
8458
8989
  # @return [PartnerCustomerEnableResponse]
@@ -8462,7 +8993,7 @@ module Plaid
8462
8993
  end
8463
8994
 
8464
8995
  # Enables a Plaid reseller&#39;s end customer in the Production environment.
8465
- # The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the Production environment.
8996
+ # The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the full Production environment.
8466
8997
  # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
8467
8998
  # @param [Hash] opts the optional parameters
8468
8999
  # @return [Array<(PartnerCustomerEnableResponse, Integer, Hash)>] PartnerCustomerEnableResponse data, response status code and response headers
@@ -8656,7 +9187,7 @@ module Plaid
8656
9187
  end
8657
9188
 
8658
9189
  # Removes a Plaid reseller's end customer.
8659
- # The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
9190
+ # The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in full Production.
8660
9191
  # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
8661
9192
  # @param [Hash] opts the optional parameters
8662
9193
  # @return [PartnerCustomerRemoveResponse]
@@ -8666,7 +9197,7 @@ module Plaid
8666
9197
  end
8667
9198
 
8668
9199
  # Removes a Plaid reseller&#39;s end customer.
8669
- # The &#x60;/partner/customer/remove&#x60; endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
9200
+ # The &#x60;/partner/customer/remove&#x60; endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in full Production.
8670
9201
  # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
8671
9202
  # @param [Hash] opts the optional parameters
8672
9203
  # @return [Array<(PartnerCustomerRemoveResponse, Integer, Hash)>] PartnerCustomerRemoveResponse data, response status code and response headers
@@ -8996,7 +9527,7 @@ module Plaid
8996
9527
  end
8997
9528
 
8998
9529
  # Create a payment
8999
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
9530
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
9000
9531
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
9001
9532
  # @param [Hash] opts the optional parameters
9002
9533
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -9006,7 +9537,7 @@ module Plaid
9006
9537
  end
9007
9538
 
9008
9539
  # Create a payment
9009
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
9540
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
9010
9541
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
9011
9542
  # @param [Hash] opts the optional parameters
9012
9543
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -10084,7 +10615,7 @@ module Plaid
10084
10615
  end
10085
10616
 
10086
10617
  # Retrieve identity match score
10087
- # The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
10618
+ # The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
10088
10619
  # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
10089
10620
  # @param [Hash] opts the optional parameters
10090
10621
  # @return [ProcessorIdentityMatchResponse]
@@ -10094,7 +10625,7 @@ module Plaid
10094
10625
  end
10095
10626
 
10096
10627
  # Retrieve identity match score
10097
- # The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
10628
+ # The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data.
10098
10629
  # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
10099
10630
  # @param [Hash] opts the optional parameters
10100
10631
  # @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
@@ -11049,17 +11580,85 @@ module Plaid
11049
11580
  # This endpoint replaces &#x60;/processor/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/processor/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/processor/transactions/sync&#x60; provides the same functionality as &#x60;/processor/transactions/get&#x60; and can be used instead of &#x60;/processor/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;/processor/transactions/sync&#x60; for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that processor token. 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 a processor token, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/processor/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;/processor/transactions/sync&#x60; fails when retrieving a paginated update, which can occur as a result of 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;/processor/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. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that for newly created processor tokens, data may not be immediately available to &#x60;/processor/transactions/sync&#x60;. Plaid begins preparing transactions data when the corresponding 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 receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11050
11581
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
11051
11582
  # @param [Hash] opts the optional parameters
11052
- # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
11053
- def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
11583
+ # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
11584
+ def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
11585
+ if @api_client.config.debugging
11586
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
11587
+ end
11588
+ # verify the required parameter 'processor_transactions_sync_request' is set
11589
+ if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
11590
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
11591
+ end
11592
+ # resource path
11593
+ local_var_path = '/processor/transactions/sync'
11594
+
11595
+ # query parameters
11596
+ query_params = opts[:query_params] || {}
11597
+
11598
+ # header parameters
11599
+ header_params = opts[:header_params] || {}
11600
+ # HTTP header 'Accept' (if needed)
11601
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11602
+ # HTTP header 'Content-Type'
11603
+ content_type = @api_client.select_header_content_type(['application/json'])
11604
+ if !content_type.nil?
11605
+ header_params['Content-Type'] = content_type
11606
+ end
11607
+
11608
+ # form parameters
11609
+ form_params = opts[:form_params] || {}
11610
+
11611
+ # http body (model)
11612
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
11613
+
11614
+ # return_type
11615
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
11616
+
11617
+ # auth_names
11618
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11619
+
11620
+ new_options = opts.merge(
11621
+ :operation => :"PlaidApi.processor_transactions_sync",
11622
+ :header_params => header_params,
11623
+ :query_params => query_params,
11624
+ :form_params => form_params,
11625
+ :body => post_body,
11626
+ :auth_names => auth_names,
11627
+ :return_type => return_type
11628
+ )
11629
+
11630
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11631
+ if @api_client.config.debugging
11632
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11633
+ end
11634
+ return data, status_code, headers
11635
+ end
11636
+
11637
+ # Retrieve a Profile
11638
+ # Returns user permissioned profile data including identity and item access tokens.
11639
+ # @param profile_get_request [ProfileGetRequest]
11640
+ # @param [Hash] opts the optional parameters
11641
+ # @return [ProfileGetResponse]
11642
+ def profile_get(profile_get_request, opts = {})
11643
+ data, _status_code, _headers = profile_get_with_http_info(profile_get_request, opts)
11644
+ data
11645
+ end
11646
+
11647
+ # Retrieve a Profile
11648
+ # Returns user permissioned profile data including identity and item access tokens.
11649
+ # @param profile_get_request [ProfileGetRequest]
11650
+ # @param [Hash] opts the optional parameters
11651
+ # @return [Array<(ProfileGetResponse, Integer, Hash)>] ProfileGetResponse data, response status code and response headers
11652
+ def profile_get_with_http_info(profile_get_request, opts = {})
11054
11653
  if @api_client.config.debugging
11055
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
11654
+ @api_client.config.logger.debug 'Calling API: PlaidApi.profile_get ...'
11056
11655
  end
11057
- # verify the required parameter 'processor_transactions_sync_request' is set
11058
- if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
11059
- fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
11656
+ # verify the required parameter 'profile_get_request' is set
11657
+ if @api_client.config.client_side_validation && profile_get_request.nil?
11658
+ fail ArgumentError, "Missing the required parameter 'profile_get_request' when calling PlaidApi.profile_get"
11060
11659
  end
11061
11660
  # resource path
11062
- local_var_path = '/processor/transactions/sync'
11661
+ local_var_path = '/profile/get'
11063
11662
 
11064
11663
  # query parameters
11065
11664
  query_params = opts[:query_params] || {}
@@ -11078,16 +11677,16 @@ module Plaid
11078
11677
  form_params = opts[:form_params] || {}
11079
11678
 
11080
11679
  # http body (model)
11081
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
11680
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_get_request)
11082
11681
 
11083
11682
  # return_type
11084
- return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
11683
+ return_type = opts[:debug_return_type] || 'ProfileGetResponse'
11085
11684
 
11086
11685
  # auth_names
11087
11686
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11088
11687
 
11089
11688
  new_options = opts.merge(
11090
- :operation => :"PlaidApi.processor_transactions_sync",
11689
+ :operation => :"PlaidApi.profile_get",
11091
11690
  :header_params => header_params,
11092
11691
  :query_params => query_params,
11093
11692
  :form_params => form_params,
@@ -11098,36 +11697,36 @@ module Plaid
11098
11697
 
11099
11698
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11100
11699
  if @api_client.config.debugging
11101
- @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11700
+ @api_client.config.logger.debug "API called: PlaidApi#profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11102
11701
  end
11103
11702
  return data, status_code, headers
11104
11703
  end
11105
11704
 
11106
- # Retrieve a Profile
11107
- # Returns user permissioned profile data including identity and item access tokens.
11108
- # @param profile_get_request [ProfileGetRequest]
11705
+ # Check a user's Plaid Network status
11706
+ # The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
11707
+ # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
11109
11708
  # @param [Hash] opts the optional parameters
11110
- # @return [ProfileGetResponse]
11111
- def profile_get(profile_get_request, opts = {})
11112
- data, _status_code, _headers = profile_get_with_http_info(profile_get_request, opts)
11709
+ # @return [ProfileNetworkStatusGetResponse]
11710
+ def profile_network_status_get(profile_network_status_get_request, opts = {})
11711
+ data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
11113
11712
  data
11114
11713
  end
11115
11714
 
11116
- # Retrieve a Profile
11117
- # Returns user permissioned profile data including identity and item access tokens.
11118
- # @param profile_get_request [ProfileGetRequest]
11715
+ # Check a user&#39;s Plaid Network status
11716
+ # The &#x60;/profile/network_status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user.
11717
+ # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
11119
11718
  # @param [Hash] opts the optional parameters
11120
- # @return [Array<(ProfileGetResponse, Integer, Hash)>] ProfileGetResponse data, response status code and response headers
11121
- def profile_get_with_http_info(profile_get_request, opts = {})
11719
+ # @return [Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>] ProfileNetworkStatusGetResponse data, response status code and response headers
11720
+ def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
11122
11721
  if @api_client.config.debugging
11123
- @api_client.config.logger.debug 'Calling API: PlaidApi.profile_get ...'
11722
+ @api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
11124
11723
  end
11125
- # verify the required parameter 'profile_get_request' is set
11126
- if @api_client.config.client_side_validation && profile_get_request.nil?
11127
- fail ArgumentError, "Missing the required parameter 'profile_get_request' when calling PlaidApi.profile_get"
11724
+ # verify the required parameter 'profile_network_status_get_request' is set
11725
+ if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
11726
+ fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
11128
11727
  end
11129
11728
  # resource path
11130
- local_var_path = '/profile/get'
11729
+ local_var_path = '/profile/network_status/get'
11131
11730
 
11132
11731
  # query parameters
11133
11732
  query_params = opts[:query_params] || {}
@@ -11146,16 +11745,16 @@ module Plaid
11146
11745
  form_params = opts[:form_params] || {}
11147
11746
 
11148
11747
  # http body (model)
11149
- post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_get_request)
11748
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)
11150
11749
 
11151
11750
  # return_type
11152
- return_type = opts[:debug_return_type] || 'ProfileGetResponse'
11751
+ return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'
11153
11752
 
11154
11753
  # auth_names
11155
11754
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11156
11755
 
11157
11756
  new_options = opts.merge(
11158
- :operation => :"PlaidApi.profile_get",
11757
+ :operation => :"PlaidApi.profile_network_status_get",
11159
11758
  :header_params => header_params,
11160
11759
  :query_params => query_params,
11161
11760
  :form_params => form_params,
@@ -11166,7 +11765,7 @@ module Plaid
11166
11765
 
11167
11766
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11168
11767
  if @api_client.config.debugging
11169
- @api_client.config.logger.debug "API called: PlaidApi#profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11768
+ @api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11170
11769
  end
11171
11770
  return data, status_code, headers
11172
11771
  end
@@ -11444,7 +12043,7 @@ module Plaid
11444
12043
  end
11445
12044
 
11446
12045
  # Fire a test webhook
11447
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, 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. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `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`).
12046
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `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 (except for webhooks of type `TRANSFER`).
11448
12047
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
11449
12048
  # @param [Hash] opts the optional parameters
11450
12049
  # @return [SandboxItemFireWebhookResponse]
@@ -11454,7 +12053,7 @@ module Plaid
11454
12053
  end
11455
12054
 
11456
12055
  # Fire a test webhook
11457
- # 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;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid sandbox &#x60;DEFAULT_UPDATE&#x60; responses include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, 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;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#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;).
12056
+ # 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;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid sandbox &#x60;DEFAULT_UPDATE&#x60; responses include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#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 (except for webhooks of type &#x60;TRANSFER&#x60;).
11458
12057
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
11459
12058
  # @param [Hash] opts the optional parameters
11460
12059
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -11852,7 +12451,7 @@ module Plaid
11852
12451
  end
11853
12452
 
11854
12453
  # Create a test Item
11855
- # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions.
12454
+ # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid's [pre-populated Sandbox test accounts](https://plaid.com/docs/sandbox/test-credentials/).
11856
12455
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
11857
12456
  # @param [Hash] opts the optional parameters
11858
12457
  # @return [SandboxPublicTokenCreateResponse]
@@ -11862,7 +12461,7 @@ module Plaid
11862
12461
  end
11863
12462
 
11864
12463
  # Create a test Item
11865
- # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. &#x60;/sandbox/public_token/create&#x60; cannot be used with OAuth institutions.
12464
+ # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid&#39;s [pre-populated Sandbox test accounts](https://plaid.com/docs/sandbox/test-credentials/).
11866
12465
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
11867
12466
  # @param [Hash] opts the optional parameters
11868
12467
  # @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
@@ -12735,31 +13334,31 @@ module Plaid
12735
13334
  return data, status_code, headers
12736
13335
  end
12737
13336
 
12738
- # Retrieve User Account
12739
- # Returns user permissioned account data including identity and item access tokens.
12740
- # @param user_account_session_get_request [UserAccountSessionGetRequest]
13337
+ # Force item(s) for a Sandbox User into an error state
13338
+ # `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
13339
+ # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
12741
13340
  # @param [Hash] opts the optional parameters
12742
- # @return [UserAccountSessionGetResponse]
12743
- def session_get(user_account_session_get_request, opts = {})
12744
- data, _status_code, _headers = session_get_with_http_info(user_account_session_get_request, opts)
13341
+ # @return [SandboxUserResetLoginResponse]
13342
+ def sandbox_user_reset_login(sandbox_user_reset_login_request, opts = {})
13343
+ data, _status_code, _headers = sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts)
12745
13344
  data
12746
13345
  end
12747
13346
 
12748
- # Retrieve User Account
12749
- # Returns user permissioned account data including identity and item access tokens.
12750
- # @param user_account_session_get_request [UserAccountSessionGetRequest]
13347
+ # Force item(s) for a Sandbox User into an error state
13348
+ # &#x60;/sandbox/user/reset_login/&#x60; functions the same as &#x60;/sandbox/item/reset_login&#x60;, but will modify Items related to a User. This endpoint forces each Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/user/reset_login&#x60;, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
13349
+ # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
12751
13350
  # @param [Hash] opts the optional parameters
12752
- # @return [Array<(UserAccountSessionGetResponse, Integer, Hash)>] UserAccountSessionGetResponse data, response status code and response headers
12753
- def session_get_with_http_info(user_account_session_get_request, opts = {})
13351
+ # @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
13352
+ def sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts = {})
12754
13353
  if @api_client.config.debugging
12755
- @api_client.config.logger.debug 'Calling API: PlaidApi.session_get ...'
13354
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_user_reset_login ...'
12756
13355
  end
12757
- # verify the required parameter 'user_account_session_get_request' is set
12758
- if @api_client.config.client_side_validation && user_account_session_get_request.nil?
12759
- fail ArgumentError, "Missing the required parameter 'user_account_session_get_request' when calling PlaidApi.session_get"
13356
+ # verify the required parameter 'sandbox_user_reset_login_request' is set
13357
+ if @api_client.config.client_side_validation && sandbox_user_reset_login_request.nil?
13358
+ fail ArgumentError, "Missing the required parameter 'sandbox_user_reset_login_request' when calling PlaidApi.sandbox_user_reset_login"
12760
13359
  end
12761
13360
  # resource path
12762
- local_var_path = '/user_account/session/get'
13361
+ local_var_path = '/sandbox/user/reset_login'
12763
13362
 
12764
13363
  # query parameters
12765
13364
  query_params = opts[:query_params] || {}
@@ -12778,16 +13377,16 @@ module Plaid
12778
13377
  form_params = opts[:form_params] || {}
12779
13378
 
12780
13379
  # http body (model)
12781
- post_body = opts[:debug_body] || @api_client.object_to_http_body(user_account_session_get_request)
13380
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_user_reset_login_request)
12782
13381
 
12783
13382
  # return_type
12784
- return_type = opts[:debug_return_type] || 'UserAccountSessionGetResponse'
13383
+ return_type = opts[:debug_return_type] || 'SandboxUserResetLoginResponse'
12785
13384
 
12786
13385
  # auth_names
12787
13386
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12788
13387
 
12789
13388
  new_options = opts.merge(
12790
- :operation => :"PlaidApi.session_get",
13389
+ :operation => :"PlaidApi.sandbox_user_reset_login",
12791
13390
  :header_params => header_params,
12792
13391
  :query_params => query_params,
12793
13392
  :form_params => form_params,
@@ -12798,7 +13397,7 @@ module Plaid
12798
13397
 
12799
13398
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12800
13399
  if @api_client.config.debugging
12801
- @api_client.config.logger.debug "API called: PlaidApi#session_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13400
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_user_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12802
13401
  end
12803
13402
  return data, status_code, headers
12804
13403
  end
@@ -13484,7 +14083,7 @@ module Plaid
13484
14083
  end
13485
14084
 
13486
14085
  # Fetch recurring transaction streams
13487
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [`days_requested`](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
14086
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
13488
14087
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
13489
14088
  # @param [Hash] opts the optional parameters
13490
14089
  # @return [TransactionsRecurringGetResponse]
@@ -13494,7 +14093,7 @@ module Plaid
13494
14093
  end
13495
14094
 
13496
14095
  # Fetch recurring transaction streams
13497
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
14096
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
13498
14097
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
13499
14098
  # @param [Hash] opts the optional parameters
13500
14099
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -14028,7 +14627,7 @@ module Plaid
14028
14627
  end
14029
14628
 
14030
14629
  # Create a transfer authorization
14031
- # 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.
14630
+ # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - 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 get an authorization decision of `user_action_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.
14032
14631
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
14033
14632
  # @param [Hash] opts the optional parameters
14034
14633
  # @return [TransferAuthorizationCreateResponse]
@@ -14038,7 +14637,7 @@ module Plaid
14038
14637
  end
14039
14638
 
14040
14639
  # Create a transfer authorization
14041
- # 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.
14640
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - 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 get an authorization decision of &#x60;user_action_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.
14042
14641
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
14043
14642
  # @param [Hash] opts the optional parameters
14044
14643
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -14368,7 +14967,7 @@ module Plaid
14368
14967
  end
14369
14968
 
14370
14969
  # Create a transfer
14371
- # Use the `/transfer/create` endpoint to initiate a new transfer.
14970
+ # Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
14372
14971
  # @param transfer_create_request [TransferCreateRequest]
14373
14972
  # @param [Hash] opts the optional parameters
14374
14973
  # @return [TransferCreateResponse]
@@ -14378,7 +14977,7 @@ module Plaid
14378
14977
  end
14379
14978
 
14380
14979
  # Create a transfer
14381
- # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer.
14980
+ # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided &#x60;transfer_id&#x60; has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
14382
14981
  # @param transfer_create_request [TransferCreateRequest]
14383
14982
  # @param [Hash] opts the optional parameters
14384
14983
  # @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
@@ -15320,7 +15919,7 @@ module Plaid
15320
15919
  end
15321
15920
 
15322
15921
  # Migrate account into Transfers
15323
- # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. If you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
15922
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
15324
15923
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
15325
15924
  # @param [Hash] opts the optional parameters
15326
15925
  # @return [TransferMigrateAccountResponse]
@@ -15330,7 +15929,7 @@ module Plaid
15330
15929
  end
15331
15930
 
15332
15931
  # Migrate account into Transfers
15333
- # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. If you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
15932
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
15334
15933
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
15335
15934
  # @param [Hash] opts the optional parameters
15336
15935
  # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
@@ -15659,6 +16258,74 @@ module Plaid
15659
16258
  return data, status_code, headers
15660
16259
  end
15661
16260
 
16261
+ # Create an originator for scaled platform customers
16262
+ # The `/transfer/platform/originator/create` endpoint allows gathering information about the originator specific to the Scaled Platform Transfer offering, including the originator's agreement to legal terms required before accepting any further information related to the originator.
16263
+ # @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
16264
+ # @param [Hash] opts the optional parameters
16265
+ # @return [TransferPlatformOriginatorCreateResponse]
16266
+ def transfer_platform_originator_create(transfer_platform_originator_create_request, opts = {})
16267
+ data, _status_code, _headers = transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts)
16268
+ data
16269
+ end
16270
+
16271
+ # Create an originator for scaled platform customers
16272
+ # The &#x60;/transfer/platform/originator/create&#x60; endpoint allows gathering information about the originator specific to the Scaled Platform Transfer offering, including the originator&#39;s agreement to legal terms required before accepting any further information related to the originator.
16273
+ # @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
16274
+ # @param [Hash] opts the optional parameters
16275
+ # @return [Array<(TransferPlatformOriginatorCreateResponse, Integer, Hash)>] TransferPlatformOriginatorCreateResponse data, response status code and response headers
16276
+ def transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts = {})
16277
+ if @api_client.config.debugging
16278
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_originator_create ...'
16279
+ end
16280
+ # verify the required parameter 'transfer_platform_originator_create_request' is set
16281
+ if @api_client.config.client_side_validation && transfer_platform_originator_create_request.nil?
16282
+ fail ArgumentError, "Missing the required parameter 'transfer_platform_originator_create_request' when calling PlaidApi.transfer_platform_originator_create"
16283
+ end
16284
+ # resource path
16285
+ local_var_path = '/transfer/platform/originator/create'
16286
+
16287
+ # query parameters
16288
+ query_params = opts[:query_params] || {}
16289
+
16290
+ # header parameters
16291
+ header_params = opts[:header_params] || {}
16292
+ # HTTP header 'Accept' (if needed)
16293
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16294
+ # HTTP header 'Content-Type'
16295
+ content_type = @api_client.select_header_content_type(['application/json'])
16296
+ if !content_type.nil?
16297
+ header_params['Content-Type'] = content_type
16298
+ end
16299
+
16300
+ # form parameters
16301
+ form_params = opts[:form_params] || {}
16302
+
16303
+ # http body (model)
16304
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_originator_create_request)
16305
+
16306
+ # return_type
16307
+ return_type = opts[:debug_return_type] || 'TransferPlatformOriginatorCreateResponse'
16308
+
16309
+ # auth_names
16310
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16311
+
16312
+ new_options = opts.merge(
16313
+ :operation => :"PlaidApi.transfer_platform_originator_create",
16314
+ :header_params => header_params,
16315
+ :query_params => query_params,
16316
+ :form_params => form_params,
16317
+ :body => post_body,
16318
+ :auth_names => auth_names,
16319
+ :return_type => return_type
16320
+ )
16321
+
16322
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16323
+ if @api_client.config.debugging
16324
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16325
+ end
16326
+ return data, status_code, headers
16327
+ end
16328
+
15662
16329
  # Generate a Plaid-hosted onboarding UI URL.
15663
16330
  # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
15664
16331
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
@@ -16475,8 +17142,76 @@ module Plaid
16475
17142
  return data, status_code, headers
16476
17143
  end
16477
17144
 
17145
+ # Retrieve User Account
17146
+ # Returns user permissioned account data including identity and Item access tokens.
17147
+ # @param user_account_session_get_request [UserAccountSessionGetRequest]
17148
+ # @param [Hash] opts the optional parameters
17149
+ # @return [UserAccountSessionGetResponse]
17150
+ def user_account_session_get(user_account_session_get_request, opts = {})
17151
+ data, _status_code, _headers = user_account_session_get_with_http_info(user_account_session_get_request, opts)
17152
+ data
17153
+ end
17154
+
17155
+ # Retrieve User Account
17156
+ # Returns user permissioned account data including identity and Item access tokens.
17157
+ # @param user_account_session_get_request [UserAccountSessionGetRequest]
17158
+ # @param [Hash] opts the optional parameters
17159
+ # @return [Array<(UserAccountSessionGetResponse, Integer, Hash)>] UserAccountSessionGetResponse data, response status code and response headers
17160
+ def user_account_session_get_with_http_info(user_account_session_get_request, opts = {})
17161
+ if @api_client.config.debugging
17162
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_account_session_get ...'
17163
+ end
17164
+ # verify the required parameter 'user_account_session_get_request' is set
17165
+ if @api_client.config.client_side_validation && user_account_session_get_request.nil?
17166
+ fail ArgumentError, "Missing the required parameter 'user_account_session_get_request' when calling PlaidApi.user_account_session_get"
17167
+ end
17168
+ # resource path
17169
+ local_var_path = '/user_account/session/get'
17170
+
17171
+ # query parameters
17172
+ query_params = opts[:query_params] || {}
17173
+
17174
+ # header parameters
17175
+ header_params = opts[:header_params] || {}
17176
+ # HTTP header 'Accept' (if needed)
17177
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17178
+ # HTTP header 'Content-Type'
17179
+ content_type = @api_client.select_header_content_type(['application/json'])
17180
+ if !content_type.nil?
17181
+ header_params['Content-Type'] = content_type
17182
+ end
17183
+
17184
+ # form parameters
17185
+ form_params = opts[:form_params] || {}
17186
+
17187
+ # http body (model)
17188
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_account_session_get_request)
17189
+
17190
+ # return_type
17191
+ return_type = opts[:debug_return_type] || 'UserAccountSessionGetResponse'
17192
+
17193
+ # auth_names
17194
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17195
+
17196
+ new_options = opts.merge(
17197
+ :operation => :"PlaidApi.user_account_session_get",
17198
+ :header_params => header_params,
17199
+ :query_params => query_params,
17200
+ :form_params => form_params,
17201
+ :body => post_body,
17202
+ :auth_names => auth_names,
17203
+ :return_type => return_type
17204
+ )
17205
+
17206
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17207
+ if @api_client.config.debugging
17208
+ @api_client.config.logger.debug "API called: PlaidApi#user_account_session_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17209
+ end
17210
+ return data, status_code, headers
17211
+ end
17212
+
16478
17213
  # Create user
16479
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
17214
+ # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
16480
17215
  # @param user_create_request [UserCreateRequest]
16481
17216
  # @param [Hash] opts the optional parameters
16482
17217
  # @return [UserCreateResponse]
@@ -16486,7 +17221,7 @@ module Plaid
16486
17221
  end
16487
17222
 
16488
17223
  # Create user
16489
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
17224
+ # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The &#x60;consumer_report_user_identity&#x60; object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
16490
17225
  # @param user_create_request [UserCreateRequest]
16491
17226
  # @param [Hash] opts the optional parameters
16492
17227
  # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
@@ -16543,8 +17278,144 @@ module Plaid
16543
17278
  return data, status_code, headers
16544
17279
  end
16545
17280
 
17281
+ # Get Items associated with a User
17282
+ # Returns Items associated with a User along with their corresponding statuses.
17283
+ # @param user_items_get_request [UserItemsGetRequest]
17284
+ # @param [Hash] opts the optional parameters
17285
+ # @return [UserItemsGetResponse]
17286
+ def user_items_get(user_items_get_request, opts = {})
17287
+ data, _status_code, _headers = user_items_get_with_http_info(user_items_get_request, opts)
17288
+ data
17289
+ end
17290
+
17291
+ # Get Items associated with a User
17292
+ # Returns Items associated with a User along with their corresponding statuses.
17293
+ # @param user_items_get_request [UserItemsGetRequest]
17294
+ # @param [Hash] opts the optional parameters
17295
+ # @return [Array<(UserItemsGetResponse, Integer, Hash)>] UserItemsGetResponse data, response status code and response headers
17296
+ def user_items_get_with_http_info(user_items_get_request, opts = {})
17297
+ if @api_client.config.debugging
17298
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_get ...'
17299
+ end
17300
+ # verify the required parameter 'user_items_get_request' is set
17301
+ if @api_client.config.client_side_validation && user_items_get_request.nil?
17302
+ fail ArgumentError, "Missing the required parameter 'user_items_get_request' when calling PlaidApi.user_items_get"
17303
+ end
17304
+ # resource path
17305
+ local_var_path = '/user/items/get'
17306
+
17307
+ # query parameters
17308
+ query_params = opts[:query_params] || {}
17309
+
17310
+ # header parameters
17311
+ header_params = opts[:header_params] || {}
17312
+ # HTTP header 'Accept' (if needed)
17313
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17314
+ # HTTP header 'Content-Type'
17315
+ content_type = @api_client.select_header_content_type(['application/json'])
17316
+ if !content_type.nil?
17317
+ header_params['Content-Type'] = content_type
17318
+ end
17319
+
17320
+ # form parameters
17321
+ form_params = opts[:form_params] || {}
17322
+
17323
+ # http body (model)
17324
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_get_request)
17325
+
17326
+ # return_type
17327
+ return_type = opts[:debug_return_type] || 'UserItemsGetResponse'
17328
+
17329
+ # auth_names
17330
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17331
+
17332
+ new_options = opts.merge(
17333
+ :operation => :"PlaidApi.user_items_get",
17334
+ :header_params => header_params,
17335
+ :query_params => query_params,
17336
+ :form_params => form_params,
17337
+ :body => post_body,
17338
+ :auth_names => auth_names,
17339
+ :return_type => return_type
17340
+ )
17341
+
17342
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17343
+ if @api_client.config.debugging
17344
+ @api_client.config.logger.debug "API called: PlaidApi#user_items_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17345
+ end
17346
+ return data, status_code, headers
17347
+ end
17348
+
17349
+ # Remove user
17350
+ # `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
17351
+ # @param user_remove_request [UserRemoveRequest]
17352
+ # @param [Hash] opts the optional parameters
17353
+ # @return [UserRemoveResponse]
17354
+ def user_remove(user_remove_request, opts = {})
17355
+ data, _status_code, _headers = user_remove_with_http_info(user_remove_request, opts)
17356
+ data
17357
+ end
17358
+
17359
+ # Remove user
17360
+ # &#x60;/user/remove&#x60; deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
17361
+ # @param user_remove_request [UserRemoveRequest]
17362
+ # @param [Hash] opts the optional parameters
17363
+ # @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
17364
+ def user_remove_with_http_info(user_remove_request, opts = {})
17365
+ if @api_client.config.debugging
17366
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_remove ...'
17367
+ end
17368
+ # verify the required parameter 'user_remove_request' is set
17369
+ if @api_client.config.client_side_validation && user_remove_request.nil?
17370
+ fail ArgumentError, "Missing the required parameter 'user_remove_request' when calling PlaidApi.user_remove"
17371
+ end
17372
+ # resource path
17373
+ local_var_path = '/user/remove'
17374
+
17375
+ # query parameters
17376
+ query_params = opts[:query_params] || {}
17377
+
17378
+ # header parameters
17379
+ header_params = opts[:header_params] || {}
17380
+ # HTTP header 'Accept' (if needed)
17381
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17382
+ # HTTP header 'Content-Type'
17383
+ content_type = @api_client.select_header_content_type(['application/json'])
17384
+ if !content_type.nil?
17385
+ header_params['Content-Type'] = content_type
17386
+ end
17387
+
17388
+ # form parameters
17389
+ form_params = opts[:form_params] || {}
17390
+
17391
+ # http body (model)
17392
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_remove_request)
17393
+
17394
+ # return_type
17395
+ return_type = opts[:debug_return_type] || 'UserRemoveResponse'
17396
+
17397
+ # auth_names
17398
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17399
+
17400
+ new_options = opts.merge(
17401
+ :operation => :"PlaidApi.user_remove",
17402
+ :header_params => header_params,
17403
+ :query_params => query_params,
17404
+ :form_params => form_params,
17405
+ :body => post_body,
17406
+ :auth_names => auth_names,
17407
+ :return_type => return_type
17408
+ )
17409
+
17410
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17411
+ if @api_client.config.debugging
17412
+ @api_client.config.logger.debug "API called: PlaidApi#user_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17413
+ end
17414
+ return data, status_code, headers
17415
+ end
17416
+
16546
17417
  # Update user information
16547
- # 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.
17418
+ # This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user.
16548
17419
  # @param user_update_request [UserUpdateRequest]
16549
17420
  # @param [Hash] opts the optional parameters
16550
17421
  # @return [UserUpdateResponse]
@@ -16554,7 +17425,7 @@ module Plaid
16554
17425
  end
16555
17426
 
16556
17427
  # Update user information
16557
- # 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.
17428
+ # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. It can also be used to enable an existing &#x60;user_token&#x60; for use with Consumer Reports by Plaid Check, by adding a &#x60;consumer_report_user_identity&#x60; object to the user.
16558
17429
  # @param user_update_request [UserUpdateRequest]
16559
17430
  # @param [Hash] opts the optional parameters
16560
17431
  # @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers