plaid 28.0.0 → 30.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1584) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +195 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/README.md +34 -30
  6. data/lib/plaid/api/plaid_api.rb +830 -82
  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 +12 -2
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +16 -6
  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 +40 -0
  17. data/lib/plaid/models/account_identity.rb +16 -18
  18. data/lib/plaid/models/account_identity_all_of.rb +5 -17
  19. data/lib/plaid/models/account_identity_document_upload.rb +13 -3
  20. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score.rb +13 -3
  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 +1 -1
  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 +30 -18
  35. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +47 -6
  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 +1 -1
  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 +39 -0
  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 +2 -3
  105. data/lib/plaid/models/auth_default_update_webhook.rb +336 -0
  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 +39 -0
  113. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  114. data/lib/plaid/models/balance_plus_attributes.rb +10 -10
  115. data/lib/plaid/models/balance_plus_risk_level.rb +42 -0
  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 +17 -2
  159. data/lib/plaid/models/base_report_account_balances.rb +1 -1
  160. data/lib/plaid/models/base_report_account_balances_all_of.rb +1 -1
  161. data/lib/plaid/models/base_report_account_insights.rb +3 -1
  162. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  163. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  164. data/lib/plaid/models/base_report_create_request.rb +1 -1
  165. data/lib/plaid/models/base_report_create_response.rb +1 -1
  166. data/lib/plaid/models/base_report_get_request.rb +1 -1
  167. data/lib/plaid/models/base_report_get_response.rb +1 -1
  168. data/lib/plaid/models/base_report_item.rb +17 -2
  169. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  170. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  171. data/lib/plaid/models/base_report_transaction.rb +32 -2
  172. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  173. data/lib/plaid/models/base_report_warning.rb +2 -2
  174. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  175. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  176. data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_attributes.rb +519 -0
  178. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  179. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  180. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  181. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  182. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  183. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  184. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  185. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  186. data/lib/plaid/models/beacon_bank_account_insights.rb +286 -0
  187. data/lib/plaid/models/beacon_bank_accounts.rb +242 -0
  188. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  189. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  190. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  191. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  192. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  193. data/lib/plaid/models/beacon_report.rb +1 -1
  194. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  195. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  196. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  197. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  198. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  199. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  200. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  202. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  205. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  206. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  207. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  208. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  209. data/lib/plaid/models/beacon_report_type.rb +1 -1
  210. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  211. data/lib/plaid/models/beacon_user.rb +25 -17
  212. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +261 -0
  213. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +285 -0
  214. data/lib/plaid/models/beacon_user_address.rb +1 -22
  215. data/lib/plaid/models/beacon_user_create_request.rb +15 -23
  216. data/lib/plaid/models/beacon_user_create_response.rb +25 -17
  217. data/lib/plaid/models/beacon_user_data.rb +1 -1
  218. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  219. data/lib/plaid/models/beacon_user_get_response.rb +25 -17
  220. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  221. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  222. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  223. data/lib/plaid/models/beacon_user_name.rb +1 -1
  224. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  225. data/lib/plaid/models/beacon_user_request_address.rb +1 -22
  226. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -22
  227. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  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 +16 -7
  233. data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
  234. data/lib/plaid/models/beacon_user_update_response.rb +25 -17
  235. data/lib/plaid/models/categories_get_response.rb +1 -1
  236. data/lib/plaid/models/category.rb +1 -1
  237. data/lib/plaid/models/category_insight_details.rb +1 -1
  238. data/lib/plaid/models/category_insights.rb +1 -1
  239. data/lib/plaid/models/cause.rb +1 -1
  240. data/lib/plaid/models/cause_all_of.rb +1 -1
  241. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  242. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  243. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  244. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  245. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  246. data/lib/plaid/models/connected_application.rb +1 -1
  247. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  248. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  249. data/lib/plaid/models/consumer_report_user_identity.rb +2 -2
  250. data/lib/plaid/models/counterparty.rb +1 -1
  251. data/lib/plaid/models/counterparty_insights.rb +1 -1
  252. data/lib/plaid/models/counterparty_type.rb +1 -1
  253. data/lib/plaid/models/country_code.rb +1 -1
  254. data/lib/plaid/models/cra_bank_income.rb +1 -1
  255. data/lib/plaid/models/cra_bank_income_account.rb +12 -2
  256. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  257. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  258. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  259. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  260. data/lib/plaid/models/cra_bank_income_create_request.rb +1 -1
  261. data/lib/plaid/models/cra_bank_income_create_response.rb +1 -1
  262. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  263. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  264. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  265. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  266. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  267. data/lib/plaid/models/cra_bank_income_item.rb +12 -2
  268. data/lib/plaid/models/cra_bank_income_source.rb +12 -2
  269. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  270. data/lib/plaid/models/cra_bank_income_transaction.rb +13 -3
  271. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  272. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  273. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +259 -0
  274. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +252 -0
  275. data/lib/plaid/models/cra_check_report_create_request.rb +345 -0
  276. data/lib/plaid/models/cra_check_report_create_response.rb +221 -0
  277. data/lib/plaid/models/cra_check_report_failed_webhook.rb +292 -0
  278. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +246 -0
  279. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +235 -0
  280. data/lib/plaid/models/cra_check_report_network_attributes_get_request.rb +246 -0
  281. data/lib/plaid/models/cra_check_report_network_attributes_get_response.rb +240 -0
  282. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +223 -0
  283. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +256 -0
  284. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +235 -0
  285. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +258 -0
  286. data/lib/plaid/models/cra_check_report_product.rb +41 -0
  287. data/lib/plaid/models/cra_check_report_ready_webhook.rb +305 -0
  288. data/lib/plaid/models/cra_income_insights.rb +274 -0
  289. data/lib/plaid/models/cra_loan_application.rb +1 -1
  290. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  291. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  292. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  293. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  294. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  295. data/lib/plaid/models/cra_loan_register.rb +1 -1
  296. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  297. data/lib/plaid/models/cra_loan_status.rb +1 -1
  298. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  299. data/lib/plaid/models/cra_loan_type.rb +1 -1
  300. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  301. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  302. data/lib/plaid/models/cra_loan_update.rb +1 -1
  303. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  304. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  305. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  306. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  307. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  308. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  309. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  310. data/lib/plaid/models/cra_network_attributes_item.rb +256 -0
  311. data/lib/plaid/models/cra_network_attributes_report.rb +273 -0
  312. data/lib/plaid/models/cra_partner_insights.rb +3 -3
  313. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  314. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  315. data/lib/plaid/models/cra_partner_insights_get_request.rb +6 -1
  316. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  317. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  318. data/lib/plaid/models/cra_partner_insights_item_account.rb +12 -2
  319. data/lib/plaid/models/cra_partner_insights_prism.rb +3 -3
  320. data/lib/plaid/models/cra_pdf_add_ons.rb +38 -0
  321. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  322. data/lib/plaid/models/credit1099.rb +1 -1
  323. data/lib/plaid/models/credit1099_filer.rb +1 -1
  324. data/lib/plaid/models/credit1099_payer.rb +1 -1
  325. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  326. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  327. data/lib/plaid/models/credit_ach_class.rb +1 -1
  328. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  329. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  330. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  331. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  332. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  333. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  334. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +2 -2
  335. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  336. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  337. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  338. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  339. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  340. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  341. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  342. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  343. data/lib/plaid/models/credit_bank_income.rb +1 -1
  344. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  345. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  346. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  347. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  348. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  349. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  350. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  351. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  352. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  353. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  354. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  355. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  356. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  357. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  358. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  359. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  360. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  361. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  362. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  363. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  364. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  365. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  366. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  367. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  368. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  369. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  370. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  371. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  372. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  373. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  374. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  375. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  376. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  377. data/lib/plaid/models/credit_card_liability.rb +1 -1
  378. data/lib/plaid/models/credit_category.rb +1 -1
  379. data/lib/plaid/models/credit_document_metadata.rb +18 -7
  380. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  381. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  382. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  383. data/lib/plaid/models/credit_employment_item.rb +1 -1
  384. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  385. data/lib/plaid/models/credit_filter.rb +1 -1
  386. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  387. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  388. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  389. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  390. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  391. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  392. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  393. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  394. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  395. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  396. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  397. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  398. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  399. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  400. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  401. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  402. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  403. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  404. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  405. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  406. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  407. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  408. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  409. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  410. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  411. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  412. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  413. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  414. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  415. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  416. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  417. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  418. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  419. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  420. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  421. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  422. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  423. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  424. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  425. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  426. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  427. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  428. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  429. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  430. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  431. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  432. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  433. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  434. data/lib/plaid/models/credit_session.rb +1 -1
  435. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  436. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  437. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  438. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  439. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  440. data/lib/plaid/models/credit_session_error.rb +1 -1
  441. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  442. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  443. data/lib/plaid/models/credit_session_results.rb +1 -1
  444. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  445. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  446. data/lib/plaid/models/credit_w2.rb +1 -1
  447. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  448. data/lib/plaid/models/dashboard_user.rb +1 -1
  449. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  450. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  451. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  452. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  453. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  454. data/lib/plaid/models/date_range.rb +1 -1
  455. data/lib/plaid/models/deductions.rb +1 -1
  456. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  457. data/lib/plaid/models/deductions_total.rb +1 -1
  458. data/lib/plaid/models/default_update_webhook.rb +1 -1
  459. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  460. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  461. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  462. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  463. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  464. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  465. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  466. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  467. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  468. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  469. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  470. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  471. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  472. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  473. data/lib/plaid/models/depository_filter.rb +1 -1
  474. data/lib/plaid/models/detailed_originator.rb +1 -1
  475. data/lib/plaid/models/detected_account.rb +1 -1
  476. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  477. data/lib/plaid/models/doc_type.rb +1 -1
  478. data/lib/plaid/models/document_analysis.rb +1 -1
  479. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  480. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  481. data/lib/plaid/models/document_metadata.rb +1 -1
  482. data/lib/plaid/models/document_name_match_code.rb +1 -1
  483. data/lib/plaid/models/document_risk_signal.rb +1 -1
  484. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  485. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  486. data/lib/plaid/models/document_risk_summary.rb +1 -1
  487. data/lib/plaid/models/document_status.rb +1 -1
  488. data/lib/plaid/models/documentary_verification.rb +1 -1
  489. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  490. data/lib/plaid/models/earnings.rb +1 -1
  491. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  492. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  493. data/lib/plaid/models/earnings_total.rb +1 -1
  494. data/lib/plaid/models/email.rb +1 -1
  495. data/lib/plaid/models/email_address_match_score.rb +1 -1
  496. data/lib/plaid/models/employee.rb +1 -1
  497. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  498. data/lib/plaid/models/employer.rb +1 -1
  499. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  500. data/lib/plaid/models/employer_verification.rb +1 -1
  501. data/lib/plaid/models/employers_search_request.rb +1 -1
  502. data/lib/plaid/models/employers_search_response.rb +1 -1
  503. data/lib/plaid/models/employment_details.rb +1 -1
  504. data/lib/plaid/models/employment_source_type.rb +1 -1
  505. data/lib/plaid/models/employment_verification.rb +1 -1
  506. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  507. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  508. data/lib/plaid/models/employment_verification_status.rb +1 -1
  509. data/lib/plaid/models/enhancements.rb +1 -1
  510. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  511. data/lib/plaid/models/enrichments.rb +1 -1
  512. data/lib/plaid/models/entity_document.rb +1 -22
  513. data/lib/plaid/models/entity_document_type.rb +1 -1
  514. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  515. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  516. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  517. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  518. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  519. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  520. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  521. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  522. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  523. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  524. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  525. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +12 -12
  526. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  527. data/lib/plaid/models/entity_watchlist_program.rb +1 -22
  528. data/lib/plaid/models/entity_watchlist_screening.rb +1 -18
  529. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -18
  530. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -18
  531. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -56
  532. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -56
  533. data/lib/plaid/models/expiration_date.rb +1 -1
  534. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  535. data/lib/plaid/models/external_payment_options.rb +1 -1
  536. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  537. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  538. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  539. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  540. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  541. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  542. data/lib/plaid/models/fdx_content_types.rb +1 -1
  543. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  544. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  545. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  546. data/lib/plaid/models/fdx_notification.rb +1 -1
  547. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  548. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  549. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  550. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  551. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  552. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  553. data/lib/plaid/models/fdx_party.rb +1 -1
  554. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  555. data/lib/plaid/models/fdx_party_type.rb +1 -1
  556. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  557. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  558. data/lib/plaid/models/form1099_type.rb +1 -1
  559. data/lib/plaid/models/fraud_amount.rb +1 -1
  560. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  561. data/lib/plaid/models/health_incident.rb +1 -1
  562. data/lib/plaid/models/historical_balance.rb +1 -1
  563. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  564. data/lib/plaid/models/holding.rb +1 -1
  565. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  566. data/lib/plaid/models/holdings_override.rb +1 -1
  567. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  568. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  569. data/lib/plaid/models/id_number_type.rb +1 -1
  570. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  571. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  572. data/lib/plaid/models/identity_document_upload.rb +1 -1
  573. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  574. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  575. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  576. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  577. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  578. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  579. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  580. data/lib/plaid/models/identity_get_request.rb +1 -1
  581. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  582. data/lib/plaid/models/identity_get_response.rb +1 -1
  583. data/lib/plaid/models/identity_match_request.rb +1 -1
  584. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  585. data/lib/plaid/models/identity_match_response.rb +1 -1
  586. data/lib/plaid/models/identity_match_user.rb +1 -1
  587. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  588. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  589. data/lib/plaid/models/identity_update_types.rb +1 -1
  590. data/lib/plaid/models/identity_verification.rb +1 -22
  591. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -22
  592. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  593. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  594. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  595. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  596. data/lib/plaid/models/identity_verification_create_request.rb +1 -18
  597. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -18
  598. data/lib/plaid/models/identity_verification_create_response.rb +1 -22
  599. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -22
  600. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  601. data/lib/plaid/models/identity_verification_get_response.rb +1 -22
  602. data/lib/plaid/models/identity_verification_list_request.rb +1 -22
  603. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  604. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  605. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  606. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  607. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  608. data/lib/plaid/models/identity_verification_retry_request.rb +1 -22
  609. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  610. data/lib/plaid/models/identity_verification_retry_response.rb +1 -22
  611. data/lib/plaid/models/identity_verification_status.rb +1 -1
  612. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  613. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  614. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  615. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  616. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  617. data/lib/plaid/models/identity_verification_user_address.rb +1 -22
  618. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  619. data/lib/plaid/models/image_quality.rb +1 -1
  620. data/lib/plaid/models/incident_update.rb +1 -1
  621. data/lib/plaid/models/income_breakdown.rb +1 -1
  622. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  623. data/lib/plaid/models/income_override.rb +1 -1
  624. data/lib/plaid/models/income_summary.rb +1 -1
  625. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  626. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  627. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  628. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  629. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  630. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  631. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  632. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  633. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  634. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  635. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  636. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  637. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  638. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  639. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  640. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  641. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  642. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  643. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  644. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  645. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  646. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  647. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  648. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  649. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  650. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  651. data/lib/plaid/models/individual_name.rb +1 -1
  652. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  653. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  654. data/lib/plaid/models/individual_watchlist_program.rb +1 -22
  655. data/lib/plaid/models/inflow_model.rb +1 -1
  656. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  657. data/lib/plaid/models/institution.rb +1 -1
  658. data/lib/plaid/models/institution_status.rb +1 -1
  659. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  660. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  661. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  662. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  663. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  664. data/lib/plaid/models/institutions_get_request.rb +1 -1
  665. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  666. data/lib/plaid/models/institutions_get_response.rb +1 -1
  667. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  668. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  669. data/lib/plaid/models/institutions_search_request.rb +1 -1
  670. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  671. data/lib/plaid/models/institutions_search_response.rb +1 -1
  672. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  673. data/lib/plaid/models/investment_filter.rb +1 -1
  674. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  675. data/lib/plaid/models/investment_transaction.rb +1 -1
  676. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  677. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  678. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  679. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  680. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  681. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  682. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  683. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  684. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  685. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  686. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  687. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  688. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  689. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  690. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  691. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  692. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  693. data/lib/plaid/models/iso_currency_code.rb +1 -1
  694. data/lib/plaid/models/issuing_country.rb +1 -1
  695. data/lib/plaid/models/item.rb +2 -2
  696. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  697. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  698. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  699. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  700. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  701. data/lib/plaid/models/item_application_list_request.rb +1 -1
  702. data/lib/plaid/models/item_application_list_response.rb +1 -1
  703. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  704. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  705. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  706. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  707. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  708. data/lib/plaid/models/item_error_webhook.rb +1 -1
  709. data/lib/plaid/models/item_get_request.rb +1 -1
  710. data/lib/plaid/models/item_get_response.rb +1 -1
  711. data/lib/plaid/models/item_import_request.rb +1 -1
  712. data/lib/plaid/models/item_import_request_options.rb +1 -1
  713. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  714. data/lib/plaid/models/item_import_response.rb +1 -1
  715. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  716. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  717. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  718. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  719. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  720. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  721. data/lib/plaid/models/item_remove_request.rb +1 -1
  722. data/lib/plaid/models/item_remove_response.rb +1 -1
  723. data/lib/plaid/models/item_status.rb +1 -1
  724. data/lib/plaid/models/item_status_investments.rb +1 -1
  725. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  726. data/lib/plaid/models/item_status_nullable.rb +1 -1
  727. data/lib/plaid/models/item_status_transactions.rb +1 -1
  728. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  729. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  730. data/lib/plaid/models/jwk_public_key.rb +1 -1
  731. data/lib/plaid/models/jwt_header.rb +1 -1
  732. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  733. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  734. data/lib/plaid/models/kyc_check_details.rb +1 -1
  735. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  736. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  737. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  738. data/lib/plaid/models/last_data_access_times.rb +1 -1
  739. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  740. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  741. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  742. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  743. data/lib/plaid/models/liabilities_object.rb +1 -1
  744. data/lib/plaid/models/liability_override.rb +2 -2
  745. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  746. data/lib/plaid/models/link_delivery_account.rb +1 -1
  747. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  748. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  749. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  750. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  751. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  752. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  753. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  754. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  755. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  756. data/lib/plaid/models/link_delivery_options.rb +1 -1
  757. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  758. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  759. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  760. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  761. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  762. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  763. data/lib/plaid/models/link_event.rb +1 -1
  764. data/lib/plaid/models/link_event_metadata.rb +2 -2
  765. data/lib/plaid/models/link_event_name.rb +1 -1
  766. data/lib/plaid/models/link_events_webhook.rb +5 -5
  767. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  768. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  769. data/lib/plaid/models/link_profile_eligibility_check_request.rb +1 -1
  770. data/lib/plaid/models/link_profile_eligibility_check_response.rb +1 -1
  771. data/lib/plaid/models/link_profile_eligibility_check_user.rb +1 -1
  772. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  773. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  774. data/lib/plaid/models/link_session_exit.rb +1 -1
  775. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  776. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  777. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  778. data/lib/plaid/models/link_session_finished_webhook.rb +3 -3
  779. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  780. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  781. data/lib/plaid/models/link_session_results.rb +1 -1
  782. data/lib/plaid/models/link_session_success.rb +1 -1
  783. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  784. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  785. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  786. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  787. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  788. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  789. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  790. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  791. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  792. data/lib/plaid/models/link_token_create_identity.rb +17 -5
  793. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  794. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  795. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  796. data/lib/plaid/models/link_token_create_request.rb +15 -6
  797. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  798. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  799. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  800. data/lib/plaid/models/link_token_create_request_cra_options.rb +274 -0
  801. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +222 -0
  802. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +223 -0
  803. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +2 -2
  804. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  805. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  806. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  807. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  808. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  809. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  810. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  811. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  812. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  813. data/lib/plaid/models/link_token_create_request_transfer.rb +12 -2
  814. data/lib/plaid/models/link_token_create_request_update.rb +18 -6
  815. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  816. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -22
  817. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  818. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  819. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  820. data/lib/plaid/models/link_token_create_response.rb +1 -1
  821. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  822. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  823. data/lib/plaid/models/link_token_get_request.rb +1 -1
  824. data/lib/plaid/models/link_token_get_response.rb +2 -2
  825. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  826. data/lib/plaid/models/link_token_investments.rb +1 -1
  827. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  828. data/lib/plaid/models/link_token_transactions.rb +1 -1
  829. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  830. data/lib/plaid/models/loan.rb +1 -1
  831. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  832. data/lib/plaid/models/loan_filter.rb +1 -1
  833. data/lib/plaid/models/loan_identifier.rb +1 -1
  834. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  835. data/lib/plaid/models/loan_identifiers.rb +1 -1
  836. data/lib/plaid/models/loans.rb +1 -1
  837. data/lib/plaid/models/location.rb +1 -1
  838. data/lib/plaid/models/match_summary.rb +1 -1
  839. data/lib/plaid/models/match_summary_code.rb +1 -1
  840. data/lib/plaid/models/merchant_insights.rb +1 -1
  841. data/lib/plaid/models/meta.rb +1 -1
  842. data/lib/plaid/models/mfa.rb +1 -1
  843. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  844. data/lib/plaid/models/mortgage_liability.rb +1 -1
  845. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  846. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  847. data/lib/plaid/models/name_match_score.rb +1 -1
  848. data/lib/plaid/models/net_pay.rb +1 -1
  849. data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
  850. data/lib/plaid/models/numbers.rb +2 -2
  851. data/lib/plaid/models/numbers_acats.rb +1 -1
  852. data/lib/plaid/models/numbers_ach.rb +1 -1
  853. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  854. data/lib/plaid/models/numbers_aton.rb +1 -1
  855. data/lib/plaid/models/numbers_bacs.rb +1 -1
  856. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  857. data/lib/plaid/models/numbers_eft.rb +1 -1
  858. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  859. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  860. data/lib/plaid/models/numbers_international.rb +1 -1
  861. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  862. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  863. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  864. data/lib/plaid/models/option_contract.rb +1 -1
  865. data/lib/plaid/models/originator.rb +1 -1
  866. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  867. data/lib/plaid/models/other_account_subtype.rb +1 -1
  868. data/lib/plaid/models/other_filter.rb +1 -1
  869. data/lib/plaid/models/override_account_type.rb +1 -1
  870. data/lib/plaid/models/override_accounts.rb +1 -1
  871. data/lib/plaid/models/owner.rb +5 -16
  872. data/lib/plaid/models/owner_override.rb +1 -1
  873. data/lib/plaid/models/ownership_type.rb +1 -1
  874. data/lib/plaid/models/parties.rb +1 -1
  875. data/lib/plaid/models/partner_customer_create_request.rb +2 -2
  876. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  877. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  878. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  879. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  880. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  881. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  882. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  883. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  884. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  885. data/lib/plaid/models/partner_end_customer.rb +1 -1
  886. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  887. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  888. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  889. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  890. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  891. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  892. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  893. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  894. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  895. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  896. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  897. data/lib/plaid/models/partner_end_customer_secrets.rb +17 -7
  898. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  899. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  900. data/lib/plaid/models/partner_end_customer_with_secrets.rb +2 -2
  901. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  902. data/lib/plaid/models/party.rb +1 -1
  903. data/lib/plaid/models/party_individual.rb +1 -1
  904. data/lib/plaid/models/party_role_type.rb +1 -1
  905. data/lib/plaid/models/pay.rb +1 -1
  906. data/lib/plaid/models/pay_frequency.rb +1 -1
  907. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  908. data/lib/plaid/models/pay_period_details.rb +1 -1
  909. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  910. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  911. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  912. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  913. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  914. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  915. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  916. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  917. data/lib/plaid/models/payment_amount.rb +1 -1
  918. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  919. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  920. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  921. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  922. data/lib/plaid/models/payment_channel.rb +1 -1
  923. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  924. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  925. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  926. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  927. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  928. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  929. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  930. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  931. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  932. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  933. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  934. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  935. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  936. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
  937. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  938. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  939. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  940. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  941. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  942. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  943. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  944. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  945. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  946. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  947. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  948. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  949. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  950. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  951. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  952. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  953. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  954. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  955. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  956. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  957. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  958. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  959. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  960. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  961. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  962. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  963. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  964. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  965. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  966. data/lib/plaid/models/payment_meta.rb +1 -1
  967. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  968. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  969. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  970. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  971. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  972. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  973. data/lib/plaid/models/payment_profile_status.rb +1 -1
  974. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  975. data/lib/plaid/models/payment_scheme.rb +1 -1
  976. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  977. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  978. data/lib/plaid/models/payroll_income_object.rb +1 -1
  979. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  980. data/lib/plaid/models/payroll_item.rb +1 -1
  981. data/lib/plaid/models/payroll_item_status.rb +1 -1
  982. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  983. data/lib/plaid/models/paystub.rb +1 -1
  984. data/lib/plaid/models/paystub_address.rb +1 -1
  985. data/lib/plaid/models/paystub_deduction.rb +1 -1
  986. data/lib/plaid/models/paystub_details.rb +1 -1
  987. data/lib/plaid/models/paystub_employer.rb +1 -1
  988. data/lib/plaid/models/paystub_override.rb +1 -1
  989. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  990. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  991. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  992. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  993. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  994. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  995. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  996. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  997. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  998. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  999. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1000. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1001. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1002. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1003. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1004. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1005. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1006. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1007. data/lib/plaid/models/phone_number.rb +1 -1
  1008. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1009. data/lib/plaid/models/phone_type.rb +1 -1
  1010. data/lib/plaid/models/physical_document_category.rb +1 -1
  1011. data/lib/plaid/models/physical_document_extracted_data.rb +1 -22
  1012. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1013. data/lib/plaid/models/physical_document_images.rb +1 -1
  1014. data/lib/plaid/models/plaid_error.rb +1 -1
  1015. data/lib/plaid/models/plaid_error_type.rb +1 -1
  1016. data/lib/plaid/models/platform_ids.rb +1 -1
  1017. data/lib/plaid/models/po_box_status.rb +1 -1
  1018. data/lib/plaid/models/prism_cash_score.rb +4 -4
  1019. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1020. data/lib/plaid/models/prism_first_detect.rb +5 -5
  1021. data/lib/plaid/models/prism_insights.rb +3 -3
  1022. data/lib/plaid/models/prism_product.rb +2 -2
  1023. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1024. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1025. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1026. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1027. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1028. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1029. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1030. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1031. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1032. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1033. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1034. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1035. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1036. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1037. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1038. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1039. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1040. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1041. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1042. data/lib/plaid/models/processor_number.rb +1 -1
  1043. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1044. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1045. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1046. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1047. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1048. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1049. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1050. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1051. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1052. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1053. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1054. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1055. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1056. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1057. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1058. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1059. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1060. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1061. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1062. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1063. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1064. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1065. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1066. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1067. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1068. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1069. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1070. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1071. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1072. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1073. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1074. data/lib/plaid/models/product_access.rb +1 -1
  1075. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1076. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1077. data/lib/plaid/models/product_status.rb +1 -1
  1078. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1079. data/lib/plaid/models/products.rb +7 -1
  1080. data/lib/plaid/models/profile_get_request.rb +1 -11
  1081. data/lib/plaid/models/profile_get_response.rb +1 -1
  1082. data/lib/plaid/models/profile_identity.rb +1 -1
  1083. data/lib/plaid/models/profile_identity_address.rb +1 -1
  1084. data/lib/plaid/models/profile_identity_name.rb +1 -1
  1085. data/lib/plaid/models/profile_item.rb +1 -1
  1086. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1087. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1088. data/lib/plaid/models/proxy_type.rb +1 -1
  1089. data/lib/plaid/models/pslf_status.rb +1 -1
  1090. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1091. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1092. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1093. data/lib/plaid/models/recurrence.rb +1 -1
  1094. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1095. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1096. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1097. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1098. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1099. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1100. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1101. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1102. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1103. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1104. data/lib/plaid/models/removed_transaction.rb +1 -1
  1105. data/lib/plaid/models/report_type.rb +1 -1
  1106. data/lib/plaid/models/reporting_information.rb +1 -1
  1107. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1108. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1109. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1110. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1111. data/lib/plaid/models/risk_check_details.rb +1 -1
  1112. data/lib/plaid/models/risk_check_device.rb +1 -1
  1113. data/lib/plaid/models/risk_check_email.rb +1 -1
  1114. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1115. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1116. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1117. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1118. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1119. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1120. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1121. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1122. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1123. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1124. data/lib/plaid/models/risk_profile.rb +2 -2
  1125. data/lib/plaid/models/risk_reason.rb +13 -3
  1126. data/lib/plaid/models/risk_signal_document_reference.rb +15 -5
  1127. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1128. data/lib/plaid/models/risk_signal_document_type.rb +49 -0
  1129. data/lib/plaid/models/role.rb +1 -1
  1130. data/lib/plaid/models/role_detail.rb +1 -1
  1131. data/lib/plaid/models/roles.rb +1 -1
  1132. data/lib/plaid/models/ruleset.rb +231 -0
  1133. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1134. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1135. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1136. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1137. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1138. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1139. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1140. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1141. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1142. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1143. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1144. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  1145. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1146. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1147. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1148. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1149. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1150. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1151. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1152. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1153. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1154. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1155. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1156. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1157. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1158. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1159. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1160. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1161. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1162. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1163. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1164. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1165. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1166. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1167. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  1168. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1169. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1170. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1171. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1172. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1173. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1174. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1175. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1176. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1177. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1178. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1179. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1180. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1181. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1182. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1183. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1184. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1185. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1186. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1187. data/lib/plaid/models/sandbox_user_reset_login_request.rb +259 -0
  1188. data/lib/plaid/models/sandbox_user_reset_login_response.rb +226 -0
  1189. data/lib/plaid/models/scopes.rb +1 -1
  1190. data/lib/plaid/models/scopes_context.rb +1 -1
  1191. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1192. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1193. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1194. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1195. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1196. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1197. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1198. data/lib/plaid/models/security.rb +1 -1
  1199. data/lib/plaid/models/security_override.rb +1 -1
  1200. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1201. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1202. data/lib/plaid/models/selfie_capture.rb +1 -1
  1203. data/lib/plaid/models/selfie_check.rb +1 -1
  1204. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1205. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1206. data/lib/plaid/models/selfie_status.rb +1 -1
  1207. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1208. data/lib/plaid/models/service.rb +1 -1
  1209. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1210. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1211. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1212. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1213. data/lib/plaid/models/services.rb +1 -1
  1214. data/lib/plaid/models/signal_address_data.rb +1 -1
  1215. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1216. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1217. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1218. data/lib/plaid/models/signal_device.rb +1 -1
  1219. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1220. data/lib/plaid/models/signal_evaluate_request.rb +44 -7
  1221. data/lib/plaid/models/signal_evaluate_response.rb +12 -2
  1222. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1223. data/lib/plaid/models/signal_person_name.rb +1 -1
  1224. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1225. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1226. data/lib/plaid/models/signal_return_report_request.rb +2 -2
  1227. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1228. data/lib/plaid/models/signal_scores.rb +1 -1
  1229. data/lib/plaid/models/signal_user.rb +1 -1
  1230. data/lib/plaid/models/signal_warning.rb +1 -1
  1231. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1232. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1233. data/lib/plaid/models/source.rb +1 -1
  1234. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1235. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1236. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1237. data/lib/plaid/models/statements_account.rb +1 -1
  1238. data/lib/plaid/models/statements_download_request.rb +1 -1
  1239. data/lib/plaid/models/statements_list_request.rb +1 -1
  1240. data/lib/plaid/models/statements_list_response.rb +1 -1
  1241. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1242. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1243. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1244. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1245. data/lib/plaid/models/statements_statement.rb +1 -1
  1246. data/lib/plaid/models/status.rb +1 -1
  1247. data/lib/plaid/models/statuses.rb +1 -1
  1248. data/lib/plaid/models/strategy.rb +1 -1
  1249. data/lib/plaid/models/student_loan.rb +1 -1
  1250. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1251. data/lib/plaid/models/student_loan_status.rb +1 -1
  1252. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  1253. data/lib/plaid/models/sweep_status.rb +1 -1
  1254. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1255. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1256. data/lib/plaid/models/taxform.rb +1 -1
  1257. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1258. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1259. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1260. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1261. data/lib/plaid/models/total.rb +1 -1
  1262. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1263. data/lib/plaid/models/transaction.rb +2 -2
  1264. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1265. data/lib/plaid/models/transaction_base.rb +2 -2
  1266. data/lib/plaid/models/transaction_code.rb +1 -1
  1267. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1268. data/lib/plaid/models/transaction_data.rb +1 -1
  1269. data/lib/plaid/models/transaction_override.rb +1 -1
  1270. data/lib/plaid/models/transaction_stream.rb +1 -1
  1271. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1272. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1273. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1274. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1275. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1276. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1277. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1278. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1279. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1280. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  1281. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1282. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1283. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1284. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1285. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1286. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1287. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1288. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1289. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1290. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1291. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1292. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1293. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1294. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1295. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1296. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1297. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1298. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1299. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1300. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1301. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1302. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1303. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1304. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1305. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1306. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1307. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  1308. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1309. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1310. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1311. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1312. data/lib/plaid/models/transfer.rb +1 -1
  1313. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1314. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1315. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1316. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1317. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  1318. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1319. data/lib/plaid/models/transfer_authorization_decision.rb +2 -1
  1320. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1321. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1322. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1323. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1324. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1325. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1326. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1327. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1328. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1329. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1330. data/lib/plaid/models/transfer_balance.rb +1 -1
  1331. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1332. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1333. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1334. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1335. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1336. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1337. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1338. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1339. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1340. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1341. data/lib/plaid/models/transfer_create_request.rb +1 -1
  1342. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1343. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1344. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1345. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1346. data/lib/plaid/models/transfer_device.rb +1 -1
  1347. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1348. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1349. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1350. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1351. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1352. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1353. data/lib/plaid/models/transfer_event.rb +1 -1
  1354. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1355. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1356. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1357. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1358. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1359. data/lib/plaid/models/transfer_event_type.rb +9 -1
  1360. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1361. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1362. data/lib/plaid/models/transfer_failure.rb +1 -1
  1363. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1364. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1365. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1366. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1367. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1368. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1369. data/lib/plaid/models/transfer_intent_create_network.rb +2 -1
  1370. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1371. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1372. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1373. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1374. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1375. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1376. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1377. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1378. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  1379. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1380. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1381. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1382. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1383. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1384. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1385. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  1386. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1387. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1388. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1389. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1390. data/lib/plaid/models/transfer_metrics_get_response.rb +15 -5
  1391. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +221 -0
  1392. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +241 -0
  1393. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1394. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1395. data/lib/plaid/models/transfer_network.rb +1 -1
  1396. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1397. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1398. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1399. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1400. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1401. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1402. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1403. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1404. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1405. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1406. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1407. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1408. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1409. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1410. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1411. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1412. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1413. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1414. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1415. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1416. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1417. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1418. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1419. data/lib/plaid/models/transfer_refund.rb +1 -1
  1420. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1421. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1422. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1423. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1424. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1425. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1426. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1427. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1428. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1429. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1430. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1431. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1432. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1433. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1434. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1435. data/lib/plaid/models/transfer_status.rb +1 -1
  1436. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1437. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1438. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1439. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1440. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1441. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1442. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1443. data/lib/plaid/models/transfer_type.rb +1 -1
  1444. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1445. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1446. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1447. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1448. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1449. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1450. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -52
  1451. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -52
  1452. data/lib/plaid/models/user_account_identity.rb +285 -0
  1453. data/lib/plaid/models/user_account_identity_address.rb +277 -0
  1454. data/lib/plaid/models/{identity_document.rb → user_account_identity_name.rb} +18 -18
  1455. data/lib/plaid/models/user_account_item.rb +231 -0
  1456. data/lib/plaid/models/user_account_revoked_webhook.rb +2 -2
  1457. data/lib/plaid/models/user_account_session_get_request.rb +246 -0
  1458. data/lib/plaid/models/user_account_session_get_response.rb +252 -0
  1459. data/lib/plaid/models/user_address.rb +1 -22
  1460. data/lib/plaid/models/user_create_request.rb +1 -1
  1461. data/lib/plaid/models/user_create_response.rb +1 -1
  1462. data/lib/plaid/models/user_custom_password.rb +1 -1
  1463. data/lib/plaid/models/user_data_overview.rb +1 -1
  1464. data/lib/plaid/models/user_id_number.rb +1 -1
  1465. data/lib/plaid/models/user_items_get_request.rb +246 -0
  1466. data/lib/plaid/models/user_items_get_response.rb +242 -0
  1467. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1468. data/lib/plaid/models/user_remove_request.rb +246 -0
  1469. data/lib/plaid/models/user_remove_response.rb +226 -0
  1470. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1471. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1472. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1473. data/lib/plaid/models/user_update_request.rb +1 -1
  1474. data/lib/plaid/models/user_update_response.rb +1 -1
  1475. data/lib/plaid/models/validation_source.rb +1 -1
  1476. data/lib/plaid/models/validation_sources.rb +1 -1
  1477. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1478. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1479. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1480. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1481. data/lib/plaid/models/verification_status.rb +1 -1
  1482. data/lib/plaid/models/w2.rb +1 -1
  1483. data/lib/plaid/models/w2_box12.rb +1 -1
  1484. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1485. data/lib/plaid/models/w2_override.rb +1 -1
  1486. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1487. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1488. data/lib/plaid/models/wallet.rb +1 -1
  1489. data/lib/plaid/models/wallet_balance.rb +1 -1
  1490. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1491. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1492. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1493. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1494. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1495. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1496. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1497. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1498. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1499. data/lib/plaid/models/wallet_status.rb +1 -1
  1500. data/lib/plaid/models/wallet_transaction.rb +4 -4
  1501. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1502. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1503. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1504. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1505. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1506. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1507. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1508. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1509. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1510. data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
  1511. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1512. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1513. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1514. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1515. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1516. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1517. data/lib/plaid/models/warning.rb +1 -1
  1518. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1519. data/lib/plaid/models/watchlist_screening_document.rb +1 -22
  1520. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1521. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -18
  1522. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -18
  1523. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1524. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -18
  1525. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1526. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1527. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1528. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1529. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -18
  1530. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1531. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1532. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -22
  1533. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1534. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1535. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -18
  1536. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -18
  1537. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1538. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1539. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -18
  1540. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1541. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -18
  1542. data/lib/plaid/models/watchlist_screening_hit.rb +1 -18
  1543. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -22
  1544. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1545. data/lib/plaid/models/watchlist_screening_individual.rb +1 -18
  1546. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -18
  1547. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -18
  1548. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1549. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -18
  1550. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1551. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1552. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1553. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1554. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -18
  1555. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1556. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1557. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -22
  1558. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1559. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1560. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -18
  1561. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -18
  1562. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1563. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1564. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -18
  1565. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1566. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -18
  1567. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -56
  1568. data/lib/plaid/models/watchlist_screening_review.rb +1 -18
  1569. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -56
  1570. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1571. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1572. data/lib/plaid/models/webhook_environment_values.rb +1 -2
  1573. data/lib/plaid/models/webhook_type.rb +1 -1
  1574. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1575. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1576. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1577. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1578. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1579. data/lib/plaid/version.rb +2 -2
  1580. data/lib/plaid.rb +49 -2
  1581. data/plaid.gemspec +1 -1
  1582. data/templates/ruby/configuration.mustache +3 -2
  1583. data/test/test_configuration.rb +7 -6
  1584. metadata +50 -3
