plaid 31.0.0 → 33.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1684) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +162 -0
  3. data/Dockerfile +1 -0
  4. data/Gemfile.lock +4 -2
  5. data/Makefile +1 -1
  6. data/lib/plaid/api/plaid_api.rb +575 -31
  7. data/lib/plaid/api_client.rb +2 -2
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +1 -1
  10. data/lib/plaid/models/account_access.rb +1 -1
  11. data/lib/plaid/models/account_assets.rb +2 -2
  12. data/lib/plaid/models/account_balance.rb +2 -2
  13. data/lib/plaid/models/account_base.rb +2 -2
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_holder_category.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +2 -2
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_document_upload.rb +3 -3
  20. data/lib/plaid/models/account_identity_document_upload_all_of.rb +2 -2
  21. data/lib/plaid/models/account_identity_match_score.rb +2 -2
  22. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  23. data/lib/plaid/models/account_product_access.rb +1 -1
  24. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  25. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  26. data/lib/plaid/models/account_subtype.rb +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 +2 -2
  35. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +2 -2
  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 +2 -2
  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 +2 -2
  71. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  75. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  77. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  79. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  80. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  81. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  82. data/lib/plaid/models/asset_report_investments.rb +1 -1
  83. data/lib/plaid/models/asset_report_item.rb +1 -1
  84. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  85. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  86. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  88. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  90. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  91. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  92. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  93. data/lib/plaid/models/asset_report_type.rb +1 -1
  94. data/lib/plaid/models/asset_report_user.rb +1 -1
  95. data/lib/plaid/models/asset_transaction.rb +1 -1
  96. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  97. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  98. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  99. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  100. data/lib/plaid/models/asset_transactions.rb +1 -1
  101. data/lib/plaid/models/asset_type.rb +1 -1
  102. data/lib/plaid/models/assets.rb +1 -1
  103. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  104. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  105. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  106. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  107. data/lib/plaid/models/auth_get_request.rb +1 -1
  108. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  109. data/lib/plaid/models/auth_get_response.rb +1 -1
  110. data/lib/plaid/models/auth_metadata.rb +1 -1
  111. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  112. data/lib/plaid/models/auth_update_types.rb +1 -1
  113. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  114. data/lib/plaid/models/balance_plus_attributes.rb +1 -1
  115. data/lib/plaid/models/balance_plus_risk_level.rb +1 -1
  116. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  117. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  118. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  119. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  120. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  121. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  122. data/lib/plaid/models/bank_transfer.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  155. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  156. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  157. data/lib/plaid/models/base_report.rb +1 -1
  158. data/lib/plaid/models/base_report_account.rb +15 -6
  159. data/lib/plaid/models/base_report_account_balances.rb +2 -2
  160. data/lib/plaid/models/base_report_account_insights.rb +4 -4
  161. data/lib/plaid/models/base_report_attributes.rb +243 -0
  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_historical_balance.rb +1 -1
  165. data/lib/plaid/models/base_report_item.rb +1 -1
  166. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  167. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  168. data/lib/plaid/models/base_report_transaction.rb +2 -1
  169. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  170. data/lib/plaid/models/base_report_warning.rb +1 -1
  171. data/lib/plaid/models/base_report_warning_code.rb +2 -1
  172. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  173. data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
  174. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  175. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  176. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  178. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  179. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  180. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  181. data/lib/plaid/models/beacon_audit_trail.rb +2 -2
  182. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  183. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  184. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  185. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  186. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  187. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  188. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  189. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  190. data/lib/plaid/models/beacon_report.rb +1 -1
  191. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  192. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  193. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  194. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  195. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  196. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  197. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  198. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  199. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  200. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  202. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  205. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  206. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  207. data/lib/plaid/models/beacon_report_type.rb +1 -1
  208. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  209. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  210. data/lib/plaid/models/beacon_user.rb +1 -1
  211. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  212. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  213. data/lib/plaid/models/beacon_user_address.rb +1 -1
  214. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  215. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  216. data/lib/plaid/models/beacon_user_data.rb +2 -2
  217. data/lib/plaid/models/beacon_user_depository_account.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 +1 -1
  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 -1
  226. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  227. data/lib/plaid/models/beacon_user_request_data.rb +2 -2
  228. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  229. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  230. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  231. data/lib/plaid/models/beacon_user_status.rb +1 -1
  232. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  233. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  234. data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
  235. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  236. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  237. data/lib/plaid/models/categories_get_response.rb +1 -1
  238. data/lib/plaid/models/category.rb +1 -1
  239. data/lib/plaid/models/category_insight_details.rb +1 -1
  240. data/lib/plaid/models/category_insights.rb +1 -1
  241. data/lib/plaid/models/cause.rb +1 -1
  242. data/lib/plaid/models/cause_all_of.rb +1 -1
  243. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  244. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  245. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  246. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  247. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  248. data/lib/plaid/models/connected_application.rb +1 -1
  249. data/lib/plaid/models/consent_event.rb +338 -0
  250. data/lib/plaid/models/{cra_check_report_product.rb → consent_event_code.rb} +6 -6
  251. data/lib/plaid/models/consent_event_initiator.rb +41 -0
  252. data/lib/plaid/models/consent_event_type.rb +40 -0
  253. data/lib/plaid/models/consent_events_get_request.rb +246 -0
  254. data/lib/plaid/models/consent_events_get_response.rb +243 -0
  255. data/lib/plaid/models/consented_account.rb +292 -0
  256. data/lib/plaid/models/consumer_dispute.rb +1 -1
  257. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  258. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  259. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  260. data/lib/plaid/models/consumer_report_user_identity.rb +50 -2
  261. data/lib/plaid/models/counterparty.rb +1 -1
  262. data/lib/plaid/models/counterparty_insights.rb +1 -1
  263. data/lib/plaid/models/counterparty_type.rb +1 -1
  264. data/lib/plaid/models/country_code.rb +1 -1
  265. data/lib/plaid/models/cra_bank_income.rb +1 -1
  266. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  267. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  268. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  269. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  270. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  271. data/lib/plaid/models/cra_bank_income_create_request.rb +1 -1
  272. data/lib/plaid/models/cra_bank_income_create_response.rb +1 -1
  273. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  274. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  275. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  276. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  277. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  278. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  279. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  280. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  281. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  282. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  283. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  284. data/lib/plaid/models/cra_base_report_create_request.rb +1 -1
  285. data/lib/plaid/models/cra_base_report_create_response.rb +1 -1
  286. data/lib/plaid/models/cra_base_report_get_request.rb +1 -1
  287. data/lib/plaid/models/cra_base_report_get_response.rb +1 -1
  288. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  289. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +12 -7
  290. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  291. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +1 -1
  292. data/lib/plaid/models/cra_check_report_create_request.rb +3 -24
  293. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  294. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  295. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +15 -10
  296. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  297. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +15 -10
  298. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +1 -1
  299. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  300. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +12 -7
  301. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
  302. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +12 -7
  303. data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
  304. data/lib/plaid/models/cra_income_insights.rb +1 -1
  305. data/lib/plaid/models/cra_loan_application.rb +1 -1
  306. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  307. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  308. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  309. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  310. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  311. data/lib/plaid/models/cra_loan_register.rb +1 -1
  312. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  313. data/lib/plaid/models/cra_loan_status.rb +1 -1
  314. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  315. data/lib/plaid/models/cra_loan_type.rb +1 -1
  316. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  317. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  318. data/lib/plaid/models/cra_loan_update.rb +1 -1
  319. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  320. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  321. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  322. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  323. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  324. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  325. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  326. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +41 -5
  327. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  328. data/lib/plaid/models/cra_monitoring_insights_item.rb +2 -6
  329. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +1 -1
  330. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  331. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  332. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  333. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  334. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  335. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  336. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  337. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  338. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  339. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  340. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  341. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  342. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  343. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  344. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  345. data/lib/plaid/models/credit1099.rb +1 -1
  346. data/lib/plaid/models/credit1099_filer.rb +1 -1
  347. data/lib/plaid/models/credit1099_payer.rb +1 -1
  348. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  349. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  350. data/lib/plaid/models/credit_ach_class.rb +1 -1
  351. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  352. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  353. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  354. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  355. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  356. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  357. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  358. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  359. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  360. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  361. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  362. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  363. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  364. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  365. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  366. data/lib/plaid/models/credit_bank_income.rb +1 -1
  367. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  368. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  369. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  370. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  371. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  372. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  373. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  374. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  375. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  376. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  377. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  378. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  379. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  380. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  381. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  382. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  383. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  384. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  385. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  386. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  387. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  388. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  389. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  390. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  391. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  392. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  393. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  394. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  395. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  396. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  397. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  398. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  399. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  400. data/lib/plaid/models/credit_card_liability.rb +1 -1
  401. data/lib/plaid/models/credit_category.rb +1 -1
  402. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  403. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  404. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  405. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  406. data/lib/plaid/models/credit_employment_item.rb +1 -1
  407. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  408. data/lib/plaid/models/credit_filter.rb +1 -1
  409. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  410. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  411. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  412. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  413. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  414. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  415. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  416. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  417. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  418. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  419. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  420. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  421. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  422. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  423. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  424. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  425. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  426. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  427. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  428. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  429. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  430. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  431. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  432. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  433. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  434. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  435. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  436. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  437. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  438. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  439. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  440. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  441. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  442. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  443. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  444. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  445. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  446. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  447. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  448. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  449. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  450. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  451. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  452. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  453. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  454. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  455. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  456. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  457. data/lib/plaid/models/credit_session.rb +1 -1
  458. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  459. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  460. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  461. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  462. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  463. data/lib/plaid/models/credit_session_error.rb +1 -1
  464. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  465. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  466. data/lib/plaid/models/credit_session_results.rb +1 -1
  467. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  468. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  469. data/lib/plaid/models/credit_w2.rb +1 -1
  470. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  471. data/lib/plaid/models/dashboard_user.rb +3 -3
  472. data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
  473. data/lib/plaid/models/dashboard_user_get_response.rb +3 -3
  474. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  475. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  476. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  477. data/lib/plaid/models/data_sources.rb +40 -0
  478. data/lib/plaid/models/date_range.rb +1 -1
  479. data/lib/plaid/models/deductions.rb +1 -1
  480. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  481. data/lib/plaid/models/deductions_total.rb +1 -1
  482. data/lib/plaid/models/default_update_webhook.rb +1 -1
  483. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  484. data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
  485. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  486. data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
  487. data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
  488. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  489. data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
  490. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  491. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +2 -2
  492. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  493. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  494. data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
  495. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  496. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  497. data/lib/plaid/models/depository_filter.rb +1 -1
  498. data/lib/plaid/models/detailed_originator.rb +1 -1
  499. data/lib/plaid/models/detected_account.rb +1 -1
  500. data/lib/plaid/models/device_id.rb +230 -0
  501. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  502. data/lib/plaid/models/doc_type.rb +1 -1
  503. data/lib/plaid/models/document_analysis.rb +1 -1
  504. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  505. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  506. data/lib/plaid/models/document_metadata.rb +1 -1
  507. data/lib/plaid/models/document_name_match_code.rb +1 -1
  508. data/lib/plaid/models/document_risk_signal.rb +3 -3
  509. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  510. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  511. data/lib/plaid/models/document_risk_summary.rb +2 -2
  512. data/lib/plaid/models/document_status.rb +1 -1
  513. data/lib/plaid/models/documentary_verification.rb +1 -1
  514. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  515. data/lib/plaid/models/earnings.rb +1 -1
  516. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  517. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  518. data/lib/plaid/models/earnings_total.rb +1 -1
  519. data/lib/plaid/models/email.rb +1 -1
  520. data/lib/plaid/models/email_address_match_score.rb +1 -1
  521. data/lib/plaid/models/employee.rb +1 -1
  522. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  523. data/lib/plaid/models/employer.rb +1 -1
  524. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  525. data/lib/plaid/models/employer_verification.rb +1 -1
  526. data/lib/plaid/models/employers_search_request.rb +1 -1
  527. data/lib/plaid/models/employers_search_response.rb +1 -1
  528. data/lib/plaid/models/employment_details.rb +1 -1
  529. data/lib/plaid/models/employment_source_type.rb +1 -1
  530. data/lib/plaid/models/employment_verification.rb +1 -1
  531. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  532. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  533. data/lib/plaid/models/employment_verification_status.rb +1 -1
  534. data/lib/plaid/models/enhancements.rb +1 -1
  535. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  536. data/lib/plaid/models/enrichments.rb +1 -1
  537. data/lib/plaid/models/entity_document.rb +1 -1
  538. data/lib/plaid/models/entity_document_type.rb +1 -1
  539. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  540. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  541. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  542. data/lib/plaid/models/entity_screening_hit_emails.rb +2 -2
  543. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  544. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  545. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  546. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  547. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  548. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  549. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  550. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  551. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  552. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  553. data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
  554. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  555. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  556. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +2 -2
  557. data/lib/plaid/models/entity_watchlist_search_terms.rb +2 -2
  558. data/lib/plaid/models/expiration_date.rb +1 -1
  559. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  560. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  561. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  562. data/lib/plaid/models/external_payment_options.rb +1 -1
  563. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  564. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  565. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  566. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  567. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  568. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  569. data/lib/plaid/models/fdx_content_types.rb +1 -1
  570. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  571. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  572. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  573. data/lib/plaid/models/fdx_notification.rb +1 -1
  574. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  575. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  576. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  577. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  578. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  579. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  580. data/lib/plaid/models/fdx_party.rb +1 -1
  581. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  582. data/lib/plaid/models/fdx_party_type.rb +1 -1
  583. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  584. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  585. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  586. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  587. data/lib/plaid/models/form1099_type.rb +1 -1
  588. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  589. data/lib/plaid/models/fraud_amount.rb +1 -1
  590. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  591. data/lib/plaid/models/get_recipient_response.rb +1 -1
  592. data/lib/plaid/models/get_recipients_response.rb +1 -1
  593. data/lib/plaid/models/health_incident.rb +1 -1
  594. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  595. data/lib/plaid/models/historical_annual_income.rb +241 -0
  596. data/lib/plaid/models/historical_balance.rb +1 -1
  597. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  598. data/lib/plaid/models/holding.rb +1 -1
  599. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  600. data/lib/plaid/models/holdings_override.rb +1 -1
  601. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  602. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  603. data/lib/plaid/models/id_number_type.rb +1 -1
  604. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  605. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  606. data/lib/plaid/models/identity_document_upload.rb +2 -1
  607. data/lib/plaid/models/identity_document_upload_metadata.rb +7 -4
  608. data/lib/plaid/models/identity_document_upload_risk_insights.rb +3 -3
  609. data/lib/plaid/models/identity_document_upload_risk_signal.rb +5 -1
  610. data/lib/plaid/models/identity_document_upload_risk_summary.rb +3 -3
  611. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  612. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  613. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  614. data/lib/plaid/models/identity_get_request.rb +1 -1
  615. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  616. data/lib/plaid/models/identity_get_response.rb +1 -1
  617. data/lib/plaid/models/identity_match_request.rb +1 -1
  618. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  619. data/lib/plaid/models/identity_match_response.rb +1 -1
  620. data/lib/plaid/models/identity_match_user.rb +1 -1
  621. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  622. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  623. data/lib/plaid/models/identity_update_types.rb +1 -1
  624. data/lib/plaid/models/identity_verification.rb +1 -1
  625. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  626. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  627. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  628. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  629. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  630. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  631. data/lib/plaid/models/identity_verification_create_request_user.rb +2 -2
  632. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  633. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  634. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  635. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  636. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  637. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  638. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  639. data/lib/plaid/models/identity_verification_request_user.rb +2 -2
  640. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  641. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  642. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  643. data/lib/plaid/models/identity_verification_retry_request.rb +2 -2
  644. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +2 -2
  645. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  646. data/lib/plaid/models/identity_verification_status.rb +1 -1
  647. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  648. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  649. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  650. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  651. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  652. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  653. data/lib/plaid/models/identity_verification_user_data.rb +2 -2
  654. data/lib/plaid/models/image_quality.rb +1 -1
  655. data/lib/plaid/models/incident_update.rb +1 -1
  656. data/lib/plaid/models/income_breakdown.rb +1 -1
  657. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  658. data/lib/plaid/models/income_override.rb +1 -1
  659. data/lib/plaid/models/income_sources_counts.rb +1 -1
  660. data/lib/plaid/models/income_summary.rb +1 -1
  661. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  662. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  663. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  664. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  665. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  666. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  667. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  668. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  669. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  670. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  671. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  672. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  673. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  674. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  675. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  676. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  677. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  678. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  679. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  680. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  681. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  682. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  683. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  684. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  685. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  686. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  687. data/lib/plaid/models/individual_name.rb +1 -1
  688. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  689. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  690. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  691. data/lib/plaid/models/inflow_model.rb +1 -1
  692. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  693. data/lib/plaid/models/institution.rb +1 -1
  694. data/lib/plaid/models/institution_status.rb +1 -1
  695. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  696. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  697. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  698. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  699. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  700. data/lib/plaid/models/institutions_get_request.rb +1 -1
  701. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  702. data/lib/plaid/models/institutions_get_response.rb +1 -1
  703. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  704. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  705. data/lib/plaid/models/institutions_search_request.rb +1 -1
  706. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  707. data/lib/plaid/models/institutions_search_response.rb +1 -1
  708. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  709. data/lib/plaid/models/investment_filter.rb +1 -1
  710. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  711. data/lib/plaid/models/investment_transaction.rb +1 -1
  712. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  713. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  714. data/lib/plaid/models/investments_auth_data_sources.rb +260 -0
  715. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  716. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  717. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  718. data/lib/plaid/models/investments_auth_get_response.rb +16 -2
  719. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  720. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  721. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  722. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  723. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  724. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  725. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  726. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  727. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  728. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  729. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  730. data/lib/plaid/models/iso_currency_code.rb +1 -1
  731. data/lib/plaid/models/issue.rb +306 -0
  732. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  733. data/lib/plaid/models/issues_get_request.rb +246 -0
  734. data/lib/plaid/models/issues_get_response.rb +230 -0
  735. data/lib/plaid/models/issues_search_request.rb +261 -0
  736. data/lib/plaid/models/issues_search_response.rb +233 -0
  737. data/lib/plaid/models/issues_status.rb +43 -0
  738. data/lib/plaid/models/issues_subscribe_request.rb +256 -0
  739. data/lib/plaid/models/issues_subscribe_response.rb +226 -0
  740. data/lib/plaid/models/issuing_country.rb +1 -1
  741. data/lib/plaid/models/item.rb +38 -4
  742. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  743. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  744. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  745. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  746. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  747. data/lib/plaid/models/item_application_list_request.rb +1 -1
  748. data/lib/plaid/models/item_application_list_response.rb +1 -1
  749. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  750. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  751. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  752. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  753. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  754. data/lib/plaid/models/item_consented_data_scope.rb +45 -0
  755. data/lib/plaid/models/item_error_webhook.rb +1 -1
  756. data/lib/plaid/models/item_get_request.rb +1 -1
  757. data/lib/plaid/models/item_get_response.rb +1 -1
  758. data/lib/plaid/models/item_import_request.rb +1 -1
  759. data/lib/plaid/models/item_import_request_options.rb +1 -1
  760. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  761. data/lib/plaid/models/item_import_response.rb +1 -1
  762. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  763. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  764. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  765. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  766. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  767. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  768. data/lib/plaid/models/item_remove_request.rb +1 -1
  769. data/lib/plaid/models/item_remove_response.rb +1 -1
  770. data/lib/plaid/models/item_status.rb +1 -1
  771. data/lib/plaid/models/item_status_investments.rb +1 -1
  772. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  773. data/lib/plaid/models/item_status_nullable.rb +1 -1
  774. data/lib/plaid/models/item_status_transactions.rb +1 -1
  775. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  776. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  777. data/lib/plaid/models/jwk_public_key.rb +1 -1
  778. data/lib/plaid/models/jwt_header.rb +1 -1
  779. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  780. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  781. data/lib/plaid/models/kyc_check_details.rb +2 -2
  782. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  783. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  784. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  785. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  786. data/lib/plaid/models/last_data_access_times.rb +1 -1
  787. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  788. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  789. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  790. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  791. data/lib/plaid/models/liabilities_object.rb +1 -1
  792. data/lib/plaid/models/liability_override.rb +1 -1
  793. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  794. data/lib/plaid/models/link_delivery_account.rb +1 -1
  795. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  796. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  797. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  798. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  799. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  800. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  801. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  802. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  803. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  804. data/lib/plaid/models/link_delivery_options.rb +1 -1
  805. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  806. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  807. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  808. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  809. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  810. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  811. data/lib/plaid/models/link_event.rb +1 -1
  812. data/lib/plaid/models/link_event_metadata.rb +2 -7
  813. data/lib/plaid/models/link_event_name.rb +1 -1
  814. data/lib/plaid/models/link_events_webhook.rb +1 -1
  815. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  816. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  817. data/lib/plaid/models/link_profile_eligibility_check_request.rb +1 -1
  818. data/lib/plaid/models/link_profile_eligibility_check_response.rb +1 -1
  819. data/lib/plaid/models/link_profile_eligibility_check_user.rb +1 -1
  820. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  821. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  822. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  823. data/lib/plaid/models/link_session_exit.rb +1 -1
  824. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  825. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  826. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  827. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  828. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  829. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  830. data/lib/plaid/models/link_session_results.rb +21 -1
  831. data/lib/plaid/models/link_session_success.rb +1 -1
  832. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  833. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  834. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  835. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  836. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  837. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  838. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  839. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  840. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  841. data/lib/plaid/models/link_token_create_identity.rb +2 -2
  842. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  843. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  844. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  845. data/lib/plaid/models/link_token_create_request.rb +11 -24
  846. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  847. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  848. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  849. data/lib/plaid/models/link_token_create_request_cra_options.rb +2 -11
  850. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  851. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
  852. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  853. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  854. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  855. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  856. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  857. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  858. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  859. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  860. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  861. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +226 -0
  862. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  863. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  864. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  865. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  866. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  867. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  868. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  869. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  870. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  871. data/lib/plaid/models/link_token_create_response.rb +1 -1
  872. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  873. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  874. data/lib/plaid/models/link_token_get_request.rb +1 -1
  875. data/lib/plaid/models/link_token_get_response.rb +1 -1
  876. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  877. data/lib/plaid/models/link_token_investments.rb +1 -1
  878. data/lib/plaid/models/link_token_investments_auth.rb +2 -2
  879. data/lib/plaid/models/link_token_transactions.rb +1 -1
  880. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  881. data/lib/plaid/models/loan.rb +1 -1
  882. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  883. data/lib/plaid/models/loan_filter.rb +1 -1
  884. data/lib/plaid/models/loan_identifier.rb +1 -1
  885. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  886. data/lib/plaid/models/loan_identifiers.rb +1 -1
  887. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  888. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  889. data/lib/plaid/models/loans.rb +1 -1
  890. data/lib/plaid/models/location.rb +1 -1
  891. data/lib/plaid/models/match_summary.rb +1 -1
  892. data/lib/plaid/models/match_summary_code.rb +1 -1
  893. data/lib/plaid/models/merchant_insights.rb +1 -1
  894. data/lib/plaid/models/meta.rb +1 -1
  895. data/lib/plaid/models/mfa.rb +1 -1
  896. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +39 -0
  897. data/lib/plaid/models/monitoring_income_insights.rb +16 -2
  898. data/lib/plaid/models/monitoring_income_source.rb +5 -20
  899. data/lib/plaid/models/monitoring_insights.rb +1 -1
  900. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  901. data/lib/plaid/models/monitoring_insights_status.rb +42 -0
  902. data/lib/plaid/models/monitoring_insights_webhook.rb +18 -4
  903. data/lib/plaid/models/monitoring_item_status_code.rb +2 -1
  904. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  905. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  906. data/lib/plaid/models/mortgage_liability.rb +1 -1
  907. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  908. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  909. data/lib/plaid/models/name_match_score.rb +1 -1
  910. data/lib/plaid/models/net_pay.rb +1 -1
  911. data/lib/plaid/models/network_insights_item.rb +1 -1
  912. data/lib/plaid/models/network_insights_report.rb +1 -1
  913. data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
  914. data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
  915. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  916. data/lib/plaid/models/numbers.rb +1 -1
  917. data/lib/plaid/models/numbers_acats.rb +2 -2
  918. data/lib/plaid/models/numbers_ach.rb +3 -3
  919. data/lib/plaid/models/numbers_ach_nullable.rb +3 -3
  920. data/lib/plaid/models/numbers_aton.rb +1 -1
  921. data/lib/plaid/models/numbers_bacs.rb +1 -1
  922. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  923. data/lib/plaid/models/numbers_eft.rb +1 -1
  924. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  925. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  926. data/lib/plaid/models/numbers_international.rb +1 -1
  927. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  928. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  929. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  930. data/lib/plaid/models/option_contract.rb +1 -1
  931. data/lib/plaid/models/originator.rb +1 -1
  932. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  933. data/lib/plaid/models/other_account_subtype.rb +1 -1
  934. data/lib/plaid/models/other_filter.rb +1 -1
  935. data/lib/plaid/models/override_account_type.rb +1 -1
  936. data/lib/plaid/models/override_accounts.rb +1 -1
  937. data/lib/plaid/models/owner.rb +1 -1
  938. data/lib/plaid/models/owner_override.rb +1 -1
  939. data/lib/plaid/models/ownership_type.rb +1 -1
  940. data/lib/plaid/models/parties.rb +1 -1
  941. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  942. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  943. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  944. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  945. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  946. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  947. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  948. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  949. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  950. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  951. data/lib/plaid/models/partner_end_customer.rb +1 -1
  952. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  953. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  954. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  955. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  956. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  957. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  958. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  959. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  960. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  961. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  962. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  963. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  964. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  965. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  966. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  967. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  968. data/lib/plaid/models/party.rb +1 -1
  969. data/lib/plaid/models/party_individual.rb +1 -1
  970. data/lib/plaid/models/party_role_type.rb +1 -1
  971. data/lib/plaid/models/pay.rb +1 -1
  972. data/lib/plaid/models/pay_frequency.rb +1 -1
  973. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  974. data/lib/plaid/models/pay_period_details.rb +1 -1
  975. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  976. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  977. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  978. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  979. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  980. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  981. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  982. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  983. data/lib/plaid/models/payment_amount.rb +1 -1
  984. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  985. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  986. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  987. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  988. data/lib/plaid/models/payment_channel.rb +1 -1
  989. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  990. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  991. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  992. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  993. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  994. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  995. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  996. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  997. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  998. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  999. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1000. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1001. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  1002. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +36 -5
  1003. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1004. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +39 -0
  1005. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1006. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1007. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1008. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1009. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1010. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1011. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  1012. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1013. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1014. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1015. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1016. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  1017. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1018. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1019. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1020. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1021. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1022. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1023. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1024. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1025. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1026. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1027. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1028. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1029. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1030. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1031. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1032. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1033. data/lib/plaid/models/payment_meta.rb +1 -1
  1034. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1035. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1036. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1037. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1038. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1039. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1040. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1041. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1042. data/lib/plaid/models/payment_scheme.rb +1 -1
  1043. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1044. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1045. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1046. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1047. data/lib/plaid/models/payroll_item.rb +1 -1
  1048. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1049. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1050. data/lib/plaid/models/paystub.rb +1 -1
  1051. data/lib/plaid/models/paystub_address.rb +1 -1
  1052. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1053. data/lib/plaid/models/paystub_details.rb +1 -1
  1054. data/lib/plaid/models/paystub_employer.rb +1 -1
  1055. data/lib/plaid/models/paystub_override.rb +1 -1
  1056. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1057. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1058. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1059. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1060. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1061. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1062. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1063. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1064. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1065. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1066. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1067. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1068. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1069. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1070. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1071. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1072. data/lib/plaid/models/pending_disconnect_webhook.rb +2 -2
  1073. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1074. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1075. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1076. data/lib/plaid/models/phone_number.rb +1 -1
  1077. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1078. data/lib/plaid/models/phone_type.rb +1 -1
  1079. data/lib/plaid/models/physical_document_category.rb +1 -1
  1080. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1081. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1082. data/lib/plaid/models/physical_document_images.rb +1 -1
  1083. data/lib/plaid/models/plaid_check_score.rb +1 -1
  1084. data/lib/plaid/models/plaid_error.rb +1 -1
  1085. data/lib/plaid/models/plaid_error_type.rb +1 -1
  1086. data/lib/plaid/models/platform_ids.rb +1 -1
  1087. data/lib/plaid/models/po_box_status.rb +1 -1
  1088. data/lib/plaid/models/prism_cash_score.rb +15 -5
  1089. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1090. data/lib/plaid/models/prism_cash_score_version.rb +1 -1
  1091. data/lib/plaid/models/prism_first_detect.rb +15 -5
  1092. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1093. data/lib/plaid/models/prism_insights.rb +15 -5
  1094. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1095. data/lib/plaid/models/prism_product.rb +1 -1
  1096. data/lib/plaid/models/prism_versions.rb +1 -1
  1097. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1098. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1099. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1100. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1101. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1102. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1103. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1104. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1105. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1106. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1107. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1108. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1109. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1110. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1111. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1112. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1113. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1114. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1115. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1116. data/lib/plaid/models/processor_number.rb +1 -1
  1117. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1118. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1119. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1120. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1121. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1122. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1123. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1124. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1125. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1126. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1127. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1128. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1129. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1130. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1131. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1132. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1133. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1134. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1135. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1136. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1137. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1138. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1139. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1140. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1141. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1142. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1143. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1144. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1145. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1146. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1147. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1148. data/lib/plaid/models/product_access.rb +1 -1
  1149. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1150. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1151. data/lib/plaid/models/product_status.rb +1 -1
  1152. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1153. data/lib/plaid/models/products.rb +2 -2
  1154. data/lib/plaid/models/profile_get_request.rb +1 -1
  1155. data/lib/plaid/models/profile_get_response.rb +1 -1
  1156. data/lib/plaid/models/profile_identity.rb +1 -1
  1157. data/lib/plaid/models/profile_identity_address.rb +1 -1
  1158. data/lib/plaid/models/profile_identity_name.rb +1 -1
  1159. data/lib/plaid/models/profile_item.rb +1 -1
  1160. data/lib/plaid/models/profile_network_status_get_network_status.rb +1 -1
  1161. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1162. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1163. data/lib/plaid/models/profile_network_status_get_user.rb +1 -1
  1164. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1165. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1166. data/lib/plaid/models/proxy_type.rb +1 -1
  1167. data/lib/plaid/models/pslf_status.rb +1 -1
  1168. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1169. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1170. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1171. data/lib/plaid/models/recurrence.rb +1 -1
  1172. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1173. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1174. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1175. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1176. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1177. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1178. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1179. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1180. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1181. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1182. data/lib/plaid/models/removed_transaction.rb +1 -1
  1183. data/lib/plaid/models/report_type.rb +1 -1
  1184. data/lib/plaid/models/reporting_information.rb +1 -1
  1185. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1186. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1187. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1188. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1189. data/lib/plaid/models/risk_check_details.rb +1 -1
  1190. data/lib/plaid/models/risk_check_device.rb +1 -1
  1191. data/lib/plaid/models/risk_check_email.rb +1 -1
  1192. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1193. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1194. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1195. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1196. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1197. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1198. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1199. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1200. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1201. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1202. data/lib/plaid/models/risk_profile.rb +1 -1
  1203. data/lib/plaid/models/risk_reason.rb +2 -2
  1204. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1205. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1206. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1207. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1208. data/lib/plaid/models/role.rb +1 -1
  1209. data/lib/plaid/models/role_detail.rb +1 -1
  1210. data/lib/plaid/models/roles.rb +1 -1
  1211. data/lib/plaid/models/ruleset.rb +1 -1
  1212. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1213. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1214. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1215. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1216. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1217. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1218. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1219. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1220. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1221. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1222. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1223. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  1224. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1225. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1226. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1227. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1228. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1229. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1230. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1231. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1232. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1233. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1234. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1235. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1236. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1237. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1238. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1239. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1240. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1241. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1242. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1243. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1244. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1245. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1246. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  1247. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1248. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1249. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1250. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1251. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1252. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1253. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1254. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1255. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1256. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1257. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1258. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1259. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1260. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1261. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1262. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1263. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1264. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1265. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1266. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1267. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1268. data/lib/plaid/models/scopes.rb +1 -1
  1269. data/lib/plaid/models/scopes_context.rb +1 -1
  1270. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1271. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1272. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1273. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1274. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1275. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1276. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1277. data/lib/plaid/models/security.rb +1 -1
  1278. data/lib/plaid/models/security_override.rb +1 -1
  1279. data/lib/plaid/models/selfie_analysis.rb +29 -5
  1280. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1281. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +401 -0
  1282. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +39 -0
  1283. data/lib/plaid/models/selfie_analysis_liveness_check.rb +39 -0
  1284. data/lib/plaid/models/selfie_capture.rb +1 -1
  1285. data/lib/plaid/models/selfie_check.rb +1 -1
  1286. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1287. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1288. data/lib/plaid/models/selfie_status.rb +1 -1
  1289. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1290. data/lib/plaid/models/service.rb +1 -1
  1291. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1292. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1293. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1294. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1295. data/lib/plaid/models/services.rb +1 -1
  1296. data/lib/plaid/models/signal_address_data.rb +1 -1
  1297. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1298. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1299. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1300. data/lib/plaid/models/signal_device.rb +1 -1
  1301. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1302. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1303. data/lib/plaid/models/signal_evaluate_response.rb +2 -2
  1304. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1305. data/lib/plaid/models/signal_person_name.rb +1 -1
  1306. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1307. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1308. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1309. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1310. data/lib/plaid/models/signal_scores.rb +1 -1
  1311. data/lib/plaid/models/signal_user.rb +1 -1
  1312. data/lib/plaid/models/signal_warning.rb +1 -1
  1313. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1314. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1315. data/lib/plaid/models/source.rb +1 -1
  1316. data/lib/plaid/models/standalone_account_type.rb +7 -7
  1317. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1318. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1319. data/lib/plaid/models/statements_account.rb +1 -1
  1320. data/lib/plaid/models/statements_download_request.rb +1 -1
  1321. data/lib/plaid/models/statements_list_request.rb +1 -1
  1322. data/lib/plaid/models/statements_list_response.rb +1 -1
  1323. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1324. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1325. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1326. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1327. data/lib/plaid/models/statements_statement.rb +1 -1
  1328. data/lib/plaid/models/status.rb +1 -1
  1329. data/lib/plaid/models/statuses.rb +1 -1
  1330. data/lib/plaid/models/strategy.rb +1 -1
  1331. data/lib/plaid/models/student_loan.rb +1 -1
  1332. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1333. data/lib/plaid/models/student_loan_status.rb +1 -1
  1334. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1335. data/lib/plaid/models/sweep_status.rb +1 -1
  1336. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1337. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1338. data/lib/plaid/models/taxform.rb +1 -1
  1339. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1340. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1341. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1342. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1343. data/lib/plaid/models/total.rb +1 -1
  1344. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1345. data/lib/plaid/models/total_monthly_income_insights.rb +1 -1
  1346. data/lib/plaid/models/transaction.rb +2 -2
  1347. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1348. data/lib/plaid/models/transaction_base.rb +2 -2
  1349. data/lib/plaid/models/transaction_code.rb +1 -1
  1350. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1351. data/lib/plaid/models/transaction_data.rb +1 -1
  1352. data/lib/plaid/models/transaction_override.rb +1 -1
  1353. data/lib/plaid/models/transaction_stream.rb +13 -2
  1354. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1355. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1356. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1357. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1358. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1359. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1360. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1361. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1362. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1363. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1364. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1365. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1366. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1367. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1368. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1369. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1370. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1371. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1372. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1373. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1374. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1375. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1376. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1377. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1378. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1379. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1380. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1381. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1382. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1383. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1384. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1385. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1386. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1387. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1388. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1389. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1390. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  1391. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1392. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1393. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1394. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1395. data/lib/plaid/models/transfer.rb +2 -2
  1396. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1397. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1398. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1399. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1400. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  1401. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1402. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1403. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1404. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1405. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1406. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1407. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1408. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1409. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1410. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1411. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1412. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1413. data/lib/plaid/models/transfer_balance.rb +1 -1
  1414. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1415. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1416. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1417. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1418. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1419. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1420. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1421. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1422. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1423. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1424. data/lib/plaid/models/transfer_create_request.rb +1 -1
  1425. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1426. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1427. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1428. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1429. data/lib/plaid/models/transfer_device.rb +1 -1
  1430. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1431. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1432. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1433. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1434. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1435. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1436. data/lib/plaid/models/transfer_event.rb +1 -1
  1437. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1438. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1439. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1440. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1441. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1442. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1443. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1444. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1445. data/lib/plaid/models/transfer_failure.rb +1 -1
  1446. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1447. data/lib/plaid/models/transfer_get_request.rb +12 -7
  1448. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1449. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1450. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1451. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1452. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1453. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1454. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1455. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1456. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1457. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1458. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1459. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1460. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1461. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  1462. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1463. data/lib/plaid/models/transfer_ledger_distribute_request.rb +22 -22
  1464. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1465. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1466. data/lib/plaid/models/transfer_ledger_get_response.rb +47 -2
  1467. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1468. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  1469. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1470. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1471. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1472. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1473. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1474. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1475. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1476. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1477. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1478. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1479. data/lib/plaid/models/transfer_network.rb +1 -1
  1480. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1481. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1482. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1483. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1484. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1485. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1486. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1487. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1488. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1489. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1490. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1491. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1492. data/lib/plaid/models/transfer_platform_person_address.rb +296 -0
  1493. data/lib/plaid/models/transfer_platform_person_create_request.rb +313 -0
  1494. data/lib/plaid/models/transfer_platform_person_create_response.rb +241 -0
  1495. data/lib/plaid/models/transfer_platform_person_id_number.rb +262 -0
  1496. data/lib/plaid/models/transfer_platform_person_name.rb +241 -0
  1497. data/lib/plaid/models/transfer_platform_requirement_submission.rb +251 -0
  1498. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +285 -0
  1499. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +226 -0
  1500. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1501. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1502. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1503. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1504. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1505. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1506. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1507. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1508. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1509. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1510. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1511. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1512. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1513. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1514. data/lib/plaid/models/transfer_refund.rb +1 -1
  1515. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1516. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1517. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1518. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1519. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1520. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1521. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1522. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1523. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1524. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1525. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1526. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1527. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1528. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1529. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1530. data/lib/plaid/models/transfer_status.rb +1 -1
  1531. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1532. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1533. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1534. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1535. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1536. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1537. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1538. data/lib/plaid/models/transfer_type.rb +1 -1
  1539. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1540. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1541. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1542. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1543. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1544. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1545. data/lib/plaid/models/trusted_device_data.rb +229 -0
  1546. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +2 -2
  1547. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1548. data/lib/plaid/models/user_account_identity.rb +1 -1
  1549. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1550. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1551. data/lib/plaid/models/user_account_item.rb +1 -1
  1552. data/lib/plaid/models/user_account_revoked_webhook.rb +2 -2
  1553. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1554. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1555. data/lib/plaid/models/user_address.rb +1 -1
  1556. data/lib/plaid/models/user_create_request.rb +38 -2
  1557. data/lib/plaid/models/user_create_response.rb +1 -1
  1558. data/lib/plaid/models/user_custom_password.rb +1 -1
  1559. data/lib/plaid/models/user_data_overview.rb +1 -1
  1560. data/lib/plaid/models/user_id_number.rb +1 -1
  1561. data/lib/plaid/models/user_items_get_request.rb +1 -1
  1562. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1563. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1564. data/lib/plaid/models/user_remove_request.rb +1 -1
  1565. data/lib/plaid/models/user_remove_response.rb +1 -1
  1566. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1567. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1568. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1569. data/lib/plaid/models/user_third_party_token_create_request.rb +272 -0
  1570. data/lib/plaid/models/user_third_party_token_create_response.rb +241 -0
  1571. data/lib/plaid/models/user_third_party_token_remove_request.rb +246 -0
  1572. data/lib/plaid/models/user_third_party_token_remove_response.rb +241 -0
  1573. data/lib/plaid/models/user_update_request.rb +1 -1
  1574. data/lib/plaid/models/user_update_response.rb +1 -1
  1575. data/lib/plaid/models/validation_source.rb +1 -1
  1576. data/lib/plaid/models/validation_sources.rb +1 -1
  1577. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1578. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1579. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1580. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1581. data/lib/plaid/models/verification_status.rb +1 -1
  1582. data/lib/plaid/models/w2.rb +1 -1
  1583. data/lib/plaid/models/w2_box12.rb +1 -1
  1584. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1585. data/lib/plaid/models/w2_override.rb +1 -1
  1586. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1587. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1588. data/lib/plaid/models/wallet.rb +1 -1
  1589. data/lib/plaid/models/wallet_balance.rb +1 -1
  1590. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1591. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1592. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1593. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1594. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1595. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1596. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1597. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1598. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1599. data/lib/plaid/models/wallet_status.rb +1 -1
  1600. data/lib/plaid/models/wallet_transaction.rb +1 -1
  1601. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1602. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1603. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1604. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1605. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1606. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1607. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1608. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1609. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1610. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  1611. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1612. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1613. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1614. data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
  1615. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1616. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1617. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1618. data/lib/plaid/models/warning.rb +1 -1
  1619. data/lib/plaid/models/watchlist_screening_audit_trail.rb +2 -2
  1620. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1621. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1622. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1623. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
  1624. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1625. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
  1626. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1627. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1628. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1629. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1630. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
  1631. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1632. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1633. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1634. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1635. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1636. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1637. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1638. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1639. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1640. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
  1641. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1642. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
  1643. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1644. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1645. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1646. data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
  1647. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1648. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
  1649. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1650. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
  1651. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1652. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1653. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1654. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1655. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +2 -2
  1656. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1657. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1658. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1659. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1660. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1661. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1662. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1663. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1664. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1665. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
  1666. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1667. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
  1668. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1669. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1670. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1671. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1672. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1673. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1674. data/lib/plaid/models/webhook_type.rb +1 -1
  1675. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1676. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1677. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1678. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1679. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1680. data/lib/plaid/version.rb +2 -2
  1681. data/lib/plaid.rb +42 -2
  1682. data/plaid.gemspec +1 -1
  1683. data/test/test_item.rb +1 -0
  1684. metadata +43 -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.556.0