@@ -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.517.0
6
+ The version of the OpenAPI document: 2020-09-14_1.534.3
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -2195,6 +2195,74 @@ module Plaid
2195
2195
  return data, status_code, headers
2196
2196
  end
2197
2197
 
2198
+ # Get Account Insights for a Beacon User
2199
+ # 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.
2200
+ # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2201
+ # @param [Hash] opts the optional parameters
2202
+ # @return [BeaconUserAccountInsightsGetResponse]
2203
+ def beacon_user_account_insights_get(beacon_user_account_insights_get_request, opts = {})
2204
+ data, _status_code, _headers = beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts)
2205
+ data
2206
+ end
2207
+
2208
+ # Get Account Insights for a Beacon User
2209
+ # 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.
2210
+ # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2211
+ # @param [Hash] opts the optional parameters
2212
+ # @return [Array<(BeaconUserAccountInsightsGetResponse, Integer, Hash)>] BeaconUserAccountInsightsGetResponse data, response status code and response headers
2213
+ def beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts = {})
2214
+ if @api_client.config.debugging
2215
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_account_insights_get ...'
2216
+ end
2217
+ # verify the required parameter 'beacon_user_account_insights_get_request' is set
2218
+ if @api_client.config.client_side_validation && beacon_user_account_insights_get_request.nil?
2219
+ fail ArgumentError, "Missing the required parameter 'beacon_user_account_insights_get_request' when calling PlaidApi.beacon_user_account_insights_get"
2220
+ end
2221
+ # resource path
2222
+ local_var_path = '/beacon/user/account_insights/get'
2223
+
2224
+ # query parameters
2225
+ query_params = opts[:query_params] || {}
2226
+
2227
+ # header parameters
2228
+ header_params = opts[:header_params] || {}
2229
+ # HTTP header 'Accept' (if needed)
2230
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2231
+ # HTTP header 'Content-Type'
2232
+ content_type = @api_client.select_header_content_type(['application/json'])
2233
+ if !content_type.nil?
2234
+ header_params['Content-Type'] = content_type
2235
+ end
2236
+
2237
+ # form parameters
2238
+ form_params = opts[:form_params] || {}
2239
+
2240
+ # http body (model)
2241
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_account_insights_get_request)
2242
+
2243
+ # return_type
2244
+ return_type = opts[:debug_return_type] || 'BeaconUserAccountInsightsGetResponse'
2245
+
2246
+ # auth_names
2247
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2248
+
2249
+ new_options = opts.merge(
2250
+ :operation => :"PlaidApi.beacon_user_account_insights_get",
2251
+ :header_params => header_params,
2252
+ :query_params => query_params,
2253
+ :form_params => form_params,
2254
+ :body => post_body,
2255
+ :auth_names => auth_names,
2256
+ :return_type => return_type
2257
+ )
2258
+
2259
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2260
+ if @api_client.config.debugging
2261
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_user_account_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2262
+ end
2263
+ return data, status_code, headers
2264
+ end
2265
+
2198
2266
  # Create a Beacon User