6
+ The version of the OpenAPI document: 2020-09-14_1.575.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -88,7 +88,7 @@ module Plaid
88
88
  end
89
89
 
90
90
  # Retrieve accounts
91
- # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
91
+ # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
92
92
  # @param accounts_get_request [AccountsGetRequest]
93
93
  # @param [Hash] opts the optional parameters
94
94
  # @return [AccountsGetResponse]
@@ -98,7 +98,7 @@ module Plaid
98
98
  end
99
99
 
100
100
  # Retrieve accounts
101
- # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
101
+ # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
102
102
  # @param accounts_get_request [AccountsGetRequest]
103
103
  # @param [Hash] opts the optional parameters
104
104
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -2535,6 +2535,74 @@ module Plaid
2535
2535
  return data, status_code, headers
2536
2536
  end
2537
2537
 
2538
+ # List a historical log of item consent events
2539
+ # List a historical log of item consent events
2540
+ # @param consent_events_get_request [ConsentEventsGetRequest]
2541
+ # @param [Hash] opts the optional parameters
2542
+ # @return [ConsentEventsGetResponse]
2543
+ def consent_events_get(consent_events_get_request, opts = {})
2544
+ data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
2545
+ data
2546
+ end
2547
+
2548
+ # List a historical log of item consent events
2549
+ # List a historical log of item consent events
2550
+ # @param consent_events_get_request [ConsentEventsGetRequest]
2551
+ # @param [Hash] opts the optional parameters
2552
+ # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
2553
+ def consent_events_get_with_http_info(consent_events_get_request, opts = {})
2554
+ if @api_client.config.debugging
2555
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
2556
+ end
2557
+ # verify the required parameter 'consent_events_get_request' is set
2558
+ if @api_client.config.client_side_validation && consent_events_get_request.nil?
2559
+ fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
2560
+ end
2561
+ # resource path
2562
+ local_var_path = '/consent/events/get'
2563
+
2564
+ # query parameters
2565
+ query_params = opts[:query_params] || {}
2566
+
2567
+ # header parameters
2568
+ header_params = opts[:header_params] || {}
2569
+ # HTTP header 'Accept' (if needed)
2570
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2571
+ # HTTP header 'Content-Type'
2572
+ content_type = @api_client.select_header_content_type(['application/json'])
2573
+ if !content_type.nil?
2574
+ header_params['Content-Type'] = content_type
2575
+ end
2576
+
2577
+ # form parameters
2578
+ form_params = opts[:form_params] || {}
2579
+
2580
+ # http body (model)
2581
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)
2582
+
2583
+ # return_type
2584
+ return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
2585
+
2586
+ # auth_names
2587
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2588
+
2589
+ new_options = opts.merge(
2590
+ :operation => :"PlaidApi.consent_events_get",
2591
+ :header_params => header_params,
2592
+ :query_params => query_params,
2593
+ :form_params => form_params,
2594
+ :body => post_body,
2595
+ :auth_names => auth_names,
2596
+ :return_type => return_type
2597
+ )
2598
+
2599
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2600
+ if @api_client.config.debugging
2601
+ @api_client.config.logger.debug "API called: PlaidApi#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2602
+ end
2603
+ return data, status_code, headers
2604
+ end
2605
+
2538
2606
  # Retrieve a PDF Reports
2539
2607
  # 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.
2540
2608
  # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
@@ -2944,7 +3012,7 @@ module Plaid
2944
3012
  end
2945
3013
 
2946
3014
  # 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.
3015
+ # `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. If you did provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report. `/cra/check_report/create` can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it. Note that refreshing or regenerating a report is a billable event.\"
2948
3016
  # @param cra_check_report_create_request [CraCheckReportCreateRequest]
2949
3017
  # @param [Hash] opts the optional parameters
2950
3018
  # @return [CraCheckReportCreateResponse]
@@ -2954,7 +3022,7 @@ module Plaid
2954
3022
  end
2955
3023
 
2956
3024
  # 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.
3025
+ # &#x60;/cra/check_report/create&#x60; creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if &#x60;consumer_report_permissible_purpose&#x60; was omitted during Link token creation. If you did provide a &#x60;consumer_report_permissible_purpose&#x60; during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call &#x60;/cra/check_report/create&#x60; before retrieving the report. &#x60;/cra/check_report/create&#x60; can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any &#x60;/get&#x60; endpoints on the report before it expires. If a report expires, you can call &#x60;/cra/check_report/create&#x60; again to re-generate it. Note that refreshing or regenerating a report is a billable event.\&quot;
2958
3026
  # @param cra_check_report_create_request [CraCheckReportCreateRequest]