2199
2267
  # 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
2268
  # @param beacon_user_create_request [BeaconUserCreateRequest]
@@ -2468,7 +2536,7 @@ module Plaid
2468
2536
  end
2469
2537
 
2470
2538
  # 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.
2539
+ # 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
2540
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2473
2541
  # @param [Hash] opts the optional parameters
2474
2542
  # @return [BeaconUserUpdateResponse]
@@ -2478,7 +2546,7 @@ module Plaid
2478
2546
  end
2479
2547
 
2480
2548
  # 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.
2549
+ # 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
2550
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2483
2551
  # @param [Hash] opts the optional parameters
2484
2552
  # @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
@@ -2607,27 +2675,435 @@ module Plaid
2607
2675
  # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
2608
2676
  # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2609
2677
  # @param [Hash] opts the optional parameters
2610
- # @return [File]
2611
- def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
2612
- data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
2678
+ # @return [File]
2679
+ def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
2680
+ data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
2681
+ data
2682
+ end
2683
+
2684
+ # Retrieve a PDF Reports
2685
+ # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2686
+ # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2687
+ # @param [Hash] opts the optional parameters
2688
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
2689
+ def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
2690
+ if @api_client.config.debugging
2691
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
2692
+ end
2693
+ # verify the required parameter 'consumer_report_pdf_get_request' is set
2694
+ if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
2695
+ fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
2696
+ end
2697
+ # resource path
2698
+ local_var_path = '/consumer_report/pdf/get'
2699
+
2700
+ # query parameters
2701
+ query_params = opts[:query_params] || {}
2702
+
2703
+ # header parameters
2704
+ header_params = opts[:header_params] || {}
2705
+ # HTTP header 'Accept' (if needed)
2706
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
2707
+ # HTTP header 'Content-Type'
2708
+ content_type = @api_client.select_header_content_type(['application/json'])
2709
+ if !content_type.nil?
2710
+ header_params['Content-Type'] = content_type
2711
+ end
2712
+
2713
+ # form parameters
2714
+ form_params = opts[:form_params] || {}
2715
+
2716
+ # http body (model)
2717
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)
2718
+
2719
+ # return_type
2720
+ return_type = opts[:debug_return_type] || 'File'
2721
+
2722
+ # auth_names
2723
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2724
+
2725
+ new_options = opts.merge(
2726
+ :operation => :"PlaidApi.consumer_report_pdf_get",
2727
+ :header_params => header_params,
2728
+ :query_params => query_params,
2729
+ :form_params => form_params,
2730
+ :body => post_body,
2731
+ :auth_names => auth_names,
2732
+ :return_type => return_type
2733
+ )
2734
+
2735
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2736
+ if @api_client.config.debugging
2737
+ @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2738
+ end
2739
+ return data, status_code, headers
2740
+ end
2741
+
2742
+ # Create a CRA report for income verification
2743
+ # `/cra/bank_income/create` creates a CRA report for income verification
2744
+ # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
2745
+ # @param [Hash] opts the optional parameters
2746
+ # @return [CraBankIncomeCreateResponse]
2747
+ def cra_bank_income_create(cra_bank_income_create_request, opts = {})
2748
+ data, _status_code, _headers = cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts)
2749
+ data
2750
+ end
2751
+
2752
+ # Create a CRA report for income verification
2753
+ # &#x60;/cra/bank_income/create&#x60; creates a CRA report for income verification
2754
+ # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
2755
+ # @param [Hash] opts the optional parameters
2756
+ # @return [Array<(CraBankIncomeCreateResponse, Integer, Hash)>] CraBankIncomeCreateResponse data, response status code and response headers
2757
+ def cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts = {})
2758
+ if @api_client.config.debugging
2759
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_create ...'
2760
+ end
2761
+ # verify the required parameter 'cra_bank_income_create_request' is set
2762
+ if @api_client.config.client_side_validation && cra_bank_income_create_request.nil?
2763
+ fail ArgumentError, "Missing the required parameter 'cra_bank_income_create_request' when calling PlaidApi.cra_bank_income_create"
2764
+ end
2765
+ # resource path
2766
+ local_var_path = '/cra/bank_income/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_bank_income_create_request)
2786
+
2787
+ # return_type
2788
+ return_type = opts[:debug_return_type] || 'CraBankIncomeCreateResponse'
2789
+
2790
+ # auth_names
2791
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2792
+
2793
+ new_options = opts.merge(
2794
+ :operation => :"PlaidApi.cra_bank_income_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_bank_income_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2806
+ end
2807
+ return data, status_code, headers
2808
+ end
2809
+
2810
+ # Retrieve information from the bank accounts used for income verification
2811
+ # `/cra/bank_income/get` returns the bank income report(s) for a specified user.
2812
+ # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
2813
+ # @param [Hash] opts the optional parameters
2814
+ # @return [CraBankIncomeGetResponse]
2815
+ def cra_bank_income_get(cra_bank_income_get_request, opts = {})
2816
+ data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
2817
+ data
2818
+ end
2819
+
2820
+ # Retrieve information from the bank accounts used for income verification
2821
+ # &#x60;/cra/bank_income/get&#x60; returns the bank income report(s) for a specified user.
2822
+ # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
2823
+ # @param [Hash] opts the optional parameters
2824
+ # @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
2825
+ def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
2826
+ if @api_client.config.debugging
2827
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
2828
+ end
2829
+ # verify the required parameter 'cra_bank_income_get_request' is set
2830
+ if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
2831
+ fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
2832
+ end
2833
+ # resource path
2834
+ local_var_path = '/cra/bank_income/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_bank_income_get_request)
2854
+
2855
+ # return_type
2856
+ return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
2857
+
2858
+ # auth_names
2859
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2860
+
2861
+ new_options = opts.merge(
2862
+ :operation => :"PlaidApi.cra_bank_income_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_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2874
+ end
2875
+ return data, status_code, headers
2876
+ end
2877
+
2878
+ # Retrieve a Base Report
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`.
2880
+ # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2881
+ # @param [Hash] opts the optional parameters
2882
+ # @return [CraCheckReportBaseReportGetResponse]
2883
+ def cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {})
2884
+ data, _status_code, _headers = cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts)
2885
+ data
2886
+ end
2887
+
2888
+ # Retrieve a Base Report
2889
+ # 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&#39;ve received a &#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&#39;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;.
2890
+ # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2891
+ # @param [Hash] opts the optional parameters
2892
+ # @return [Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>] CraCheckReportBaseReportGetResponse data, response status code and response headers
2893
+ def cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {})
2894
+ if @api_client.config.debugging
2895
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_base_report_get ...'
2896
+ end
2897
+ # verify the required parameter 'cra_check_report_base_report_get_request' is set
2898
+ if @api_client.config.client_side_validation && cra_check_report_base_report_get_request.nil?
2899
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_base_report_get_request' when calling PlaidApi.cra_check_report_base_report_get"
2900
+ end
2901
+ # resource path
2902
+ local_var_path = '/cra/check_report/base_report/get'
2903
+
2904
+ # query parameters
2905
+ query_params = opts[:query_params] || {}
2906
+
2907
+ # header parameters
2908
+ header_params = opts[:header_params] || {}
2909
+ # HTTP header 'Accept' (if needed)
2910
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2911
+ # HTTP header 'Content-Type'
2912
+ content_type = @api_client.select_header_content_type(['application/json'])
2913
+ if !content_type.nil?
2914
+ header_params['Content-Type'] = content_type
2915
+ end
2916
+
2917
+ # form parameters
2918
+ form_params = opts[:form_params] || {}
2919
+
2920
+ # http body (model)
2921
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_base_report_get_request)
2922
+
2923
+ # return_type
2924
+ return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'
2925
+
2926
+ # auth_names
2927
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2928
+
2929
+ new_options = opts.merge(
2930
+ :operation => :"PlaidApi.cra_check_report_base_report_get",
2931
+ :header_params => header_params,
2932
+ :query_params => query_params,
2933
+ :form_params => form_params,
2934
+ :body => post_body,
2935
+ :auth_names => auth_names,
2936
+ :return_type => return_type
2937
+ )
2938
+
2939
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2940
+ if @api_client.config.debugging
2941
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2942
+ end
2943
+ return data, status_code, headers
2944
+ end
2945
+
2946
+ # Create a Consumer Report
2947
+ # `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
2948
+ # @param cra_check_report_create_request [CraCheckReportCreateRequest]
2949
+ # @param [Hash] opts the optional parameters
2950
+ # @return [CraCheckReportCreateResponse]
2951
+ def cra_check_report_create(cra_check_report_create_request, opts = {})
2952
+ data, _status_code, _headers = cra_check_report_create_with_http_info(cra_check_report_create_request, opts)
2953
+ data
2954
+ end
2955
+
2956
+ # Create a Consumer Report
2957
+ # &#x60;/cra/check_report/create&#x60; creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
2958
+ # @param cra_check_report_create_request [CraCheckReportCreateRequest]
2959
+ # @param [Hash] opts the optional parameters
2960
+ # @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
2961
+ def cra_check_report_create_with_http_info(cra_check_report_create_request, opts = {})
2962
+ if @api_client.config.debugging
2963
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_create ...'
2964
+ end
2965
+ # verify the required parameter 'cra_check_report_create_request' is set
2966
+ if @api_client.config.client_side_validation && cra_check_report_create_request.nil?
2967
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_create_request' when calling PlaidApi.cra_check_report_create"
2968
+ end
2969
+ # resource path
2970
+ local_var_path = '/cra/check_report/create'
2971
+
2972
+ # query parameters
2973
+ query_params = opts[:query_params] || {}
2974
+
2975
+ # header parameters
2976
+ header_params = opts[:header_params] || {}
2977
+ # HTTP header 'Accept' (if needed)
2978
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2979
+ # HTTP header 'Content-Type'
2980
+ content_type = @api_client.select_header_content_type(['application/json'])
2981
+ if !content_type.nil?
2982
+ header_params['Content-Type'] = content_type
2983
+ end
2984
+
2985
+ # form parameters
2986
+ form_params = opts[:form_params] || {}
2987
+
2988
+ # http body (model)
2989
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_create_request)
2990
+
2991
+ # return_type
2992
+ return_type = opts[:debug_return_type] || 'CraCheckReportCreateResponse'
2993
+
2994
+ # auth_names
2995
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2996
+
2997
+ new_options = opts.merge(
2998
+ :operation => :"PlaidApi.cra_check_report_create",
2999
+ :header_params => header_params,
3000
+ :query_params => query_params,
3001
+ :form_params => form_params,
3002
+ :body => post_body,
3003
+ :auth_names => auth_names,
3004
+ :return_type => return_type
3005
+ )
3006
+
3007
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3008
+ if @api_client.config.debugging
3009
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3010
+ end
3011
+ return data, status_code, headers
3012
+ end
3013
+
3014
+ # Retrieve cash flow information from your user's banks
3015
+ # This endpoint allows you to retrieve the Income Insights report for your user. 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`.
3016
+ # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3017
+ # @param [Hash] opts the optional parameters
3018
+ # @return [CraCheckReportIncomeInsightsGetResponse]
3019
+ def cra_check_report_income_insights_get(cra_check_report_income_insights_get_request, opts = {})
3020
+ data, _status_code, _headers = cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts)
3021
+ data
3022
+ end
3023
+
3024
+ # Retrieve cash flow information from your user&#39;s banks
3025
+ # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you&#39;ve received a &#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;.
3026
+ # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3027
+ # @param [Hash] opts the optional parameters
3028
+ # @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
3029
+ def cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts = {})
3030
+ if @api_client.config.debugging
3031
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_income_insights_get ...'
3032
+ end
3033
+ # verify the required parameter 'cra_check_report_income_insights_get_request' is set
3034
+ if @api_client.config.client_side_validation && cra_check_report_income_insights_get_request.nil?
3035
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_income_insights_get_request' when calling PlaidApi.cra_check_report_income_insights_get"
3036
+ end
3037
+ # resource path
3038
+ local_var_path = '/cra/check_report/income_insights/get'
3039
+
3040
+ # query parameters
3041
+ query_params = opts[:query_params] || {}
3042
+
3043
+ # header parameters
3044
+ header_params = opts[:header_params] || {}
3045
+ # HTTP header 'Accept' (if needed)
3046
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3047
+ # HTTP header 'Content-Type'
3048
+ content_type = @api_client.select_header_content_type(['application/json'])
3049
+ if !content_type.nil?
3050
+ header_params['Content-Type'] = content_type
3051
+ end
3052
+
3053
+ # form parameters
3054
+ form_params = opts[:form_params] || {}
3055
+
3056
+ # http body (model)
3057
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_income_insights_get_request)
3058
+
3059
+ # return_type
3060
+ return_type = opts[:debug_return_type] || 'CraCheckReportIncomeInsightsGetResponse'
3061
+
3062
+ # auth_names
3063
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3064
+
3065
+ new_options = opts.merge(
3066
+ :operation => :"PlaidApi.cra_check_report_income_insights_get",
3067
+ :header_params => header_params,
3068
+ :query_params => query_params,
3069
+ :form_params => form_params,
3070
+ :body => post_body,
3071
+ :auth_names => auth_names,
3072
+ :return_type => return_type
3073
+ )
3074
+
3075
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3076
+ if @api_client.config.debugging
3077
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_income_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3078
+ end
3079
+ return data, status_code, headers
3080
+ end
3081
+
3082
+ # Retrieve network attributes for the user
3083
+ # This endpoint allows you to retrieve the Network Attributes 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_attributes_get_request [CraCheckReportNetworkAttributesGetRequest]
3085
+ # @param [Hash] opts the optional parameters
3086
+ # @return [CraCheckReportNetworkAttributesGetResponse]
3087
+ def cra_check_report_network_attributes_get(cra_check_report_network_attributes_get_request, opts = {})
3088
+ data, _status_code, _headers = cra_check_report_network_attributes_get_with_http_info(cra_check_report_network_attributes_get_request, opts)
2613
3089
  data
2614
3090
  end
2615
3091
 
2616
- # Retrieve a PDF Reports
2617
- # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2618
- # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
3092
+ # Retrieve network attributes for the user
3093
+ # This endpoint allows you to retrieve the Network Attributes 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_attributes_get_request [CraCheckReportNetworkAttributesGetRequest]
2619
3095
  # @param [Hash] opts the optional parameters
2620
- # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
2621
- def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
3096
+ # @return [Array<(CraCheckReportNetworkAttributesGetResponse, Integer, Hash)>] CraCheckReportNetworkAttributesGetResponse data, response status code and response headers
3097
+ def cra_check_report_network_attributes_get_with_http_info(cra_check_report_network_attributes_get_request, opts = {})
2622
3098
  if @api_client.config.debugging
2623
- @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
3099
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_attributes_get ...'
2624
3100
  end
2625
- # verify the required parameter 'consumer_report_pdf_get_request' is set
2626
- if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
2627
- fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
3101
+ # verify the required parameter 'cra_check_report_network_attributes_get_request' is set
3102
+ if @api_client.config.client_side_validation && cra_check_report_network_attributes_get_request.nil?
3103
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_network_attributes_get_request' when calling PlaidApi.cra_check_report_network_attributes_get"
2628
3104
  end
2629
3105
  # resource path