2959
3027
  # @param [Hash] opts the optional parameters
2960
3028
  # @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
@@ -3216,7 +3284,7 @@ module Plaid
3216
3284
  end
3217
3285
 
3218
3286
  # Retrieve Consumer Reports as a PDF
3219
- # `/cra/check_report/pdf/get` retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
3287
+ # `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the `add-ons` field.
3220
3288
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
3221
3289
  # @param [Hash] opts the optional parameters
3222
3290
  # @return [File]
@@ -3226,7 +3294,7 @@ module Plaid
3226
3294
  end
3227
3295
 
3228
3296
  # Retrieve Consumer Reports as a PDF
3229
- # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
3297
+ # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the &#x60;add-ons&#x60; field.
3230
3298
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
3231
3299
  # @param [Hash] opts the optional parameters
3232
3300
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -5460,7 +5528,7 @@ module Plaid
5460
5528
  end
5461
5529
 
5462
5530
  # Retrieve a dashboard user
5463
- # Retrieve information about a dashboard user.
5531
+ # The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
5464
5532
  # @param dashboard_user_get_request [DashboardUserGetRequest]
5465
5533
  # @param [Hash] opts the optional parameters
5466
5534
  # @return [DashboardUserGetResponse]
@@ -5470,7 +5538,7 @@ module Plaid
5470
5538
  end