2630
- local_var_path = '/consumer_report/pdf/get'
3106
+ local_var_path = '/cra/check_report/network_insights/get'
2631
3107
 
2632
3108
  # query parameters
2633
3109
  query_params = opts[:query_params] || {}
@@ -2635,7 +3111,7 @@ module Plaid
2635
3111
  # header parameters
2636
3112
  header_params = opts[:header_params] || {}
2637
3113
  # HTTP header 'Accept' (if needed)
2638
- header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
3114
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2639
3115
  # HTTP header 'Content-Type'
2640
3116
  content_type = @api_client.select_header_content_type(['application/json'])
2641
3117
  if !content_type.nil?
@@ -2646,16 +3122,16 @@ module Plaid
2646
3122
  form_params = opts[:form_params] || {}
2647
3123
 
2648
3124
  # http body (model)
2649
- post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)
3125
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_attributes_get_request)
2650
3126
 
2651
3127
  # return_type
2652
- return_type = opts[:debug_return_type] || 'File'
3128
+ return_type = opts[:debug_return_type] || 'CraCheckReportNetworkAttributesGetResponse'
2653
3129
 
2654
3130
  # auth_names
2655
3131
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2656
3132
 
2657
3133
  new_options = opts.merge(
2658
- :operation => :"PlaidApi.consumer_report_pdf_get",
3134
+ :operation => :"PlaidApi.cra_check_report_network_attributes_get",
2659
3135
  :header_params => header_params,
2660
3136
  :query_params => query_params,
2661
3137
  :form_params => form_params,
@@ -2666,36 +3142,36 @@ module Plaid
2666
3142
 
2667
3143
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2668
3144
  if @api_client.config.debugging
2669
- @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3145
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_attributes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2670
3146
  end
2671
3147
  return data, status_code, headers
2672
3148
  end
2673
3149
 
2674
- # Create a CRA report for income verification
2675
- # `/cra/bank_income/create` creates a CRA report for income verification
2676
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
3150
+ # Retrieve cash flow insights from partners
3151
+ # 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.
3152
+ # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
2677
3153
  # @param [Hash] opts the optional parameters
2678
- # @return [CraBankIncomeCreateResponse]
2679
- def cra_bank_income_create(cra_bank_income_create_request, opts = {})
2680
- data, _status_code, _headers = cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts)
3154
+ # @return [CraCheckReportPartnerInsightsGetResponse]
3155
+ def cra_check_report_partner_insights_get(cra_check_report_partner_insights_get_request, opts = {})
3156
+ data, _status_code, _headers = cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts)
2681
3157
  data
2682
3158
  end
2683
3159
 
2684
- # Create a CRA report for income verification
2685
- # &#x60;/cra/bank_income/create&#x60; creates a CRA report for income verification
2686
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
3160
+ # Retrieve cash flow insights from partners
3161
+ # 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.
3162
+ # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
2687
3163
  # @param [Hash] opts the optional parameters
2688
- # @return [Array<(CraBankIncomeCreateResponse, Integer, Hash)>] CraBankIncomeCreateResponse data, response status code and response headers
2689
- def cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts = {})
3164
+ # @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
3165
+ def cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts = {})
2690
3166
  if @api_client.config.debugging
2691
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_create ...'
3167
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_partner_insights_get ...'
2692
3168
  end
2693
- # verify the required parameter 'cra_bank_income_create_request' is set
2694
- if @api_client.config.client_side_validation && cra_bank_income_create_request.nil?
2695
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_create_request' when calling PlaidApi.cra_bank_income_create"
3169
+ # verify the required parameter 'cra_check_report_partner_insights_get_request' is set
3170
+ if @api_client.config.client_side_validation && cra_check_report_partner_insights_get_request.nil?
3171
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_partner_insights_get_request' when calling PlaidApi.cra_check_report_partner_insights_get"
2696
3172
  end
2697
3173
  # resource path
2698
- local_var_path = '/cra/bank_income/create'
3174
+ local_var_path = '/cra/check_report/partner_insights/get'
2699
3175
 
2700
3176
  # query parameters
2701
3177
  query_params = opts[:query_params] || {}
@@ -2714,16 +3190,16 @@ module Plaid
2714
3190
  form_params = opts[:form_params] || {}
2715
3191
 
2716
3192
  # http body (model)
2717
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_bank_income_create_request)
3193
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_partner_insights_get_request)
2718
3194
 
2719
3195
  # return_type
2720
- return_type = opts[:debug_return_type] || 'CraBankIncomeCreateResponse'
3196
+ return_type = opts[:debug_return_type] || 'CraCheckReportPartnerInsightsGetResponse'
2721
3197
 
2722
3198
  # auth_names
2723
3199
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2724
3200
 
2725
3201
  new_options = opts.merge(
2726
- :operation => :"PlaidApi.cra_bank_income_create",
3202
+ :operation => :"PlaidApi.cra_check_report_partner_insights_get",
2727
3203
  :header_params => header_params,
2728
3204
  :query_params => query_params,
2729
3205
  :form_params => form_params,
@@ -2734,36 +3210,36 @@ module Plaid
2734
3210
 
2735
3211
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2736
3212
  if @api_client.config.debugging
2737
- @api_client.config.logger.debug "API called: PlaidApi#cra_bank_income_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3213
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_partner_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2738
3214
  end
2739
3215
  return data, status_code, headers
2740
3216
  end
2741
3217
 
2742
- # Retrieve information from the bank accounts used for income verification
2743
- # `/cra/bank_income/get` returns the bank income report(s) for a specified user.
2744
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
3218
+ # Retrieve the most recent Base Report in PDF format. You can also include other reports in the same PDF if you specify `add_ons`.
3219
+ # `/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
3220
+ # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
2745
3221
  # @param [Hash] opts the optional parameters
2746
- # @return [CraBankIncomeGetResponse]
2747
- def cra_bank_income_get(cra_bank_income_get_request, opts = {})
2748
- data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
3222
+ # @return [File]
3223
+ def cra_check_report_pdf_get(cra_check_report_pdf_get_request, opts = {})
3224
+ data, _status_code, _headers = cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts)
2749
3225
  data
2750
3226
  end
2751
3227
 
2752
- # Retrieve information from the bank accounts used for income verification
2753
- # &#x60;/cra/bank_income/get&#x60; returns the bank income report(s) for a specified user.
2754
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
3228
+ # 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;.
3229
+ # &#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
3230
+ # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
2755
3231
  # @param [Hash] opts the optional parameters
2756
- # @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
2757
- def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
3232
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
3233
+ def cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts = {})
2758
3234
  if @api_client.config.debugging
2759
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
3235
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_pdf_get ...'
2760
3236
  end
2761
- # verify the required parameter 'cra_bank_income_get_request' is set
2762
- if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
2763
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
3237
+ # verify the required parameter 'cra_check_report_pdf_get_request' is set
3238
+ if @api_client.config.client_side_validation && cra_check_report_pdf_get_request.nil?
3239
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_pdf_get_request' when calling PlaidApi.cra_check_report_pdf_get"
2764
3240
  end