5471
5539
 
5472
5540
  # Retrieve a dashboard user
5473
- # Retrieve information about a dashboard user.
5541
+ # The &#x60;/dashboard_user/get&#x60; endpoint provides details (such as email address) about a specific Dashboard user based on the &#x60;dashboard_user_id&#x60; field, which is returned in the &#x60;audit_trail&#x60; object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
5474
5542
  # @param dashboard_user_get_request [DashboardUserGetRequest]
5475
5543
  # @param [Hash] opts the optional parameters
5476
5544
  # @return [Array<(DashboardUserGetResponse, Integer, Hash)>] DashboardUserGetResponse data, response status code and response headers
@@ -5528,7 +5596,7 @@ module Plaid
5528
5596
  end
5529
5597
 
5530
5598
  # List dashboard users
5531
- # List all dashboard users associated with your account.
5599
+ # The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
5532
5600
  # @param dashboard_user_list_request [DashboardUserListRequest]
5533
5601
  # @param [Hash] opts the optional parameters
5534
5602
  # @return [DashboardUserListResponse]
@@ -5538,7 +5606,7 @@ module Plaid
5538
5606
  end
5539
5607
 
5540
5608
  # List dashboard users
5541
- # List all dashboard users associated with your account.
5609
+ # The &#x60;/dashboard_user/list&#x60; endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
5542
5610
  # @param dashboard_user_list_request [DashboardUserListRequest]