2765
3241
  # resource path
2766
- local_var_path = '/cra/bank_income/get'
3242
+ local_var_path = '/cra/check_report/pdf/get'
2767
3243
 
2768
3244
  # query parameters
2769
3245
  query_params = opts[:query_params] || {}
@@ -2771,7 +3247,7 @@ module Plaid
2771
3247
  # header parameters
2772
3248
  header_params = opts[:header_params] || {}
2773
3249
  # HTTP header 'Accept' (if needed)
2774
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3250
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
2775
3251
  # HTTP header 'Content-Type'
2776
3252
  content_type = @api_client.select_header_content_type(['application/json'])
2777
3253
  if !content_type.nil?
@@ -2782,16 +3258,16 @@ module Plaid
2782
3258
  form_params = opts[:form_params] || {}
2783
3259
 
2784
3260
  # http body (model)
2785
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_bank_income_get_request)
3261
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_pdf_get_request)
2786
3262
 
2787
3263
  # return_type
2788
- return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
3264
+ return_type = opts[:debug_return_type] || 'File'
2789
3265
 
2790
3266
  # auth_names
2791
3267
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2792
3268
 
2793
3269
  new_options = opts.merge(
2794
- :operation => :"PlaidApi.cra_bank_income_get",
3270
+ :operation => :"PlaidApi.cra_check_report_pdf_get",
2795
3271
  :header_params => header_params,
2796
3272
  :query_params => query_params,
2797
3273
  :form_params => form_params,
@@ -2802,7 +3278,7 @@ module Plaid
2802
3278
 
2803
3279
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2804
3280
  if @api_client.config.debugging
2805
- @api_client.config.logger.debug "API called: PlaidApi#cra_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3281
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2806
3282
  end
2807
3283
  return data, status_code, headers
2808
3284
  end
@@ -7432,7 +7908,7 @@ module Plaid
7432
7908
  end
7433
7909
 
7434
7910
  # Remove an Item
7435
- # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
7911
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item. In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
7436
7912
  # @param item_remove_request [ItemRemoveRequest]
7437
7913
  # @param [Hash] opts the optional parameters
7438
7914
  # @return [ItemRemoveResponse]
@@ -7442,7 +7918,7 @@ module Plaid
7442
7918
  end
7443
7919
 
7444
7920
  # Remove an Item
7445
- # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
7921
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item. In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
7446
7922
  # @param item_remove_request [ItemRemoveRequest]
7447
7923
  # @param [Hash] opts the optional parameters
7448
7924
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -7908,7 +8384,7 @@ module Plaid
7908
8384
  end
7909
8385
 
7910
8386
  # Create Link Token
7911
- # 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.
8387
+ # 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.
7912
8388
  # @param link_token_create_request [LinkTokenCreateRequest]
7913
8389
  # @param [Hash] opts the optional parameters
7914
8390
  # @return [LinkTokenCreateResponse]
@@ -7918,7 +8394,7 @@ module Plaid
7918
8394
  end
7919
8395
 
7920
8396
  # Create Link Token
7921
- # 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.
8397
+ # 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.
7922
8398
  # @param link_token_create_request [LinkTokenCreateRequest]
7923
8399
  # @param [Hash] opts the optional parameters
7924
8400
  # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
@@ -8112,7 +8588,7 @@ module Plaid
8112
8588
  end
8113
8589
 
8114
8590
  # Enables a Plaid reseller's end customer in the Production environment.
8115
- # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
8591
+ # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
8116
8592
  # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
8117
8593
  # @param [Hash] opts the optional parameters
8118
8594
  # @return [PartnerCustomerEnableResponse]
@@ -8122,7 +8598,7 @@ module Plaid
8122
8598
  end
8123
8599
 
8124
8600
  # Enables a Plaid reseller&#39;s end customer in the Production environment.
8125
- # The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the Production environment.
8601
+ # The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the full Production environment.
8126
8602
  # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
8127
8603
  # @param [Hash] opts the optional parameters
8128
8604
  # @return [Array<(PartnerCustomerEnableResponse, Integer, Hash)>] PartnerCustomerEnableResponse data, response status code and response headers
@@ -8316,7 +8792,7 @@ module Plaid
8316
8792
  end
8317
8793
 
8318
8794
  # Removes a Plaid reseller's end customer.
8319
- # 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.
8795
+ # 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.
8320
8796
  # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
8321
8797
  # @param [Hash] opts the optional parameters
8322
8798
  # @return [PartnerCustomerRemoveResponse]
@@ -8326,7 +8802,7 @@ module Plaid
8326
8802
  end
8327
8803
 
8328
8804
  # Removes a Plaid reseller&#39;s end customer.
8329
- # 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.
8805
+ # 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.
8330
8806
  # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
8331
8807
  # @param [Hash] opts the optional parameters
8332
8808
  # @return [Array<(PartnerCustomerRemoveResponse, Integer, Hash)>] PartnerCustomerRemoveResponse data, response status code and response headers
@@ -8656,7 +9132,7 @@ module Plaid
8656
9132
  end
8657
9133
 
8658
9134
  # Create a payment
8659
- # 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.
9135
+ # 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.
8660
9136
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
8661
9137
  # @param [Hash] opts the optional parameters
8662
9138
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -8666,7 +9142,7 @@ module Plaid
8666
9142
  end
8667
9143
 
8668
9144
  # Create a payment
8669
- # 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.
9145
+ # 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.
8670
9146
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
8671
9147
  # @param [Hash] opts the optional parameters
8672
9148
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -10628,7 +11104,7 @@ module Plaid
10628
11104
  end
10629
11105
 
10630
11106
  # Refresh transaction data
10631
- # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on a processor token from that institution. 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. `/processor/transactions/refresh` is offered as an add-on to Transactions 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.
11107
+ # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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. `/processor/transactions/refresh` is offered as an add-on to Transactions 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.
10632
11108
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
10633
11109
  # @param [Hash] opts the optional parameters
10634
11110
  # @return [ProcessorTransactionsRefreshResponse]
@@ -10638,7 +11114,7 @@ module Plaid
10638
11114
  end
10639
11115
 
10640
11116
  # Refresh transaction data
10641
- # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on a processor token from that institution. 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;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions 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.
11117
+ # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. 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;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions 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.
10642
11118
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
10643
11119
  # @param [Hash] opts the optional parameters
10644
11120
  # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
@@ -11104,7 +11580,7 @@ module Plaid
11104
11580
  end
11105
11581
 
11106
11582
  # Fire a test webhook
11107
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `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`).
11583
+ # 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 (except for webhooks of type `TRANSFER`).
11108
11584
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
11109
11585
  # @param [Hash] opts the optional parameters
11110
11586
  # @return [SandboxItemFireWebhookResponse]
@@ -11114,7 +11590,7 @@ module Plaid
11114
11590
  end
11115
11591
 
11116
11592
  # Fire a test webhook
11117
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;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;).
11593
+ # 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 (except for webhooks of type &#x60;TRANSFER&#x60;).
11118
11594
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
11119
11595
  # @param [Hash] opts the optional parameters
11120
11596
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -12395,8 +12871,76 @@ module Plaid
12395
12871
  return data, status_code, headers
12396
12872
  end
12397
12873
 
12874
+ # Force item(s) for a Sandbox User into an error state
12875
+ # `/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.
12876
+ # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
12877
+ # @param [Hash] opts the optional parameters
12878
+ # @return [SandboxUserResetLoginResponse]
12879
+ def sandbox_user_reset_login(sandbox_user_reset_login_request, opts = {})
12880
+ data, _status_code, _headers = sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts)
12881
+ data
12882
+ end
12883
+
12884
+ # Force item(s) for a Sandbox User into an error state
12885
+ # &#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.
12886
+ # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
12887
+ # @param [Hash] opts the optional parameters
12888
+ # @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
12889
+ def sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts = {})
12890
+ if @api_client.config.debugging
12891
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_user_reset_login ...'
12892
+ end
12893
+ # verify the required parameter 'sandbox_user_reset_login_request' is set
12894
+ if @api_client.config.client_side_validation && sandbox_user_reset_login_request.nil?
12895
+ fail ArgumentError, "Missing the required parameter 'sandbox_user_reset_login_request' when calling PlaidApi.sandbox_user_reset_login"
12896
+ end
12897
+ # resource path
12898
+ local_var_path = '/sandbox/user/reset_login'
12899
+
12900
+ # query parameters
12901
+ query_params = opts[:query_params] || {}
12902
+
12903
+ # header parameters
12904
+ header_params = opts[:header_params] || {}
12905
+ # HTTP header 'Accept' (if needed)
12906
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12907
+ # HTTP header 'Content-Type'
12908
+ content_type = @api_client.select_header_content_type(['application/json'])
12909
+ if !content_type.nil?
12910
+ header_params['Content-Type'] = content_type
12911
+ end
12912
+
12913
+ # form parameters
12914
+ form_params = opts[:form_params] || {}
12915
+
12916
+ # http body (model)
12917
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_user_reset_login_request)
12918
+
12919
+ # return_type
12920
+ return_type = opts[:debug_return_type] || 'SandboxUserResetLoginResponse'
12921
+
12922
+ # auth_names
12923
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12924
+
12925
+ new_options = opts.merge(
12926
+ :operation => :"PlaidApi.sandbox_user_reset_login",
12927
+ :header_params => header_params,
12928
+ :query_params => query_params,
12929
+ :form_params => form_params,
12930
+ :body => post_body,
12931
+ :auth_names => auth_names,
12932
+ :return_type => return_type
12933
+ )
12934
+
12935
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12936
+ if @api_client.config.debugging
12937
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_user_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12938
+ end
12939
+ return data, status_code, headers
12940
+ end
12941
+
12398
12942
  # Report whether you initiated an ACH transaction
12399
- # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
12943
+ # After calling `/signal/evaluate` (or `/accounts/balance/get`, for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta), call `/signal/decision/report` to report whether the transaction was initiated.
12400
12944
  # @param signal_decision_report_request [SignalDecisionReportRequest]
12401
12945
  # @param [Hash] opts the optional parameters
12402
12946
  # @return [SignalDecisionReportResponse]
@@ -12406,7 +12950,7 @@ module Plaid
12406
12950
  end
12407
12951
 
12408
12952
  # Report whether you initiated an ACH transaction
12409
- # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated.
12953
+ # After calling &#x60;/signal/evaluate&#x60; (or &#x60;/accounts/balance/get&#x60;, for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta), call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated.
12410
12954
  # @param signal_decision_report_request [SignalDecisionReportRequest]
12411
12955
  # @param [Hash] opts the optional parameters
12412
12956
  # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
@@ -12600,7 +13144,7 @@ module Plaid
12600
13144
  end
12601
13145
 
12602
13146
  # Report a return for an ACH transaction
12603
- # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
13147
+ # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` or (for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta) the `/accounts/balance/get` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
12604
13148
  # @param signal_return_report_request [SignalReturnReportRequest]
12605
13149
  # @param [Hash] opts the optional parameters
12606
13150
  # @return [SignalReturnReportResponse]
@@ -12610,7 +13154,7 @@ module Plaid
12610
13154
  end
12611
13155
 
12612
13156
  # Report a return for an ACH transaction
12613
- # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
13157
+ # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; or (for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta) the &#x60;/accounts/balance/get&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
12614
13158
  # @param signal_return_report_request [SignalReturnReportRequest]
12615
13159
  # @param [Hash] opts the optional parameters
12616
13160
  # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
@@ -13144,7 +13688,7 @@ module Plaid
13144
13688
  end
13145
13689
 
13146
13690
  # Refresh transaction data
13147
- # `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item from that institution. 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. `/transactions/refresh` is offered as an optional add-on to Transactions 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.
13691
+ # `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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. `/transactions/refresh` is offered as an optional add-on to Transactions 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.
13148
13692
  # @param transactions_refresh_request [TransactionsRefreshRequest]
13149
13693
  # @param [Hash] opts the optional parameters
13150
13694
  # @return [TransactionsRefreshResponse]
@@ -13154,7 +13698,7 @@ module Plaid
13154
13698
  end
13155
13699
 
13156
13700
  # Refresh transaction data
13157
- # &#x60;/transactions/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call &#x60;/transactions/refresh&#x60;. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item from that institution. 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;/transactions/refresh&#x60; is offered as an optional add-on to Transactions 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.
13701
+ # &#x60;/transactions/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call &#x60;/transactions/refresh&#x60;. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. 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;/transactions/refresh&#x60; is offered as an optional add-on to Transactions 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.
13158
13702
  # @param transactions_refresh_request [TransactionsRefreshRequest]
13159
13703
  # @param [Hash] opts the optional parameters
13160
13704
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
@@ -16067,6 +16611,74 @@ module Plaid
16067
16611
  return data, status_code, headers
16068
16612
  end
16069
16613
 
16614
+ # Retrieve User Account
16615
+ # Returns user permissioned account data including identity and Item access tokens.
16616
+ # @param user_account_session_get_request [UserAccountSessionGetRequest]
16617
+ # @param [Hash] opts the optional parameters
16618
+ # @return [UserAccountSessionGetResponse]
16619
+ def user_account_session_get(user_account_session_get_request, opts = {})
16620
+ data, _status_code, _headers = user_account_session_get_with_http_info(user_account_session_get_request, opts)
16621
+ data
16622
+ end
16623
+
16624
+ # Retrieve User Account
16625
+ # Returns user permissioned account data including identity and Item access tokens.
16626
+ # @param user_account_session_get_request [UserAccountSessionGetRequest]
16627
+ # @param [Hash] opts the optional parameters
16628
+ # @return [Array<(UserAccountSessionGetResponse, Integer, Hash)>] UserAccountSessionGetResponse data, response status code and response headers
16629
+ def user_account_session_get_with_http_info(user_account_session_get_request, opts = {})
16630
+ if @api_client.config.debugging
16631
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_account_session_get ...'
16632
+ end
16633
+ # verify the required parameter 'user_account_session_get_request' is set
16634
+ if @api_client.config.client_side_validation && user_account_session_get_request.nil?
16635
+ fail ArgumentError, "Missing the required parameter 'user_account_session_get_request' when calling PlaidApi.user_account_session_get"
16636
+ end
16637
+ # resource path
16638
+ local_var_path = '/user_account/session/get'
16639
+
16640
+ # query parameters
16641
+ query_params = opts[:query_params] || {}
16642
+
16643
+ # header parameters
16644
+ header_params = opts[:header_params] || {}
16645
+ # HTTP header 'Accept' (if needed)
16646
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16647
+ # HTTP header 'Content-Type'
16648
+ content_type = @api_client.select_header_content_type(['application/json'])
16649
+ if !content_type.nil?
16650
+ header_params['Content-Type'] = content_type
16651
+ end
16652
+
16653
+ # form parameters
16654
+ form_params = opts[:form_params] || {}
16655
+
16656
+ # http body (model)
16657
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_account_session_get_request)
16658
+
16659
+ # return_type
16660
+ return_type = opts[:debug_return_type] || 'UserAccountSessionGetResponse'
16661
+
16662
+ # auth_names
16663
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16664
+
16665
+ new_options = opts.merge(
16666
+ :operation => :"PlaidApi.user_account_session_get",
16667
+ :header_params => header_params,
16668
+ :query_params => query_params,
16669
+ :form_params => form_params,
16670
+ :body => post_body,
16671
+ :auth_names => auth_names,
16672
+ :return_type => return_type
16673
+ )
16674
+
16675
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16676
+ if @api_client.config.debugging
16677
+ @api_client.config.logger.debug "API called: PlaidApi#user_account_session_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16678
+ end
16679
+ return data, status_code, headers
16680
+ end
16681
+
16070
16682
  # Create user
16071
16683
  # 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`.
16072
16684
  # @param user_create_request [UserCreateRequest]
@@ -16135,6 +16747,142 @@ module Plaid
16135
16747
  return data, status_code, headers
16136
16748
  end
16137
16749
 
16750
+ # Get Items associated with a User
16751
+ # Returns Items associated with a User along with their corresponding statuses.
16752
+ # @param user_items_get_request [UserItemsGetRequest]
16753
+ # @param [Hash] opts the optional parameters
16754
+ # @return [UserItemsGetResponse]
16755
+ def user_items_get(user_items_get_request, opts = {})
16756
+ data, _status_code, _headers = user_items_get_with_http_info(user_items_get_request, opts)
16757
+ data
16758
+ end
16759
+
16760
+ # Get Items associated with a User
16761
+ # Returns Items associated with a User along with their corresponding statuses.
16762
+ # @param user_items_get_request [UserItemsGetRequest]
16763
+ # @param [Hash] opts the optional parameters
16764
+ # @return [Array<(UserItemsGetResponse, Integer, Hash)>] UserItemsGetResponse data, response status code and response headers
16765
+ def user_items_get_with_http_info(user_items_get_request, opts = {})
16766
+ if @api_client.config.debugging
16767
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_get ...'
16768
+ end
16769
+ # verify the required parameter 'user_items_get_request' is set
16770
+ if @api_client.config.client_side_validation && user_items_get_request.nil?
16771
+ fail ArgumentError, "Missing the required parameter 'user_items_get_request' when calling PlaidApi.user_items_get"
16772
+ end
16773
+ # resource path
16774
+ local_var_path = '/user/items/get'
16775
+
16776
+ # query parameters
16777
+ query_params = opts[:query_params] || {}
16778
+
16779
+ # header parameters
16780
+ header_params = opts[:header_params] || {}
16781
+ # HTTP header 'Accept' (if needed)
16782
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16783
+ # HTTP header 'Content-Type'
16784
+ content_type = @api_client.select_header_content_type(['application/json'])
16785
+ if !content_type.nil?
16786
+ header_params['Content-Type'] = content_type
16787
+ end
16788
+
16789
+ # form parameters
16790
+ form_params = opts[:form_params] || {}
16791
+
16792
+ # http body (model)
16793
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_get_request)
16794
+
16795
+ # return_type
16796
+ return_type = opts[:debug_return_type] || 'UserItemsGetResponse'
16797
+
16798
+ # auth_names
16799
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16800
+
16801
+ new_options = opts.merge(
16802
+ :operation => :"PlaidApi.user_items_get",
16803
+ :header_params => header_params,
16804
+ :query_params => query_params,
16805
+ :form_params => form_params,
16806
+ :body => post_body,
16807
+ :auth_names => auth_names,
16808
+ :return_type => return_type
16809
+ )
16810
+
16811
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16812
+ if @api_client.config.debugging
16813
+ @api_client.config.logger.debug "API called: PlaidApi#user_items_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16814
+ end
16815
+ return data, status_code, headers
16816
+ end
16817
+
16818
+ # Remove user
16819
+ # This endpoint is used to remove a user and any relevant data related to the user based on the provided user token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
16820
+ # @param user_remove_request [UserRemoveRequest]
16821
+ # @param [Hash] opts the optional parameters
16822
+ # @return [UserRemoveResponse]
16823
+ def user_remove(user_remove_request, opts = {})
16824
+ data, _status_code, _headers = user_remove_with_http_info(user_remove_request, opts)
16825
+ data
16826
+ end
16827
+
16828
+ # Remove user
16829
+ # This endpoint is used to remove a user and any relevant data related to the user based on the provided user token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
16830
+ # @param user_remove_request [UserRemoveRequest]
16831
+ # @param [Hash] opts the optional parameters
16832
+ # @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
16833
+ def user_remove_with_http_info(user_remove_request, opts = {})
16834
+ if @api_client.config.debugging
16835
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_remove ...'
16836
+ end
16837
+ # verify the required parameter 'user_remove_request' is set
16838
+ if @api_client.config.client_side_validation && user_remove_request.nil?
16839
+ fail ArgumentError, "Missing the required parameter 'user_remove_request' when calling PlaidApi.user_remove"
16840
+ end
16841
+ # resource path
16842
+ local_var_path = '/user/remove'
16843
+
16844
+ # query parameters
16845
+ query_params = opts[:query_params] || {}
16846
+
16847
+ # header parameters
16848
+ header_params = opts[:header_params] || {}
16849
+ # HTTP header 'Accept' (if needed)
16850
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16851
+ # HTTP header 'Content-Type'
16852
+ content_type = @api_client.select_header_content_type(['application/json'])
16853
+ if !content_type.nil?
16854
+ header_params['Content-Type'] = content_type
16855
+ end
16856
+
16857
+ # form parameters
16858
+ form_params = opts[:form_params] || {}
16859
+
16860
+ # http body (model)
16861
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_remove_request)
16862
+
16863
+ # return_type
16864
+ return_type = opts[:debug_return_type] || 'UserRemoveResponse'
16865
+
16866
+ # auth_names
16867
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16868
+
16869
+ new_options = opts.merge(
16870
+ :operation => :"PlaidApi.user_remove",
16871
+ :header_params => header_params,
16872
+ :query_params => query_params,
16873
+ :form_params => form_params,
16874
+ :body => post_body,
16875
+ :auth_names => auth_names,
16876
+ :return_type => return_type
16877
+ )
16878
+
16879
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16880
+ if @api_client.config.debugging
16881
+ @api_client.config.logger.debug "API called: PlaidApi#user_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16882
+ end
16883
+ return data, status_code, headers
16884
+ end
16885
+
16138
16886
  # Update user information
16139
16887
  # 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.
16140
16888
  # @param user_update_request [UserUpdateRequest]