5543
5611
  # @param [Hash] opts the optional parameters
5544
5612
  # @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
@@ -5595,7 +5663,7 @@ module Plaid
5595
5663
  return data, status_code, headers
5596
5664
  end
5597
5665
 
5598
- # Create a deposit switch without using Plaid Exchange
5666
+ # (Deprecated) Create a deposit switch without using Plaid Exchange
5599
5667
  # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5600
5668
  # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5601
5669
  # @param [Hash] opts the optional parameters
@@ -5605,7 +5673,7 @@ module Plaid
5605
5673
  data
5606
5674
  end
5607
5675
 
5608
- # Create a deposit switch without using Plaid Exchange
5676
+ # (Deprecated) Create a deposit switch without using Plaid Exchange
5609
5677
  # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5610
5678
  # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5611
5679
  # @param [Hash] opts the optional parameters
@@ -5663,7 +5731,7 @@ module Plaid
5663
5731
  return data, status_code, headers
5664
5732
  end
5665
5733
 
5666
- # Create a deposit switch
5734
+ # (Deprecated) Create a deposit switch
5667
5735
  # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5668
5736
  # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5669
5737
  # @param [Hash] opts the optional parameters
@@ -5673,7 +5741,7 @@ module Plaid
5673
5741
  data
5674
5742
  end
5675
5743
 
5676
- # Create a deposit switch
5744
+ # (Deprecated) Create a deposit switch
5677
5745
  # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5678
5746
  # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5679
5747
  # @param [Hash] opts the optional parameters
@@ -5731,7 +5799,7 @@ module Plaid
5731
5799
  return data, status_code, headers
5732
5800
  end
5733
5801
 
5734
- # Retrieve a deposit switch
5802
+ # (Deprecated) Retrieve a deposit switch
5735
5803
  # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
5736
5804
  # @param deposit_switch_get_request [DepositSwitchGetRequest]
5737
5805
  # @param [Hash] opts the optional parameters
@@ -5741,7 +5809,7 @@ module Plaid
5741
5809
  data
5742
5810
  end
5743
5811
 
5744
- # Retrieve a deposit switch
5812
+ # (Deprecated) Retrieve a deposit switch
5745
5813
  # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
5746
5814
  # @param deposit_switch_get_request [DepositSwitchGetRequest]
5747
5815
  # @param [Hash] opts the optional parameters
@@ -5799,7 +5867,7 @@ module Plaid
5799
5867
  return data, status_code, headers
5800
5868
  end
5801
5869
 
5802
- # Create a deposit switch token
5870
+ # (Deprecated) Create a deposit switch token
5803
5871
  # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
5804
5872
  # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5805
5873
  # @param [Hash] opts the optional parameters
@@ -5809,7 +5877,7 @@ module Plaid
5809
5877
  data
5810
5878
  end
5811
5879
 
5812
- # Create a deposit switch token
5880
+ # (Deprecated) Create a deposit switch token
5813
5881
  # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
5814
5882
  # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5815
5883
  # @param [Hash] opts the optional parameters
@@ -6195,7 +6263,7 @@ module Plaid
6195
6263
  end
6196
6264
 
6197
6265
  # Returns uploaded document identity
6198
- # Use `/identity/documents/uploads/get` to retrieve document uploaded identity.
6266
+ # Use `/identity/documents/uploads/get` to retrieve identity details when using [Identity Document Upload](https://plaid.com/docs/identity/identity-document-upload/).
6199
6267
  # @param identity_documents_uploads_get_request [IdentityDocumentsUploadsGetRequest]
6200
6268
  # @param [Hash] opts the optional parameters
6201
6269
  # @return [IdentityDocumentsUploadsGetResponse]
@@ -6205,7 +6273,7 @@ module Plaid
6205
6273
  end
6206
6274
 
6207
6275
  # Returns uploaded document identity
6208
- # Use &#x60;/identity/documents/uploads/get&#x60; to retrieve document uploaded identity.
6276
+ # Use &#x60;/identity/documents/uploads/get&#x60; to retrieve identity details when using [Identity Document Upload](https://plaid.com/docs/identity/identity-document-upload/).
6209
6277
  # @param identity_documents_uploads_get_request [IdentityDocumentsUploadsGetRequest]
6210
6278
  # @param [Hash] opts the optional parameters
6211
6279
  # @return [Array<(IdentityDocumentsUploadsGetResponse, Integer, Hash)>] IdentityDocumentsUploadsGetResponse data, response status code and response headers
@@ -7622,6 +7690,210 @@ module Plaid
7622
7690
  return data, status_code, headers
7623
7691
  end
7624
7692
 
7693
+ # Get an Issue
7694
+ # Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object.
7695
+ # @param issues_get_request [IssuesGetRequest]
7696
+ # @param [Hash] opts the optional parameters
7697
+ # @return [IssuesGetResponse]
7698
+ def issues_get(issues_get_request, opts = {})
7699
+ data, _status_code, _headers = issues_get_with_http_info(issues_get_request, opts)
7700
+ data
7701
+ end
7702
+
7703
+ # Get an Issue
7704
+ # Retrieve detailed information about a specific &#x60;Issue&#x60;. This endpoint returns a single &#x60;Issue&#x60; object.
7705
+ # @param issues_get_request [IssuesGetRequest]
7706
+ # @param [Hash] opts the optional parameters
7707
+ # @return [Array<(IssuesGetResponse, Integer, Hash)>] IssuesGetResponse data, response status code and response headers
7708
+ def issues_get_with_http_info(issues_get_request, opts = {})
7709
+ if @api_client.config.debugging
7710
+ @api_client.config.logger.debug 'Calling API: PlaidApi.issues_get ...'
7711
+ end
7712
+ # verify the required parameter 'issues_get_request' is set
7713
+ if @api_client.config.client_side_validation && issues_get_request.nil?
7714
+ fail ArgumentError, "Missing the required parameter 'issues_get_request' when calling PlaidApi.issues_get"
7715
+ end
7716
+ # resource path
7717
+ local_var_path = '/issues/get'
7718
+
7719
+ # query parameters
7720
+ query_params = opts[:query_params] || {}
7721
+
7722
+ # header parameters
7723
+ header_params = opts[:header_params] || {}
7724
+ # HTTP header 'Accept' (if needed)
7725
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7726
+ # HTTP header 'Content-Type'
7727
+ content_type = @api_client.select_header_content_type(['application/json'])
7728
+ if !content_type.nil?
7729
+ header_params['Content-Type'] = content_type
7730
+ end
7731
+
7732
+ # form parameters
7733
+ form_params = opts[:form_params] || {}
7734
+
7735
+ # http body (model)
7736
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_get_request)
7737
+
7738
+ # return_type
7739
+ return_type = opts[:debug_return_type] || 'IssuesGetResponse'
7740
+
7741
+ # auth_names
7742
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7743
+
7744
+ new_options = opts.merge(
7745
+ :operation => :"PlaidApi.issues_get",
7746
+ :header_params => header_params,
7747
+ :query_params => query_params,
7748
+ :form_params => form_params,
7749
+ :body => post_body,
7750
+ :auth_names => auth_names,
7751
+ :return_type => return_type
7752
+ )
7753
+
7754
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7755
+ if @api_client.config.debugging
7756
+ @api_client.config.logger.debug "API called: PlaidApi#issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7757
+ end
7758
+ return data, status_code, headers
7759
+ end
7760
+
7761
+ # Search for an Issue
7762
+ # Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
7763
+ # @param issues_search_request [IssuesSearchRequest]
7764
+ # @param [Hash] opts the optional parameters
7765
+ # @return [IssuesSearchResponse]
7766
+ def issues_search(issues_search_request, opts = {})
7767
+ data, _status_code, _headers = issues_search_with_http_info(issues_search_request, opts)
7768
+ data
7769
+ end
7770
+
7771
+ # Search for an Issue
7772
+ # Search for an issue associated with one of the following identifiers: &#x60;item_id&#x60;, &#x60;link_session_id&#x60; or Link session &#x60;request_id&#x60;. This endpoint returns a list of &#x60;Issue&#x60; objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
7773
+ # @param issues_search_request [IssuesSearchRequest]
7774
+ # @param [Hash] opts the optional parameters
7775
+ # @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
7776
+ def issues_search_with_http_info(issues_search_request, opts = {})
7777
+ if @api_client.config.debugging
7778
+ @api_client.config.logger.debug 'Calling API: PlaidApi.issues_search ...'
7779
+ end
7780
+ # verify the required parameter 'issues_search_request' is set
7781
+ if @api_client.config.client_side_validation && issues_search_request.nil?
7782
+ fail ArgumentError, "Missing the required parameter 'issues_search_request' when calling PlaidApi.issues_search"
7783
+ end
7784
+ # resource path
7785
+ local_var_path = '/issues/search'
7786
+
7787
+ # query parameters
7788
+ query_params = opts[:query_params] || {}
7789
+
7790
+ # header parameters
7791
+ header_params = opts[:header_params] || {}
7792
+ # HTTP header 'Accept' (if needed)
7793
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7794
+ # HTTP header 'Content-Type'
7795
+ content_type = @api_client.select_header_content_type(['application/json'])
7796
+ if !content_type.nil?
7797
+ header_params['Content-Type'] = content_type
7798
+ end
7799
+
7800
+ # form parameters
7801
+ form_params = opts[:form_params] || {}
7802
+
7803
+ # http body (model)
7804
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_search_request)
7805
+
7806
+ # return_type
7807
+ return_type = opts[:debug_return_type] || 'IssuesSearchResponse'
7808
+
7809
+ # auth_names
7810
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7811
+
7812
+ new_options = opts.merge(
7813
+ :operation => :"PlaidApi.issues_search",
7814
+ :header_params => header_params,
7815
+ :query_params => query_params,
7816
+ :form_params => form_params,
7817
+ :body => post_body,
7818
+ :auth_names => auth_names,
7819
+ :return_type => return_type
7820
+ )
7821
+
7822
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7823
+ if @api_client.config.debugging
7824
+ @api_client.config.logger.debug "API called: PlaidApi#issues_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7825
+ end
7826
+ return data, status_code, headers
7827
+ end
7828
+
7829
+ # Subscribe to an Issue
7830
+ # Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
7831
+ # @param issues_subscribe_request [IssuesSubscribeRequest]
7832
+ # @param [Hash] opts the optional parameters
7833
+ # @return [IssuesSubscribeResponse]
7834
+ def issues_subscribe(issues_subscribe_request, opts = {})
7835
+ data, _status_code, _headers = issues_subscribe_with_http_info(issues_subscribe_request, opts)
7836
+ data
7837
+ end
7838
+
7839
+ # Subscribe to an Issue
7840
+ # Allows a user to subscribe to updates on a specific &#x60;Issue&#x60; using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
7841
+ # @param issues_subscribe_request [IssuesSubscribeRequest]
7842
+ # @param [Hash] opts the optional parameters
7843
+ # @return [Array<(IssuesSubscribeResponse, Integer, Hash)>] IssuesSubscribeResponse data, response status code and response headers
7844
+ def issues_subscribe_with_http_info(issues_subscribe_request, opts = {})
7845
+ if @api_client.config.debugging
7846
+ @api_client.config.logger.debug 'Calling API: PlaidApi.issues_subscribe ...'
7847
+ end
7848
+ # verify the required parameter 'issues_subscribe_request' is set
7849
+ if @api_client.config.client_side_validation && issues_subscribe_request.nil?
7850
+ fail ArgumentError, "Missing the required parameter 'issues_subscribe_request' when calling PlaidApi.issues_subscribe"
7851
+ end
7852
+ # resource path
7853
+ local_var_path = '/issues/subscribe'
7854
+
7855
+ # query parameters
7856
+ query_params = opts[:query_params] || {}
7857
+
7858
+ # header parameters
7859
+ header_params = opts[:header_params] || {}
7860
+ # HTTP header 'Accept' (if needed)
7861
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7862
+ # HTTP header 'Content-Type'
7863
+ content_type = @api_client.select_header_content_type(['application/json'])
7864
+ if !content_type.nil?
7865
+ header_params['Content-Type'] = content_type
7866
+ end
7867
+
7868
+ # form parameters
7869
+ form_params = opts[:form_params] || {}
7870
+
7871
+ # http body (model)
7872
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_subscribe_request)
7873
+
7874
+ # return_type
7875
+ return_type = opts[:debug_return_type] || 'IssuesSubscribeResponse'
7876
+
7877
+ # auth_names
7878
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7879
+
7880
+ new_options = opts.merge(
7881
+ :operation => :"PlaidApi.issues_subscribe",
7882
+ :header_params => header_params,
7883
+ :query_params => query_params,
7884
+ :form_params => form_params,
7885
+ :body => post_body,
7886
+ :auth_names => auth_names,
7887
+ :return_type => return_type
7888
+ )
7889
+
7890
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7891
+ if @api_client.config.debugging
7892
+ @api_client.config.logger.debug "API called: PlaidApi#issues_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7893
+ end
7894
+ return data, status_code, headers
7895
+ end
7896
+
7625
7897
  # Invalidate access_token
7626
7898
  # By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
7627
7899
  # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest]
@@ -9527,7 +9799,7 @@ module Plaid
9527
9799
  end
9528
9800
 
9529
9801
  # Create a payment
9530
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
9802
+ # 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.
9531
9803
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
9532
9804
  # @param [Hash] opts the optional parameters
9533
9805
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -9537,7 +9809,7 @@ module Plaid
9537
9809
  end
9538
9810
 
9539
9811
  # Create a payment
9540
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
9812
+ # 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.
9541
9813
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
9542
9814
  # @param [Hash] opts the optional parameters
9543
9815
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -12043,7 +12315,7 @@ module Plaid
12043
12315
  end
12044
12316
 
12045
12317
  # Fire a test webhook
12046
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
12318
+ # 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` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `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`).
12047
12319
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12048
12320
  # @param [Hash] opts the optional parameters
12049
12321
  # @return [SandboxItemFireWebhookResponse]
@@ -12053,7 +12325,7 @@ module Plaid
12053
12325
  end
12054
12326
 
12055
12327
  # Fire a test webhook
12056
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid sandbox &#x60;DEFAULT_UPDATE&#x60; responses include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type &#x60;TRANSFER&#x60;).
12328
+ # 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; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. &#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;).
12057
12329
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12058
12330
  # @param [Hash] opts the optional parameters
12059
12331
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -14627,7 +14899,7 @@ module Plaid
14627
14899
  end
14628
14900
 
14629
14901
  # Create a transfer authorization
14630
- # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
14902
+ # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
14631
14903
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
14632
14904
  # @param [Hash] opts the optional parameters
14633
14905
  # @return [TransferAuthorizationCreateResponse]
@@ -14637,7 +14909,7 @@ module Plaid
14637
14909
  end
14638
14910
 
14639
14911
  # Create a transfer authorization
14640
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
14912
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
14641
14913
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
14642
14914
  # @param [Hash] opts the optional parameters
14643
14915
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -14831,7 +15103,7 @@ module Plaid
14831
15103
  end
14832
15104
 
14833
15105
  # Get RTP eligibility information of a transfer
14834
- # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
15106
+ # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
14835
15107
  # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
14836
15108
  # @param [Hash] opts the optional parameters
14837
15109
  # @return [TransferCapabilitiesGetResponse]
@@ -14841,7 +15113,7 @@ module Plaid
14841
15113
  end
14842
15114
 
14843
15115
  # Get RTP eligibility information of a transfer
14844
- # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username &#x60;user_good&#x60; and password &#x60;pass_good&#x60; and use the first two checking and savings accounts in the \&quot;First Platypus Bank\&quot; institution (ending in 0000 or 1111), which will return &#x60;true&#x60;. Any other account will return &#x60;false&#x60;.
15116
+ # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by &#x60;/transfer/migrate_account&#x60;. To simulate RTP eligibility in Sandbox, log in using the username &#x60;user_good&#x60; and password &#x60;pass_good&#x60; and use the first two checking and savings accounts in the \&quot;First Platypus Bank\&quot; institution (ending in 0000 or 1111), which will return &#x60;true&#x60;. Any other account will return &#x60;false&#x60;.
14845
15117
  # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
14846
15118
  # @param [Hash] opts the optional parameters
14847
15119
  # @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
@@ -15307,7 +15579,7 @@ module Plaid
15307
15579
  end
15308
15580
 
15309
15581
  # Retrieve a transfer
15310
- # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
15582
+ # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` must be populated but not both.
15311
15583
  # @param transfer_get_request [TransferGetRequest]
15312
15584
  # @param [Hash] opts the optional parameters
15313
15585
  # @return [TransferGetResponse]
@@ -15317,7 +15589,7 @@ module Plaid
15317
15589
  end
15318
15590
 
15319
15591
  # Retrieve a transfer
15320
- # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
15592
+ # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60;. One of &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60; must be populated but not both.
15321
15593
  # @param transfer_get_request [TransferGetRequest]
15322
15594
  # @param [Hash] opts the optional parameters
15323
15595
  # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
@@ -16326,6 +16598,142 @@ module Plaid
16326
16598
  return data, status_code, headers
16327
16599
  end
16328
16600
 
16601
+ # Create a person associated with an originator
16602
+ # Use the `/transfer/platform/person/create` endpoint to create a person record associated with an originator and optionally submit person-specific requirements.
16603
+ # @param transfer_platform_person_create_request [TransferPlatformPersonCreateRequest]
16604
+ # @param [Hash] opts the optional parameters
16605
+ # @return [TransferPlatformPersonCreateResponse]
16606
+ def transfer_platform_person_create(transfer_platform_person_create_request, opts = {})
16607
+ data, _status_code, _headers = transfer_platform_person_create_with_http_info(transfer_platform_person_create_request, opts)
16608
+ data
16609
+ end
16610
+
16611
+ # Create a person associated with an originator
16612
+ # Use the &#x60;/transfer/platform/person/create&#x60; endpoint to create a person record associated with an originator and optionally submit person-specific requirements.
16613
+ # @param transfer_platform_person_create_request [TransferPlatformPersonCreateRequest]
16614
+ # @param [Hash] opts the optional parameters
16615
+ # @return [Array<(TransferPlatformPersonCreateResponse, Integer, Hash)>] TransferPlatformPersonCreateResponse data, response status code and response headers
16616
+ def transfer_platform_person_create_with_http_info(transfer_platform_person_create_request, opts = {})
16617
+ if @api_client.config.debugging
16618
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_person_create ...'
16619
+ end
16620
+ # verify the required parameter 'transfer_platform_person_create_request' is set
16621
+ if @api_client.config.client_side_validation && transfer_platform_person_create_request.nil?
16622
+ fail ArgumentError, "Missing the required parameter 'transfer_platform_person_create_request' when calling PlaidApi.transfer_platform_person_create"
16623
+ end
16624
+ # resource path
16625
+ local_var_path = '/transfer/platform/person/create'
16626
+
16627
+ # query parameters
16628
+ query_params = opts[:query_params] || {}
16629
+
16630
+ # header parameters
16631
+ header_params = opts[:header_params] || {}
16632
+ # HTTP header 'Accept' (if needed)
16633
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16634
+ # HTTP header 'Content-Type'
16635
+ content_type = @api_client.select_header_content_type(['application/json'])
16636
+ if !content_type.nil?
16637
+ header_params['Content-Type'] = content_type
16638
+ end
16639
+
16640
+ # form parameters
16641
+ form_params = opts[:form_params] || {}
16642
+
16643
+ # http body (model)
16644
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_person_create_request)
16645
+
16646
+ # return_type
16647
+ return_type = opts[:debug_return_type] || 'TransferPlatformPersonCreateResponse'
16648
+
16649
+ # auth_names
16650
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16651
+
16652
+ new_options = opts.merge(
16653
+ :operation => :"PlaidApi.transfer_platform_person_create",
16654
+ :header_params => header_params,
16655
+ :query_params => query_params,
16656
+ :form_params => form_params,
16657
+ :body => post_body,
16658
+ :auth_names => auth_names,
16659
+ :return_type => return_type
16660
+ )
16661
+
16662
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16663
+ if @api_client.config.debugging
16664
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_person_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16665
+ end
16666
+ return data, status_code, headers
16667
+ end
16668
+
16669
+ # Submit onboarding requirements for Scaled Platform originators
16670
+ # The `/transfer/platform/requirement/submit` endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
16671
+ # @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
16672
+ # @param [Hash] opts the optional parameters
16673
+ # @return [TransferPlatformRequirementSubmitResponse]
16674
+ def transfer_platform_requirement_submit(transfer_platform_requirement_submit_request, opts = {})
16675
+ data, _status_code, _headers = transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts)
16676
+ data
16677
+ end
16678
+
16679
+ # Submit onboarding requirements for Scaled Platform originators
16680
+ # The &#x60;/transfer/platform/requirement/submit&#x60; endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
16681
+ # @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
16682
+ # @param [Hash] opts the optional parameters
16683
+ # @return [Array<(TransferPlatformRequirementSubmitResponse, Integer, Hash)>] TransferPlatformRequirementSubmitResponse data, response status code and response headers
16684
+ def transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts = {})
16685
+ if @api_client.config.debugging
16686
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_requirement_submit ...'
16687
+ end
16688
+ # verify the required parameter 'transfer_platform_requirement_submit_request' is set
16689
+ if @api_client.config.client_side_validation && transfer_platform_requirement_submit_request.nil?
16690
+ fail ArgumentError, "Missing the required parameter 'transfer_platform_requirement_submit_request' when calling PlaidApi.transfer_platform_requirement_submit"
16691
+ end
16692
+ # resource path
16693
+ local_var_path = '/transfer/platform/requirement/submit'
16694
+
16695
+ # query parameters
16696
+ query_params = opts[:query_params] || {}
16697
+
16698
+ # header parameters
16699
+ header_params = opts[:header_params] || {}
16700
+ # HTTP header 'Accept' (if needed)
16701
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16702
+ # HTTP header 'Content-Type'
16703
+ content_type = @api_client.select_header_content_type(['application/json'])
16704
+ if !content_type.nil?
16705
+ header_params['Content-Type'] = content_type
16706
+ end
16707
+
16708
+ # form parameters
16709
+ form_params = opts[:form_params] || {}
16710
+
16711
+ # http body (model)
16712
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_requirement_submit_request)
16713
+
16714
+ # return_type
16715
+ return_type = opts[:debug_return_type] || 'TransferPlatformRequirementSubmitResponse'
16716
+
16717
+ # auth_names
16718
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16719
+
16720
+ new_options = opts.merge(
16721
+ :operation => :"PlaidApi.transfer_platform_requirement_submit",
16722
+ :header_params => header_params,
16723
+ :query_params => query_params,
16724
+ :form_params => form_params,
16725
+ :body => post_body,
16726
+ :auth_names => auth_names,
16727
+ :return_type => return_type
16728
+ )
16729
+
16730
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16731
+ if @api_client.config.debugging
16732
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_requirement_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16733
+ end
16734
+ return data, status_code, headers
16735
+ end
16736
+
16329
16737
  # Generate a Plaid-hosted onboarding UI URL.
16330
16738
  # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
16331
16739
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
@@ -17414,6 +17822,142 @@ module Plaid
17414
17822
  return data, status_code, headers
17415
17823
  end
17416
17824
 
17825
+ # Create a third-party user token
17826
+ # This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user through supported endpoints. Ensure you store the `third_party_user_token` along with the `user_token` and `third_party_client_id`, as it is not possible to retrieve a previously created `third_party_user_token`.
17827
+ # @param user_third_party_token_create_request [UserThirdPartyTokenCreateRequest]
17828
+ # @param [Hash] opts the optional parameters
17829
+ # @return [UserThirdPartyTokenCreateResponse]
17830
+ def user_third_party_token_create(user_third_party_token_create_request, opts = {})
17831
+ data, _status_code, _headers = user_third_party_token_create_with_http_info(user_third_party_token_create_request, opts)
17832
+ data
17833
+ end
17834
+
17835
+ # Create a third-party user token
17836
+ # This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user through supported endpoints. Ensure you store the &#x60;third_party_user_token&#x60; along with the &#x60;user_token&#x60; and &#x60;third_party_client_id&#x60;, as it is not possible to retrieve a previously created &#x60;third_party_user_token&#x60;.
17837
+ # @param user_third_party_token_create_request [UserThirdPartyTokenCreateRequest]
17838
+ # @param [Hash] opts the optional parameters
17839
+ # @return [Array<(UserThirdPartyTokenCreateResponse, Integer, Hash)>] UserThirdPartyTokenCreateResponse data, response status code and response headers
17840
+ def user_third_party_token_create_with_http_info(user_third_party_token_create_request, opts = {})
17841
+ if @api_client.config.debugging
17842
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_third_party_token_create ...'
17843
+ end
17844
+ # verify the required parameter 'user_third_party_token_create_request' is set
17845
+ if @api_client.config.client_side_validation && user_third_party_token_create_request.nil?
17846
+ fail ArgumentError, "Missing the required parameter 'user_third_party_token_create_request' when calling PlaidApi.user_third_party_token_create"
17847
+ end
17848
+ # resource path
17849
+ local_var_path = '/user/third_party_token/create'
17850
+
17851
+ # query parameters
17852
+ query_params = opts[:query_params] || {}
17853
+
17854
+ # header parameters
17855
+ header_params = opts[:header_params] || {}
17856
+ # HTTP header 'Accept' (if needed)
17857
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17858
+ # HTTP header 'Content-Type'
17859
+ content_type = @api_client.select_header_content_type(['application/json'])
17860
+ if !content_type.nil?
17861
+ header_params['Content-Type'] = content_type
17862
+ end
17863
+
17864
+ # form parameters
17865
+ form_params = opts[:form_params] || {}
17866
+
17867
+ # http body (model)
17868
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_third_party_token_create_request)
17869
+
17870
+ # return_type
17871
+ return_type = opts[:debug_return_type] || 'UserThirdPartyTokenCreateResponse'
17872
+
17873
+ # auth_names
17874
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17875
+
17876
+ new_options = opts.merge(
17877
+ :operation => :"PlaidApi.user_third_party_token_create",
17878
+ :header_params => header_params,
17879
+ :query_params => query_params,
17880
+ :form_params => form_params,
17881
+ :body => post_body,
17882
+ :auth_names => auth_names,
17883
+ :return_type => return_type
17884
+ )
17885
+
17886
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17887
+ if @api_client.config.debugging
17888
+ @api_client.config.logger.debug "API called: PlaidApi#user_third_party_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17889
+ end
17890
+ return data, status_code, headers
17891
+ end
17892
+
17893
+ # Remove a third-party user token
17894
+ # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
17895
+ # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
17896
+ # @param [Hash] opts the optional parameters
17897
+ # @return [UserThirdPartyTokenRemoveResponse]
17898
+ def user_third_party_token_remove(user_third_party_token_remove_request, opts = {})
17899
+ data, _status_code, _headers = user_third_party_token_remove_with_http_info(user_third_party_token_remove_request, opts)
17900
+ data
17901
+ end
17902
+
17903
+ # Remove a third-party user token
17904
+ # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
17905
+ # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
17906
+ # @param [Hash] opts the optional parameters
17907
+ # @return [Array<(UserThirdPartyTokenRemoveResponse, Integer, Hash)>] UserThirdPartyTokenRemoveResponse data, response status code and response headers
17908
+ def user_third_party_token_remove_with_http_info(user_third_party_token_remove_request, opts = {})
17909
+ if @api_client.config.debugging
17910
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_third_party_token_remove ...'
17911
+ end
17912
+ # verify the required parameter 'user_third_party_token_remove_request' is set
17913
+ if @api_client.config.client_side_validation && user_third_party_token_remove_request.nil?
17914
+ fail ArgumentError, "Missing the required parameter 'user_third_party_token_remove_request' when calling PlaidApi.user_third_party_token_remove"
17915
+ end
17916
+ # resource path
17917
+ local_var_path = '/user/third_party_token/remove'
17918
+
17919
+ # query parameters
17920
+ query_params = opts[:query_params] || {}
17921
+
17922
+ # header parameters
17923
+ header_params = opts[:header_params] || {}
17924
+ # HTTP header 'Accept' (if needed)
17925
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17926
+ # HTTP header 'Content-Type'
17927
+ content_type = @api_client.select_header_content_type(['application/json'])
17928
+ if !content_type.nil?
17929
+ header_params['Content-Type'] = content_type
17930
+ end
17931
+
17932
+ # form parameters
17933
+ form_params = opts[:form_params] || {}
17934
+
17935
+ # http body (model)
17936
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_third_party_token_remove_request)
17937
+
17938
+ # return_type
17939
+ return_type = opts[:debug_return_type] || 'UserThirdPartyTokenRemoveResponse'
17940
+
17941
+ # auth_names
17942
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17943
+
17944
+ new_options = opts.merge(
17945
+ :operation => :"PlaidApi.user_third_party_token_remove",
17946
+ :header_params => header_params,
17947
+ :query_params => query_params,
17948
+ :form_params => form_params,
17949
+ :body => post_body,
17950
+ :auth_names => auth_names,
17951
+ :return_type => return_type
17952
+ )
17953
+
17954
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17955
+ if @api_client.config.debugging
17956
+ @api_client.config.logger.debug "API called: PlaidApi#user_third_party_token_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17957
+ end
17958
+ return data, status_code, headers
17959
+ end
17960
+
17417
17961
  # Update user information
17418
17962
  # This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user.
17419
17963
  # @param user_update_request [UserUpdateRequest]