plaid 15.11.0 → 16.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (961) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +214 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/README.md +27 -1
  6. data/lib/plaid/api/plaid_api.rb +681 -614
  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 +12 -2
  12. data/lib/plaid/models/account_assets_all_of.rb +12 -2
  13. data/lib/plaid/models/account_balance.rb +1 -1
  14. data/lib/plaid/models/account_base.rb +1 -1
  15. data/lib/plaid/models/account_filter.rb +1 -1
  16. data/lib/plaid/models/account_filters_response.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +1 -1
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score.rb +392 -0
  20. data/lib/plaid/models/account_identity_match_score_all_of.rb +249 -0
  21. data/lib/plaid/models/account_product_access.rb +1 -1
  22. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  23. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  24. data/lib/plaid/models/account_subtype.rb +1 -1
  25. data/lib/plaid/models/account_type.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  30. data/lib/plaid/models/accounts_get_response.rb +1 -1
  31. data/lib/plaid/models/ach_class.rb +1 -1
  32. data/lib/plaid/models/address.rb +1 -1
  33. data/lib/plaid/models/address_data.rb +1 -1
  34. data/lib/plaid/models/address_data_nullable.rb +1 -1
  35. data/lib/plaid/models/address_match_score.rb +232 -0
  36. data/lib/plaid/models/address_nullable.rb +1 -1
  37. data/lib/plaid/models/address_purpose_label.rb +1 -1
  38. data/lib/plaid/models/application.rb +1 -1
  39. data/lib/plaid/models/application_get_request.rb +1 -1
  40. data/lib/plaid/models/application_get_response.rb +1 -1
  41. data/lib/plaid/models/apr.rb +1 -1
  42. data/lib/plaid/models/asset.rb +280 -0
  43. data/lib/plaid/models/asset_detail.rb +347 -0
  44. data/lib/plaid/models/{pay_stub_verification_attribute.rb → asset_holder.rb} +17 -14
  45. data/lib/plaid/models/asset_holder_name.rb +225 -0
  46. data/lib/plaid/models/asset_owner.rb +221 -0
  47. data/lib/plaid/models/{report_token.rb → asset_owners.rb} +20 -22
  48. data/lib/plaid/models/asset_report.rb +1 -1
  49. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  50. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  51. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  53. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  54. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  56. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  57. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_freddie.rb +252 -0
  60. data/lib/plaid/models/asset_report_freddie_get_request.rb +245 -0
  61. data/lib/plaid/models/{asset_report_relay_remove_response.rb → asset_report_freddie_get_response.rb} +15 -16
  62. data/lib/plaid/models/asset_report_get_request.rb +14 -5
  63. data/lib/plaid/models/asset_report_get_request_options.rb +247 -0
  64. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  65. data/lib/plaid/models/asset_report_item.rb +1 -1
  66. data/lib/plaid/models/asset_report_pdf_get_request.rb +14 -5
  67. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +247 -0
  68. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  69. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  70. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  71. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  72. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  73. data/lib/plaid/models/asset_report_transaction.rb +16 -6
  74. data/lib/plaid/models/asset_report_transaction_all_of.rb +16 -6
  75. data/lib/plaid/models/asset_report_user.rb +1 -1
  76. data/lib/plaid/models/asset_transaction.rb +241 -0
  77. data/lib/plaid/models/asset_transaction_category_type.rb +144 -0
  78. data/lib/plaid/models/asset_transaction_description.rb +225 -0
  79. data/lib/plaid/models/asset_transaction_detail.rb +327 -0
  80. data/lib/plaid/models/{relay_event.rb → asset_transaction_type.rb} +4 -5
  81. data/lib/plaid/models/asset_transactions.rb +226 -0
  82. data/lib/plaid/models/asset_type.rb +42 -0
  83. data/lib/plaid/models/assets.rb +227 -0
  84. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  85. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  86. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  87. data/lib/plaid/models/auth_get_request.rb +1 -1
  88. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  89. data/lib/plaid/models/auth_get_response.rb +1 -1
  90. data/lib/plaid/models/auth_metadata.rb +1 -1
  91. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  92. data/lib/plaid/models/automatically_verified_webhook.rb +19 -5
  93. data/lib/plaid/models/bank_initiated_return_risk.rb +12 -12
  94. data/lib/plaid/models/bank_transfer.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  127. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +19 -5
  128. data/lib/plaid/models/categories_get_response.rb +1 -1
  129. data/lib/plaid/models/category.rb +1 -1
  130. data/lib/plaid/models/cause.rb +3 -3
  131. data/lib/plaid/models/cause_all_of.rb +1 -1
  132. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  133. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  134. data/lib/plaid/models/connected_application.rb +1 -1
  135. data/lib/plaid/models/counterparty.rb +239 -0
  136. data/lib/plaid/models/counterparty_type.rb +41 -0
  137. data/lib/plaid/models/country_code.rb +1 -1
  138. data/lib/plaid/models/credit1099.rb +1 -1
  139. data/lib/plaid/models/credit1099_filer.rb +2 -2
  140. data/lib/plaid/models/credit1099_payer.rb +1 -1
  141. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  142. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  143. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +2 -2
  144. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  145. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  146. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  147. data/lib/plaid/models/credit_bank_income.rb +1 -1
  148. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  149. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  150. data/lib/plaid/models/credit_bank_income_category.rb +4 -1
  151. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  152. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  153. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  154. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  155. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  156. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  157. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  158. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  159. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  160. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -11
  161. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  162. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  163. data/lib/plaid/models/credit_bank_income_source.rb +2 -2
  164. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  165. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  166. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  167. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  168. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  169. data/lib/plaid/models/credit_card_liability.rb +1 -1
  170. data/lib/plaid/models/credit_category.rb +240 -0
  171. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  172. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  173. data/lib/plaid/models/credit_employment_get_request.rb +1 -11
  174. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  175. data/lib/plaid/models/credit_employment_item.rb +9 -14
  176. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  177. data/lib/plaid/models/credit_filter.rb +1 -1
  178. data/lib/plaid/models/credit_pay_stub.rb +5 -15
  179. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  180. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  181. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  182. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  183. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  184. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  185. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  186. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  187. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +16 -6
  188. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  189. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  190. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  191. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  192. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  193. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  194. data/lib/plaid/models/credit_relay_create_request.rb +3 -3
  195. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  196. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  197. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  198. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  199. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  200. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  201. data/lib/plaid/models/credit_session.rb +239 -0
  202. data/lib/plaid/models/credit_session_bank_income_result.rb +237 -0
  203. data/lib/plaid/models/{payment_initiation_refund_status.rb → credit_session_bank_income_status.rb} +4 -6
  204. data/lib/plaid/models/credit_session_item_add_result.rb +237 -0
  205. data/lib/plaid/models/credit_session_results.rb +232 -0
  206. data/lib/plaid/models/{asset_report_relay_remove_request.rb → credit_sessions_get_request.rb} +16 -16
  207. data/lib/plaid/models/{asset_report_relay_create_response.rb → credit_sessions_get_response.rb} +14 -18
  208. data/lib/plaid/models/credit_w2.rb +1 -1
  209. data/lib/plaid/models/customer_initiated_return_risk.rb +12 -12
  210. data/lib/plaid/models/dashboard_user.rb +1 -1
  211. data/lib/plaid/models/{get_dashboard_user_request.rb → dashboard_user_get_request.rb} +4 -4
  212. data/lib/plaid/models/{dashboard_user_response.rb → dashboard_user_get_response.rb} +4 -4
  213. data/lib/plaid/models/{list_dashboard_user_request.rb → dashboard_user_list_request.rb} +4 -4
  214. data/lib/plaid/models/{paginated_dashboard_user_list_response.rb → dashboard_user_list_response.rb} +4 -4
  215. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  216. data/lib/plaid/models/date_range.rb +1 -1
  217. data/lib/plaid/models/deductions.rb +1 -1
  218. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  219. data/lib/plaid/models/deductions_total.rb +1 -1
  220. data/lib/plaid/models/default_update_webhook.rb +19 -5
  221. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  222. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  223. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  224. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  225. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  226. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  227. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  228. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  229. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +14 -5
  230. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  231. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  232. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  233. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  234. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  235. data/lib/plaid/models/depository_filter.rb +1 -1
  236. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  237. data/lib/plaid/models/doc_type.rb +2 -1
  238. data/lib/plaid/models/document_analysis.rb +1 -1
  239. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  240. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  241. data/lib/plaid/models/document_metadata.rb +1 -1
  242. data/lib/plaid/models/document_name_match_code.rb +1 -1
  243. data/lib/plaid/models/document_risk_signal.rb +1 -1
  244. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  245. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  246. data/lib/plaid/models/document_status.rb +1 -1
  247. data/lib/plaid/models/documentary_verification.rb +2 -2
  248. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  249. data/lib/plaid/models/earnings.rb +1 -1
  250. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  251. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  252. data/lib/plaid/models/earnings_total.rb +1 -1
  253. data/lib/plaid/models/email.rb +1 -1
  254. data/lib/plaid/models/email_address_match_score.rb +221 -0
  255. data/lib/plaid/models/employee.rb +1 -1
  256. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  257. data/lib/plaid/models/employer.rb +1 -1
  258. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  259. data/lib/plaid/models/employer_verification.rb +1 -1
  260. data/lib/plaid/models/employers_search_request.rb +1 -1
  261. data/lib/plaid/models/employers_search_response.rb +1 -1
  262. data/lib/plaid/models/employment_details.rb +1 -1
  263. data/lib/plaid/models/employment_verification.rb +1 -1
  264. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  265. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  266. data/lib/plaid/models/employment_verification_status.rb +1 -1
  267. data/lib/plaid/models/enhancements.rb +18 -6
  268. data/lib/plaid/models/entity_document.rb +1 -12
  269. data/lib/plaid/models/entity_document_type.rb +1 -1
  270. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  271. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  272. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  273. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  274. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  275. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  276. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  277. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -24
  278. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  279. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  280. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  281. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +20 -6
  282. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  283. data/lib/plaid/models/entity_watchlist_program.rb +1 -12
  284. data/lib/plaid/models/entity_watchlist_screening.rb +20 -1
  285. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  286. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  287. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +37 -9
  288. data/lib/plaid/models/entity_watchlist_search_terms.rb +37 -9
  289. data/lib/plaid/models/error.rb +3 -3
  290. data/lib/plaid/models/expiration_date.rb +1 -1
  291. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  292. data/lib/plaid/models/external_payment_options.rb +1 -1
  293. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  294. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  295. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  296. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  297. data/lib/plaid/models/fdx_content_types.rb +43 -0
  298. data/lib/plaid/models/fdx_hateoas_link.rb +256 -0
  299. data/lib/plaid/models/fdx_hateoas_link_action.rb +42 -0
  300. data/lib/plaid/models/fdx_notification.rb +332 -0
  301. data/lib/plaid/models/fdx_notification_category.rb +42 -0
  302. data/lib/plaid/models/fdx_notification_payload.rb +238 -0
  303. data/lib/plaid/models/fdx_notification_payload_id_type.rb +42 -0
  304. data/lib/plaid/models/fdx_notification_priority.rb +40 -0
  305. data/lib/plaid/models/fdx_notification_severity.rb +42 -0
  306. data/lib/plaid/models/fdx_notification_type.rb +43 -0
  307. data/lib/plaid/models/{verification_attribute.rb → fdx_party.rb} +76 -43
  308. data/lib/plaid/models/fdx_party_registry.rb +41 -0
  309. data/lib/plaid/models/fdx_party_type.rb +43 -0
  310. data/lib/plaid/models/fdxfi_attribute.rb +230 -0
  311. data/lib/plaid/models/form1099_type.rb +1 -1
  312. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  313. data/lib/plaid/models/health_incident.rb +1 -1
  314. data/lib/plaid/models/historical_balance.rb +1 -1
  315. data/lib/plaid/models/historical_update_webhook.rb +19 -5
  316. data/lib/plaid/models/holding.rb +1 -1
  317. data/lib/plaid/models/holdings_default_update_webhook.rb +20 -6
  318. data/lib/plaid/models/holdings_override.rb +1 -1
  319. data/lib/plaid/models/id_number_type.rb +1 -1
  320. data/lib/plaid/models/identity_default_update_webhook.rb +20 -6
  321. data/lib/plaid/models/identity_get_request.rb +1 -1
  322. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  323. data/lib/plaid/models/identity_get_response.rb +1 -1
  324. data/lib/plaid/models/identity_match_request.rb +1 -1
  325. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  326. data/lib/plaid/models/identity_match_response.rb +38 -2
  327. data/lib/plaid/models/identity_match_user.rb +1 -1
  328. data/lib/plaid/models/identity_update_types.rb +1 -1
  329. data/lib/plaid/models/identity_verification.rb +2 -12
  330. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  331. data/lib/plaid/models/{identity_verification_response.rb → identity_verification_create_response.rb} +5 -15
  332. data/lib/plaid/models/{get_identity_verification_request.rb → identity_verification_get_request.rb} +4 -4
  333. data/lib/plaid/models/identity_verification_get_response.rb +411 -0
  334. data/lib/plaid/models/{list_identity_verification_request.rb → identity_verification_list_request.rb} +4 -15
  335. data/lib/plaid/models/{paginated_identity_verification_list_response.rb → identity_verification_list_response.rb} +4 -4
  336. data/lib/plaid/models/identity_verification_request_user.rb +2 -32
  337. data/lib/plaid/models/identity_verification_retried_webhook.rb +20 -6
  338. data/lib/plaid/models/identity_verification_retry_request.rb +1 -12
  339. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  340. data/lib/plaid/models/identity_verification_retry_response.rb +411 -0
  341. data/lib/plaid/models/identity_verification_status.rb +1 -1
  342. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +20 -6
  343. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  344. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  345. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +20 -6
  346. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  347. data/lib/plaid/models/identity_verification_user_address.rb +6 -13
  348. data/lib/plaid/models/identity_verification_user_data.rb +2 -20
  349. data/lib/plaid/models/image_quality.rb +1 -1
  350. data/lib/plaid/models/incident_update.rb +1 -1
  351. data/lib/plaid/models/income_breakdown.rb +1 -1
  352. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  353. data/lib/plaid/models/income_override.rb +1 -1
  354. data/lib/plaid/models/income_summary.rb +1 -1
  355. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  356. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  357. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  358. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  359. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  360. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  361. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  362. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  363. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  364. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  365. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  366. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  367. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  368. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  369. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +221 -0
  370. data/lib/plaid/models/income_verification_precheck_request.rb +12 -2
  371. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  372. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  373. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  374. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  375. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  376. data/lib/plaid/models/income_verification_status_webhook.rb +19 -5
  377. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  378. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  379. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  380. data/lib/plaid/models/individual_name.rb +240 -0
  381. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  382. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  383. data/lib/plaid/models/individual_watchlist_program.rb +1 -12
  384. data/lib/plaid/models/inflow_model.rb +1 -1
  385. data/lib/plaid/models/initial_update_webhook.rb +19 -5
  386. data/lib/plaid/models/institution.rb +1 -1
  387. data/lib/plaid/models/institution_status.rb +1 -1
  388. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  389. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  390. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  391. data/lib/plaid/models/institutions_get_request.rb +1 -1
  392. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  393. data/lib/plaid/models/institutions_get_response.rb +1 -1
  394. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  395. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  396. data/lib/plaid/models/institutions_search_request.rb +1 -1
  397. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  398. data/lib/plaid/models/institutions_search_response.rb +1 -1
  399. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  400. data/lib/plaid/models/investment_filter.rb +1 -1
  401. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  402. data/lib/plaid/models/investment_transaction.rb +1 -1
  403. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  404. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  405. data/lib/plaid/models/investments_default_update_webhook.rb +20 -6
  406. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  407. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  408. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  409. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  410. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  411. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  412. data/lib/plaid/models/issuing_country.rb +1 -1
  413. data/lib/plaid/models/item.rb +1 -1
  414. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  415. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  416. data/lib/plaid/models/item_application_list_request.rb +1 -1
  417. data/lib/plaid/models/item_application_list_response.rb +1 -1
  418. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  419. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  420. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  421. data/lib/plaid/models/item_error_webhook.rb +20 -6
  422. data/lib/plaid/models/item_get_request.rb +1 -1
  423. data/lib/plaid/models/item_get_response.rb +1 -1
  424. data/lib/plaid/models/item_import_request.rb +1 -1
  425. data/lib/plaid/models/item_import_request_options.rb +1 -1
  426. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  427. data/lib/plaid/models/item_import_response.rb +1 -1
  428. data/lib/plaid/models/item_product_ready_webhook.rb +20 -6
  429. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  430. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  431. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  432. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  433. data/lib/plaid/models/item_remove_request.rb +1 -1
  434. data/lib/plaid/models/item_remove_response.rb +1 -1
  435. data/lib/plaid/models/item_status.rb +1 -1
  436. data/lib/plaid/models/item_status_investments.rb +1 -1
  437. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  438. data/lib/plaid/models/item_status_nullable.rb +1 -1
  439. data/lib/plaid/models/item_status_transactions.rb +1 -1
  440. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  441. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  442. data/lib/plaid/models/jwk_public_key.rb +1 -1
  443. data/lib/plaid/models/jwt_header.rb +1 -1
  444. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  445. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  446. data/lib/plaid/models/kyc_check_details.rb +2 -2
  447. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  448. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  449. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  450. data/lib/plaid/models/liabilities_default_update_webhook.rb +20 -6
  451. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  452. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  453. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  454. data/lib/plaid/models/liabilities_object.rb +1 -1
  455. data/lib/plaid/models/liability_override.rb +2 -2
  456. data/lib/plaid/models/{asset_report_relay_refresh_request.rb → link_delivery_create_request.rb} +42 -23
  457. data/lib/plaid/models/{asset_report_relay_refresh_response.rb → link_delivery_create_response.rb} +26 -25
  458. data/lib/plaid/models/link_delivery_delivery_method.rb +39 -0
  459. data/lib/plaid/models/{asset_report_relay_get_request.rb → link_delivery_get_request.rb} +16 -16
  460. data/lib/plaid/models/link_delivery_get_response.rb +277 -0
  461. data/lib/plaid/models/link_delivery_session_status.rb +41 -0
  462. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  463. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  464. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  465. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  466. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  467. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  468. data/lib/plaid/models/link_token_create_request.rb +14 -5
  469. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  470. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  471. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  472. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  473. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  474. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  475. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  476. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  477. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  478. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  479. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  480. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  481. data/lib/plaid/models/link_token_create_response.rb +1 -1
  482. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  483. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  484. data/lib/plaid/models/link_token_get_request.rb +1 -1
  485. data/lib/plaid/models/link_token_get_response.rb +1 -1
  486. data/lib/plaid/models/link_token_investments.rb +220 -0
  487. data/lib/plaid/models/loan.rb +224 -0
  488. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  489. data/lib/plaid/models/loan_filter.rb +1 -1
  490. data/lib/plaid/models/loan_identifier.rb +231 -0
  491. data/lib/plaid/models/loan_identifier_type.rb +39 -0
  492. data/lib/plaid/models/loan_identifiers.rb +224 -0
  493. data/lib/plaid/models/loans.rb +224 -0
  494. data/lib/plaid/models/location.rb +1 -1
  495. data/lib/plaid/models/match_summary.rb +1 -1
  496. data/lib/plaid/models/match_summary_code.rb +1 -1
  497. data/lib/plaid/models/meta.rb +61 -5
  498. data/lib/plaid/models/mfa.rb +1 -1
  499. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  500. data/lib/plaid/models/mortgage_liability.rb +1 -1
  501. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  502. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  503. data/lib/plaid/models/name_match_score.rb +254 -0
  504. data/lib/plaid/models/net_pay.rb +1 -1
  505. data/lib/plaid/models/new_accounts_available_webhook.rb +15 -6
  506. data/lib/plaid/models/numbers.rb +1 -1
  507. data/lib/plaid/models/numbers_ach.rb +1 -1
  508. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  509. data/lib/plaid/models/numbers_bacs.rb +1 -1
  510. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  511. data/lib/plaid/models/numbers_eft.rb +1 -1
  512. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  513. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  514. data/lib/plaid/models/numbers_international.rb +1 -1
  515. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  516. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  517. data/lib/plaid/models/override_account_type.rb +1 -1
  518. data/lib/plaid/models/override_accounts.rb +1 -1
  519. data/lib/plaid/models/owner.rb +2 -2
  520. data/lib/plaid/models/owner_override.rb +1 -1
  521. data/lib/plaid/models/ownership_type.rb +42 -0
  522. data/lib/plaid/models/parties.rb +226 -0
  523. data/lib/plaid/models/{partner_customers_create_request.rb → partner_customer_create_request.rb} +113 -11
  524. data/lib/plaid/models/{partner_customers_create_response.rb → partner_customer_create_response.rb} +7 -16
  525. data/lib/plaid/models/partner_customer_get_request.rb +244 -0
  526. data/lib/plaid/models/partner_customer_get_response.rb +229 -0
  527. data/lib/plaid/models/{partner_end_customer_client.rb → partner_end_customer.rb} +18 -9
  528. data/lib/plaid/models/partner_end_customer_address.rb +256 -0
  529. data/lib/plaid/models/partner_end_customer_billing_contact.rb +237 -0
  530. data/lib/plaid/models/partner_end_customer_secrets.rb +240 -0
  531. data/lib/plaid/models/partner_end_customer_status.rb +40 -0
  532. data/lib/plaid/models/partner_end_customer_technical_contact.rb +237 -0
  533. data/lib/plaid/models/partner_end_customer_with_secrets.rb +247 -0
  534. data/lib/plaid/models/party.rb +252 -0
  535. data/lib/plaid/models/party_individual.rb +224 -0
  536. data/lib/plaid/models/party_role_type.rb +38 -0
  537. data/lib/plaid/models/pay.rb +1 -1
  538. data/lib/plaid/models/pay_frequency.rb +1 -1
  539. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  540. data/lib/plaid/models/pay_period_details.rb +1 -1
  541. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  542. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  543. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  544. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  545. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  546. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  547. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  548. data/lib/plaid/models/payment_amount.rb +1 -1
  549. data/lib/plaid/models/payment_amount_currency.rb +7 -1
  550. data/lib/plaid/models/payment_channel.rb +1 -1
  551. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  552. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  553. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  554. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  555. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  556. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  557. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  558. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  559. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  560. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  561. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  562. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  563. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  564. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  565. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  566. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  567. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  568. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  569. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  570. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  571. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  572. data/lib/plaid/models/payment_initiation_payment.rb +2 -1
  573. data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
  574. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  575. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  576. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  577. data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -1
  578. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  579. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  580. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  581. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
  582. data/lib/plaid/models/payment_initiation_payment_status.rb +2 -1
  583. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  584. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  585. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  586. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  587. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  588. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  589. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  590. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  591. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  592. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  593. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  594. data/lib/plaid/models/payment_meta.rb +1 -1
  595. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  596. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  597. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  598. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  599. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  600. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  601. data/lib/plaid/models/payment_profile_status.rb +1 -1
  602. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  603. data/lib/plaid/models/payment_scheme.rb +1 -1
  604. data/lib/plaid/models/payment_status_update_webhook.rb +20 -6
  605. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  606. data/lib/plaid/models/payroll_income_object.rb +1 -1
  607. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  608. data/lib/plaid/models/payroll_item.rb +10 -14
  609. data/lib/plaid/models/payroll_item_status.rb +1 -1
  610. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  611. data/lib/plaid/models/paystub.rb +5 -15
  612. data/lib/plaid/models/paystub_address.rb +1 -1
  613. data/lib/plaid/models/paystub_deduction.rb +1 -1
  614. data/lib/plaid/models/paystub_details.rb +1 -1
  615. data/lib/plaid/models/paystub_employer.rb +1 -1
  616. data/lib/plaid/models/paystub_override.rb +1 -1
  617. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  618. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  619. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  620. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  621. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  622. data/lib/plaid/models/pending_expiration_webhook.rb +19 -5
  623. data/lib/plaid/models/personal_finance_category.rb +1 -1
  624. data/lib/plaid/models/phone_number.rb +1 -1
  625. data/lib/plaid/models/phone_number_match_score.rb +221 -0
  626. data/lib/plaid/models/phone_type.rb +1 -1
  627. data/lib/plaid/models/physical_document_category.rb +1 -1
  628. data/lib/plaid/models/physical_document_extracted_data.rb +17 -35
  629. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  630. data/lib/plaid/models/physical_document_images.rb +1 -1
  631. data/lib/plaid/models/plaid_error.rb +4 -4
  632. data/lib/plaid/models/platform_ids.rb +1 -1
  633. data/lib/plaid/models/po_box_status.rb +1 -1
  634. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  635. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  636. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  637. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  638. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  639. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  640. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  641. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  642. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  643. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  644. data/lib/plaid/models/processor_number.rb +1 -1
  645. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  646. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  647. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  648. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  649. data/lib/plaid/models/product_access.rb +1 -1
  650. data/lib/plaid/models/product_status.rb +1 -1
  651. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  652. data/lib/plaid/models/products.rb +1 -1
  653. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  654. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  655. data/lib/plaid/models/pslf_status.rb +2 -2
  656. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  657. data/lib/plaid/models/recipient_bacs.rb +1 -1
  658. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  659. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  660. data/lib/plaid/models/recurring_transactions_update_webhook.rb +19 -5
  661. data/lib/plaid/models/removed_transaction.rb +1 -1
  662. data/lib/plaid/models/report_type.rb +1 -1
  663. data/lib/plaid/models/reporting_information.rb +225 -0
  664. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  665. data/lib/plaid/models/role.rb +224 -0
  666. data/lib/plaid/models/role_detail.rb +224 -0
  667. data/lib/plaid/models/roles.rb +224 -0
  668. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  669. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  670. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  671. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  672. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  673. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  674. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  675. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  676. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  677. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  678. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  679. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  680. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  681. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  682. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  683. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  684. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  685. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  686. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  687. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  688. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  689. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  690. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  691. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  692. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
  693. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  694. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  695. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  696. data/lib/plaid/models/scopes.rb +1 -1
  697. data/lib/plaid/models/scopes_context.rb +1 -1
  698. data/lib/plaid/models/scopes_nullable.rb +1 -1
  699. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  700. data/lib/plaid/models/screening_hit_data.rb +1 -1
  701. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  702. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  703. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  704. data/lib/plaid/models/screening_status_updated_webhook.rb +20 -6
  705. data/lib/plaid/models/security.rb +2 -2
  706. data/lib/plaid/models/security_override.rb +1 -1
  707. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  708. data/lib/plaid/models/service.rb +238 -0
  709. data/lib/plaid/models/service_product_fulfillment.rb +224 -0
  710. data/lib/plaid/models/service_product_fulfillment_detail.rb +235 -0
  711. data/lib/plaid/models/service_product_fulfillment_identifier.rb +38 -0
  712. data/lib/plaid/models/servicer_address_data.rb +1 -1
  713. data/lib/plaid/models/services.rb +224 -0
  714. data/lib/plaid/models/signal_address_data.rb +1 -1
  715. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  716. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  717. data/lib/plaid/models/signal_device.rb +1 -1
  718. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -1
  719. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  720. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  721. data/lib/plaid/models/signal_person_name.rb +1 -1
  722. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  723. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  724. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  725. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  726. data/lib/plaid/models/signal_scores.rb +1 -1
  727. data/lib/plaid/models/signal_user.rb +1 -1
  728. data/lib/plaid/models/simulated_transfer_sweep.rb +16 -5
  729. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  730. data/lib/plaid/models/source.rb +1 -1
  731. data/lib/plaid/models/standalone_account_type.rb +1 -1
  732. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  733. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  734. data/lib/plaid/models/status.rb +232 -0
  735. data/lib/plaid/models/statuses.rb +224 -0
  736. data/lib/plaid/models/strategy.rb +1 -1
  737. data/lib/plaid/models/student_loan.rb +1 -1
  738. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  739. data/lib/plaid/models/student_loan_status.rb +1 -1
  740. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  741. data/lib/plaid/models/sync_updates_available_webhook.rb +19 -5
  742. data/lib/plaid/models/taxform.rb +1 -1
  743. data/lib/plaid/models/taxpayer_id.rb +1 -1
  744. data/lib/plaid/models/taxpayer_identifier.rb +231 -0
  745. data/lib/plaid/models/taxpayer_identifier_type.rb +39 -0
  746. data/lib/plaid/models/taxpayer_identifiers.rb +224 -0
  747. data/lib/plaid/models/total.rb +1 -1
  748. data/lib/plaid/models/total_canonical_description.rb +1 -1
  749. data/lib/plaid/models/transaction.rb +1 -1
  750. data/lib/plaid/models/transaction_all_of.rb +1 -1
  751. data/lib/plaid/models/transaction_base.rb +1 -1
  752. data/lib/plaid/models/transaction_code.rb +1 -1
  753. data/lib/plaid/models/transaction_data.rb +1 -1
  754. data/lib/plaid/models/transaction_override.rb +1 -1
  755. data/lib/plaid/models/transaction_stream.rb +1 -1
  756. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  757. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  758. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  759. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  760. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  761. data/lib/plaid/models/transactions_get_request.rb +1 -1
  762. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  763. data/lib/plaid/models/transactions_get_response.rb +1 -1
  764. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  765. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  766. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  767. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  768. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  769. data/lib/plaid/models/transactions_removed_webhook.rb +19 -5
  770. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  771. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  772. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  773. data/lib/plaid/models/transactions_rules_create_request.rb +1 -11
  774. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  775. data/lib/plaid/models/transactions_rules_list_request.rb +1 -11
  776. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  777. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -11
  778. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  779. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  780. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  781. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  782. data/lib/plaid/models/transfer.rb +27 -5
  783. data/lib/plaid/models/transfer_authorization.rb +1 -1
  784. data/lib/plaid/models/transfer_authorization_create_request.rb +44 -3
  785. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  786. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  787. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  788. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +2 -1
  789. data/lib/plaid/models/transfer_authorization_device.rb +3 -3
  790. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  791. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  792. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  793. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  794. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  795. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  796. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  797. data/lib/plaid/models/transfer_create_request.rb +2 -27
  798. data/lib/plaid/models/transfer_create_response.rb +1 -1
  799. data/lib/plaid/models/transfer_event.rb +1 -1
  800. data/lib/plaid/models/transfer_event_list_request.rb +2 -2
  801. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  802. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  803. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  804. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  805. data/lib/plaid/models/transfer_event_type.rb +3 -2
  806. data/lib/plaid/models/transfer_events_update_webhook.rb +19 -5
  807. data/lib/plaid/models/transfer_failure.rb +1 -1
  808. data/lib/plaid/models/transfer_get_request.rb +1 -1
  809. data/lib/plaid/models/transfer_get_response.rb +1 -1
  810. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  811. data/lib/plaid/models/transfer_intent_create.rb +2 -2
  812. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  813. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  814. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  815. data/lib/plaid/models/transfer_intent_get.rb +2 -2
  816. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
  817. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  818. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  819. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  820. data/lib/plaid/models/transfer_list_request.rb +1 -1
  821. data/lib/plaid/models/transfer_list_response.rb +1 -1
  822. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  823. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  824. data/lib/plaid/models/transfer_network.rb +1 -1
  825. data/lib/plaid/models/transfer_repayment.rb +1 -1
  826. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  827. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  828. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  829. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  830. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  831. data/lib/plaid/models/transfer_status.rb +2 -1
  832. data/lib/plaid/models/transfer_sweep.rb +16 -5
  833. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  834. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  835. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  836. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  837. data/lib/plaid/models/transfer_sweep_status.rb +2 -2
  838. data/lib/plaid/models/transfer_type.rb +1 -1
  839. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  840. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  841. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  842. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +261 -0
  843. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  844. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +58 -7
  845. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +57 -6
  846. data/lib/plaid/models/user_address.rb +2 -13
  847. data/lib/plaid/models/user_create_request.rb +1 -1
  848. data/lib/plaid/models/user_create_response.rb +1 -1
  849. data/lib/plaid/models/user_custom_password.rb +1 -1
  850. data/lib/plaid/models/user_id_number.rb +1 -1
  851. data/lib/plaid/models/user_name.rb +1 -1
  852. data/lib/plaid/models/user_permission_revoked_webhook.rb +20 -6
  853. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  854. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  855. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  856. data/lib/plaid/models/validation_source.rb +232 -0
  857. data/lib/plaid/models/validation_sources.rb +227 -0
  858. data/lib/plaid/models/verification_expired_webhook.rb +19 -5
  859. data/lib/plaid/models/{paystub_verification.rb → verification_of_asset.rb} +40 -24
  860. data/lib/plaid/models/verification_of_asset_response.rb +224 -0
  861. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  862. data/lib/plaid/models/verification_status.rb +1 -1
  863. data/lib/plaid/models/w2.rb +1 -1
  864. data/lib/plaid/models/w2_box12.rb +1 -1
  865. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  866. data/lib/plaid/models/wallet.rb +15 -5
  867. data/lib/plaid/models/wallet_balance.rb +1 -1
  868. data/lib/plaid/models/wallet_create_request.rb +1 -1
  869. data/lib/plaid/models/wallet_create_response.rb +12 -2
  870. data/lib/plaid/models/wallet_get_request.rb +1 -1
  871. data/lib/plaid/models/wallet_get_response.rb +12 -2
  872. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  873. data/lib/plaid/models/wallet_list_request.rb +1 -1
  874. data/lib/plaid/models/wallet_list_response.rb +1 -1
  875. data/lib/plaid/models/wallet_numbers.rb +1 -1
  876. data/lib/plaid/models/wallet_transaction.rb +1 -1
  877. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  878. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  879. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  880. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  881. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  882. data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
  883. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  884. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  885. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  886. data/lib/plaid/models/wallet_transaction_status.rb +3 -1
  887. data/lib/plaid/models/{assets_relay_webhook.rb → wallet_transaction_status_update_webhook.rb} +60 -47
  888. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  889. data/lib/plaid/models/wallet_transactions_list_response.rb +1 -1
  890. data/lib/plaid/models/warning.rb +1 -1
  891. data/lib/plaid/models/watchlist_screening_audit_trail.rb +2 -1
  892. data/lib/plaid/models/watchlist_screening_document.rb +1 -12
  893. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  894. data/lib/plaid/models/{create_entity_screening_request.rb → watchlist_screening_entity_create_request.rb} +22 -5
  895. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +321 -0
  896. data/lib/plaid/models/{get_entity_watchlist_screening_request.rb → watchlist_screening_entity_get_request.rb} +4 -4
  897. data/lib/plaid/models/{entity_watchlist_screening_response.rb → watchlist_screening_entity_get_response.rb} +23 -4
  898. data/lib/plaid/models/{list_watchlist_screening_entity_history_request.rb → watchlist_screening_entity_history_list_request.rb} +4 -4
  899. data/lib/plaid/models/{paginated_entity_watchlist_screening_list_response.rb → watchlist_screening_entity_history_list_response.rb} +4 -4
  900. data/lib/plaid/models/{list_watchlist_screening_entity_hit_request.rb → watchlist_screening_entity_hit_list_request.rb} +4 -4
  901. data/lib/plaid/models/{paginated_entity_watchlist_screening_hit_list_response.rb → watchlist_screening_entity_hit_list_response.rb} +4 -4
  902. data/lib/plaid/models/{list_entity_watchlist_screening_request.rb → watchlist_screening_entity_list_request.rb} +23 -7
  903. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +253 -0
  904. data/lib/plaid/models/{get_watchlist_screening_entity_program_request.rb → watchlist_screening_entity_program_get_request.rb} +4 -4
  905. data/lib/plaid/models/{entity_watchlist_program_response.rb → watchlist_screening_entity_program_get_response.rb} +4 -15
  906. data/lib/plaid/models/{list_watchlist_screening_entity_programs_request.rb → watchlist_screening_entity_program_list_request.rb} +4 -4
  907. data/lib/plaid/models/{paginated_entity_watchlist_program_list_response.rb → watchlist_screening_entity_program_list_response.rb} +4 -4
  908. data/lib/plaid/models/{create_entity_watchlist_screening_review_request.rb → watchlist_screening_entity_review_create_request.rb} +4 -4
  909. data/lib/plaid/models/{entity_watchlist_screening_review_response.rb → watchlist_screening_entity_review_create_response.rb} +4 -4
  910. data/lib/plaid/models/{list_watchlist_screening_entity_reviews_request.rb → watchlist_screening_entity_review_list_request.rb} +4 -4
  911. data/lib/plaid/models/{paginated_entity_watchlist_screening_review_list_response.rb → watchlist_screening_entity_review_list_response.rb} +4 -4
  912. data/lib/plaid/models/{update_entity_screening_request.rb → watchlist_screening_entity_update_request.rb} +24 -8
  913. data/lib/plaid/models/{update_individual_screening_request_resettable_field.rb → watchlist_screening_entity_update_request_resettable_field.rb} +2 -2
  914. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +321 -0
  915. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  916. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -12
  917. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  918. data/lib/plaid/models/watchlist_screening_individual.rb +20 -1
  919. data/lib/plaid/models/{watchlist_screening_create_request.rb → watchlist_screening_individual_create_request.rb} +22 -5
  920. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +321 -0
  921. data/lib/plaid/models/{get_individual_watchlist_screening_request.rb → watchlist_screening_individual_get_request.rb} +4 -4
  922. data/lib/plaid/models/{watchlist_screening_individual_response.rb → watchlist_screening_individual_get_response.rb} +23 -4
  923. data/lib/plaid/models/{list_watchlist_screening_individual_history_request.rb → watchlist_screening_individual_history_list_request.rb} +4 -4
  924. data/lib/plaid/models/{paginated_individual_watchlist_screening_list_response.rb → watchlist_screening_individual_history_list_response.rb} +4 -4
  925. data/lib/plaid/models/{list_watchlist_screening_individual_hit_request.rb → watchlist_screening_individual_hit_list_request.rb} +4 -4
  926. data/lib/plaid/models/{paginated_individual_watchlist_screening_hit_list_response.rb → watchlist_screening_individual_hit_list_response.rb} +4 -4
  927. data/lib/plaid/models/{list_individual_watchlist_screening_request.rb → watchlist_screening_individual_list_request.rb} +23 -7
  928. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +253 -0
  929. data/lib/plaid/models/{get_watchlist_screening_individual_program_request.rb → watchlist_screening_individual_program_get_request.rb} +4 -4
  930. data/lib/plaid/models/{individual_watchlist_program_response.rb → watchlist_screening_individual_program_get_response.rb} +4 -15
  931. data/lib/plaid/models/{list_watchlist_screening_individual_programs_request.rb → watchlist_screening_individual_program_list_request.rb} +4 -4
  932. data/lib/plaid/models/{paginated_individual_watchlist_program_list_response.rb → watchlist_screening_individual_program_list_response.rb} +4 -4
  933. data/lib/plaid/models/{create_individual_watchlist_screening_review_request.rb → watchlist_screening_individual_review_create_request.rb} +4 -4
  934. data/lib/plaid/models/{watchlist_screening_review_response.rb → watchlist_screening_individual_review_create_response.rb} +4 -4
  935. data/lib/plaid/models/{list_watchlist_screening_individual_reviews_request.rb → watchlist_screening_individual_review_list_request.rb} +4 -4
  936. data/lib/plaid/models/{paginated_individual_watchlist_screening_review_list_response.rb → watchlist_screening_individual_review_list_response.rb} +4 -4
  937. data/lib/plaid/models/{update_individual_screening_request.rb → watchlist_screening_individual_update_request.rb} +24 -8
  938. data/lib/plaid/models/{update_entity_screening_request_resettable_field.rb → watchlist_screening_individual_update_request_resettable_field.rb} +2 -2
  939. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +321 -0
  940. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +35 -12
  941. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  942. data/lib/plaid/models/watchlist_screening_search_terms.rb +35 -9
  943. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  944. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  945. data/lib/plaid/models/webhook_environment_values.rb +40 -0
  946. data/lib/plaid/models/webhook_type.rb +1 -1
  947. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +20 -6
  948. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  949. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  950. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  951. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  952. data/lib/plaid/version.rb +2 -2
  953. data/lib/plaid.rb +153 -64
  954. data/plaid.gemspec +1 -1
  955. data/test/test_identity_verification.rb +51 -0
  956. data/test/test_institutions.rb +2 -2
  957. data/test/test_monitor.rb +55 -0
  958. metadata +156 -65
  959. data/lib/plaid/models/asset_report_relay_create_request.rb +0 -271
  960. data/lib/plaid/models/credit_pay_stub_verification.rb +0 -237
  961. data/lib/plaid/models/paystub_verification_status.rb +0 -41
@@ -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.161.5
6
+ The version of the OpenAPI document: 2020-09-14_1.181.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -734,266 +734,6 @@ module Plaid
734
734
  return data, status_code, headers
735
735
  end
736
736
 
737
- # Create an `asset_relay_token` to share an Asset Report with a partner client
738
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/asset_report/relay/create` endpoint to create an `asset_relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `asset_relay_token` for each third party to whom you want to grant access to the Report.
739
- # @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
740
- # @param [Hash] opts the optional parameters
741
- # @return [AssetReportRelayCreateResponse]
742
- def asset_report_relay_create(asset_report_relay_create_request, opts = {})
743
- data, _status_code, _headers = asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts)
744
- data
745
- end
746
-
747
- # Create an `asset_relay_token` to share an Asset Report with a partner client
748
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/asset_report/relay/create` endpoint to create an `asset_relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `asset_relay_token` for each third party to whom you want to grant access to the Report.
749
- # @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
750
- # @param [Hash] opts the optional parameters
751
- # @return [Array<(AssetReportRelayCreateResponse, Integer, Hash)>] AssetReportRelayCreateResponse data, response status code and response headers
752
- def asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts = {})
753
- if @api_client.config.debugging
754
- @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_create ...'
755
- end
756
- # verify the required parameter 'asset_report_relay_create_request' is set
757
- if @api_client.config.client_side_validation && asset_report_relay_create_request.nil?
758
- fail ArgumentError, "Missing the required parameter 'asset_report_relay_create_request' when calling PlaidApi.asset_report_relay_create"
759
- end
760
- # resource path
761
- local_var_path = '/asset_report/relay/create'
762
-
763
- # query parameters
764
- query_params = opts[:query_params] || {}
765
-
766
- # header parameters
767
- header_params = opts[:header_params] || {}
768
- # HTTP header 'Accept' (if needed)
769
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
770
- # HTTP header 'Content-Type'
771
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
772
-
773
- # form parameters
774
- form_params = opts[:form_params] || {}
775
-
776
- # http body (model)
777
- post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_create_request)
778
-
779
- # return_type
780
- return_type = opts[:debug_return_type] || 'AssetReportRelayCreateResponse'
781
-
782
- # auth_names
783
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
784
-
785
- new_options = opts.merge(
786
- :operation => :"PlaidApi.asset_report_relay_create",
787
- :header_params => header_params,
788
- :query_params => query_params,
789
- :form_params => form_params,
790
- :body => post_body,
791
- :auth_names => auth_names,
792
- :return_type => return_type
793
- )
794
-
795
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
796
- if @api_client.config.debugging
797
- @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
- end
799
- return data, status_code, headers
800
- end
801
-
802
- # Retrieve an Asset Report that was shared with you
803
- # `/asset_report/relay/get` allows third parties to get an Asset Report that was shared with them, using an `asset_relay_token` that was created by the report owner.
804
- # @param asset_report_relay_get_request [AssetReportRelayGetRequest]
805
- # @param [Hash] opts the optional parameters
806
- # @return [AssetReportGetResponse]
807
- def asset_report_relay_get(asset_report_relay_get_request, opts = {})
808
- data, _status_code, _headers = asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts)
809
- data
810
- end
811
-
812
- # Retrieve an Asset Report that was shared with you
813
- # &#x60;/asset_report/relay/get&#x60; allows third parties to get an Asset Report that was shared with them, using an &#x60;asset_relay_token&#x60; that was created by the report owner.
814
- # @param asset_report_relay_get_request [AssetReportRelayGetRequest]
815
- # @param [Hash] opts the optional parameters
816
- # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
817
- def asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts = {})
818
- if @api_client.config.debugging
819
- @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_get ...'
820
- end
821
- # verify the required parameter 'asset_report_relay_get_request' is set
822
- if @api_client.config.client_side_validation && asset_report_relay_get_request.nil?
823
- fail ArgumentError, "Missing the required parameter 'asset_report_relay_get_request' when calling PlaidApi.asset_report_relay_get"
824
- end
825
- # resource path
826
- local_var_path = '/asset_report/relay/get'
827
-
828
- # query parameters
829
- query_params = opts[:query_params] || {}
830
-
831
- # header parameters
832
- header_params = opts[:header_params] || {}
833
- # HTTP header 'Accept' (if needed)
834
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
835
- # HTTP header 'Content-Type'
836
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
837
-
838
- # form parameters
839
- form_params = opts[:form_params] || {}
840
-
841
- # http body (model)
842
- post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_get_request)
843
-
844
- # return_type
845
- return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
846
-
847
- # auth_names
848
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
849
-
850
- new_options = opts.merge(
851
- :operation => :"PlaidApi.asset_report_relay_get",
852
- :header_params => header_params,
853
- :query_params => query_params,
854
- :form_params => form_params,
855
- :body => post_body,
856
- :auth_names => auth_names,
857
- :return_type => return_type
858
- )
859
-
860
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
861
- if @api_client.config.debugging
862
- @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
863
- end
864
- return data, status_code, headers
865
- end
866
-
867
- # Refresh a Relay Token's Asset Report
868
- # The `/asset_report/relay/refresh` endpoint allows third parties to refresh an Asset Report that was relayed to them, using an `asset_relay_token` that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
869
- # @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
870
- # @param [Hash] opts the optional parameters
871
- # @return [AssetReportRelayRefreshResponse]
872
- def asset_report_relay_refresh(asset_report_relay_refresh_request, opts = {})
873
- data, _status_code, _headers = asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts)
874
- data
875
- end
876
-
877
- # Refresh a Relay Token&#39;s Asset Report
878
- # The &#x60;/asset_report/relay/refresh&#x60; endpoint allows third parties to refresh an Asset Report that was relayed to them, using an &#x60;asset_relay_token&#x60; that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
879
- # @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
880
- # @param [Hash] opts the optional parameters
881
- # @return [Array<(AssetReportRelayRefreshResponse, Integer, Hash)>] AssetReportRelayRefreshResponse data, response status code and response headers
882
- def asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts = {})
883
- if @api_client.config.debugging
884
- @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_refresh ...'
885
- end
886
- # verify the required parameter 'asset_report_relay_refresh_request' is set
887
- if @api_client.config.client_side_validation && asset_report_relay_refresh_request.nil?
888
- fail ArgumentError, "Missing the required parameter 'asset_report_relay_refresh_request' when calling PlaidApi.asset_report_relay_refresh"
889
- end
890
- # resource path
891
- local_var_path = '/asset_report/relay/refresh'
892
-
893
- # query parameters
894
- query_params = opts[:query_params] || {}
895
-
896
- # header parameters
897
- header_params = opts[:header_params] || {}
898
- # HTTP header 'Accept' (if needed)
899
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
900
- # HTTP header 'Content-Type'
901
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
902
-
903
- # form parameters
904
- form_params = opts[:form_params] || {}
905
-
906
- # http body (model)
907
- post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_refresh_request)
908
-
909
- # return_type
910
- return_type = opts[:debug_return_type] || 'AssetReportRelayRefreshResponse'
911
-
912
- # auth_names
913
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
914
-
915
- new_options = opts.merge(
916
- :operation => :"PlaidApi.asset_report_relay_refresh",
917
- :header_params => header_params,
918
- :query_params => query_params,
919
- :form_params => form_params,
920
- :body => post_body,
921
- :auth_names => auth_names,
922
- :return_type => return_type
923
- )
924
-
925
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
926
- if @api_client.config.debugging
927
- @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
928
- end
929
- return data, status_code, headers
930
- end
931
-
932
- # Remove Asset Report Relay Token
933
- # The `/asset_report/relay/remove` endpoint allows you to invalidate an `asset_relay_token`, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the `asset_relay_token` gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given `asset_relay_token.
934
- # @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
935
- # @param [Hash] opts the optional parameters
936
- # @return [AssetReportRelayRemoveResponse]
937
- def asset_report_relay_remove(asset_report_relay_remove_request, opts = {})
938
- data, _status_code, _headers = asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts)
939
- data
940
- end
941
-
942
- # Remove Asset Report Relay Token
943
- # The &#x60;/asset_report/relay/remove&#x60; endpoint allows you to invalidate an &#x60;asset_relay_token&#x60;, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the &#x60;asset_relay_token&#x60; gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given &#x60;asset_relay_token.
944
- # @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
945
- # @param [Hash] opts the optional parameters
946
- # @return [Array<(AssetReportRelayRemoveResponse, Integer, Hash)>] AssetReportRelayRemoveResponse data, response status code and response headers
947
- def asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts = {})
948
- if @api_client.config.debugging
949
- @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_remove ...'
950
- end
951
- # verify the required parameter 'asset_report_relay_remove_request' is set
952
- if @api_client.config.client_side_validation && asset_report_relay_remove_request.nil?
953
- fail ArgumentError, "Missing the required parameter 'asset_report_relay_remove_request' when calling PlaidApi.asset_report_relay_remove"
954
- end
955
- # resource path
956
- local_var_path = '/asset_report/relay/remove'
957
-
958
- # query parameters
959
- query_params = opts[:query_params] || {}
960
-
961
- # header parameters
962
- header_params = opts[:header_params] || {}
963
- # HTTP header 'Accept' (if needed)
964
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
965
- # HTTP header 'Content-Type'
966
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
967
-
968
- # form parameters
969
- form_params = opts[:form_params] || {}
970
-
971
- # http body (model)
972
- post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_remove_request)
973
-
974
- # return_type
975
- return_type = opts[:debug_return_type] || 'AssetReportRelayRemoveResponse'
976
-
977
- # auth_names
978
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
979
-
980
- new_options = opts.merge(
981
- :operation => :"PlaidApi.asset_report_relay_remove",
982
- :header_params => header_params,
983
- :query_params => query_params,
984
- :form_params => form_params,
985
- :body => post_body,
986
- :auth_names => auth_names,
987
- :return_type => return_type
988
- )
989
-
990
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
991
- if @api_client.config.debugging
992
- @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
993
- end
994
- return data, status_code, headers
995
- end
996
-
997
737
  # Delete an Asset Report
998
738
  # The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
999
739
  # @param asset_report_remove_request [AssetReportRemoveRequest]
@@ -1904,6 +1644,71 @@ module Plaid
1904
1644
  return data, status_code, headers
1905
1645
  end
1906
1646
 
1647
+ # Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
1648
+ # The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
1649
+ # @param request_body [Hash<String, Object>]
1650
+ # @param [Hash] opts the optional parameters
1651
+ # @return [AssetReportFreddieGetResponse]
1652
+ def credit_asset_report_freddie_mac_get(request_body, opts = {})
1653
+ data, _status_code, _headers = credit_asset_report_freddie_mac_get_with_http_info(request_body, opts)
1654
+ data
1655
+ end
1656
+
1657
+ # Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
1658
+ # The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Asset Report in Freddie Mac&#39;s JSON format.
1659
+ # @param request_body [Hash<String, Object>]
1660
+ # @param [Hash] opts the optional parameters
1661
+ # @return [Array<(AssetReportFreddieGetResponse, Integer, Hash)>] AssetReportFreddieGetResponse data, response status code and response headers
1662
+ def credit_asset_report_freddie_mac_get_with_http_info(request_body, opts = {})
1663
+ if @api_client.config.debugging
1664
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_asset_report_freddie_mac_get ...'
1665
+ end
1666
+ # verify the required parameter 'request_body' is set
1667
+ if @api_client.config.client_side_validation && request_body.nil?
1668
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_asset_report_freddie_mac_get"
1669
+ end
1670
+ # resource path
1671
+ local_var_path = '/credit/asset_report/freddie_mac/get'
1672
+
1673
+ # query parameters
1674
+ query_params = opts[:query_params] || {}
1675
+
1676
+ # header parameters
1677
+ header_params = opts[:header_params] || {}
1678
+ # HTTP header 'Accept' (if needed)
1679
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1680
+ # HTTP header 'Content-Type'
1681
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1682
+
1683
+ # form parameters
1684
+ form_params = opts[:form_params] || {}
1685
+
1686
+ # http body (model)
1687
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
1688
+
1689
+ # return_type
1690
+ return_type = opts[:debug_return_type] || 'AssetReportFreddieGetResponse'
1691
+
1692
+ # auth_names
1693
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1694
+
1695
+ new_options = opts.merge(
1696
+ :operation => :"PlaidApi.credit_asset_report_freddie_mac_get",
1697
+ :header_params => header_params,
1698
+ :query_params => query_params,
1699
+ :form_params => form_params,
1700
+ :body => post_body,
1701
+ :auth_names => auth_names,
1702
+ :return_type => return_type
1703
+ )
1704
+
1705
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1706
+ if @api_client.config.debugging
1707
+ @api_client.config.logger.debug "API called: PlaidApi#credit_asset_report_freddie_mac_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1708
+ end
1709
+ return data, status_code, headers
1710
+ end
1711
+
1907
1712
  # Create Asset or Income Report Audit Copy Token
1908
1713
  # Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
1909
1714
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
@@ -2295,7 +2100,7 @@ module Plaid
2295
2100
  end
2296
2101
 
2297
2102
  # Check income verification eligibility and optimize conversion
2298
- # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
2103
+ # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
2299
2104
  # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
2300
2105
  # @param [Hash] opts the optional parameters
2301
2106
  # @return [CreditPayrollIncomePrecheckResponse]
@@ -2305,7 +2110,7 @@ module Plaid
2305
2110
  end
2306
2111
 
2307
2112
  # Check income verification eligibility and optimize conversion
2308
- # &#x60;/credit/payroll_income/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing &#x60;employer&#x60; data will increase the chance of receiving a useful result.
2113
+ # &#x60;/credit/payroll_income/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing &#x60;employer&#x60; data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the &#x60;employer&#x60; and &#x60;access_tokens&#x60; fields. &#x60;employer_good&#x60; and &#x60;employer_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. &#x60;employer_multi&#x60; will result in a &#x60;HIGH&#x60; confidence with multiple payroll options. Likewise, &#x60;access_good&#x60; and &#x60;access_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. Any other value for &#x60;employer&#x60; and &#x60;access_tokens&#x60; in Sandbox will result in &#x60;UNKNOWN&#x60; confidence.
2309
2114
  # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
2310
2115
  # @param [Hash] opts the optional parameters
2311
2116
  # @return [Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>] CreditPayrollIncomePrecheckResponse data, response status code and response headers
@@ -2749,31 +2554,31 @@ module Plaid
2749
2554
  return data, status_code, headers
2750
2555
  end
2751
2556
 
2752
- # List dashboard users
2753
- # List all dashboard users associated with your account.
2754
- # @param list_dashboard_user_request [ListDashboardUserRequest]
2557
+ # Retrieve Link Sessions For Your User
2558
+ # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata(for e.g. whether the user finished the bank income verification step).
2559
+ # @param credit_sessions_get_request [CreditSessionsGetRequest]
2755
2560
  # @param [Hash] opts the optional parameters
2756
- # @return [PaginatedDashboardUserListResponse]
2757
- def dashboard_user_list(list_dashboard_user_request, opts = {})
2758
- data, _status_code, _headers = dashboard_user_list_with_http_info(list_dashboard_user_request, opts)
2561
+ # @return [CreditSessionsGetResponse]
2562
+ def credit_sessions_get(credit_sessions_get_request, opts = {})
2563
+ data, _status_code, _headers = credit_sessions_get_with_http_info(credit_sessions_get_request, opts)
2759
2564
  data
2760
2565
  end
2761
2566
 
2762
- # List dashboard users
2763
- # List all dashboard users associated with your account.
2764
- # @param list_dashboard_user_request [ListDashboardUserRequest]
2567
+ # Retrieve Link Sessions For Your User
2568
+ # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata(for e.g. whether the user finished the bank income verification step).
2569
+ # @param credit_sessions_get_request [CreditSessionsGetRequest]
2765
2570
  # @param [Hash] opts the optional parameters
2766
- # @return [Array<(PaginatedDashboardUserListResponse, Integer, Hash)>] PaginatedDashboardUserListResponse data, response status code and response headers
2767
- def dashboard_user_list_with_http_info(list_dashboard_user_request, opts = {})
2571
+ # @return [Array<(CreditSessionsGetResponse, Integer, Hash)>] CreditSessionsGetResponse data, response status code and response headers
2572
+ def credit_sessions_get_with_http_info(credit_sessions_get_request, opts = {})
2768
2573
  if @api_client.config.debugging
2769
- @api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_list ...'
2574
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_sessions_get ...'
2770
2575
  end
2771
- # verify the required parameter 'list_dashboard_user_request' is set
2772
- if @api_client.config.client_side_validation && list_dashboard_user_request.nil?
2773
- fail ArgumentError, "Missing the required parameter 'list_dashboard_user_request' when calling PlaidApi.dashboard_user_list"
2576
+ # verify the required parameter 'credit_sessions_get_request' is set
2577
+ if @api_client.config.client_side_validation && credit_sessions_get_request.nil?
2578
+ fail ArgumentError, "Missing the required parameter 'credit_sessions_get_request' when calling PlaidApi.credit_sessions_get"
2774
2579
  end
2775
2580
  # resource path
2776
- local_var_path = '/dashboard_user/list'
2581
+ local_var_path = '/credit/sessions/get'
2777
2582
 
2778
2583
  # query parameters
2779
2584
  query_params = opts[:query_params] || {}
@@ -2789,16 +2594,16 @@ module Plaid
2789
2594
  form_params = opts[:form_params] || {}
2790
2595
 
2791
2596
  # http body (model)
2792
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_dashboard_user_request)
2597
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_sessions_get_request)
2793
2598
 
2794
2599
  # return_type
2795
- return_type = opts[:debug_return_type] || 'PaginatedDashboardUserListResponse'
2600
+ return_type = opts[:debug_return_type] || 'CreditSessionsGetResponse'
2796
2601
 
2797
2602
  # auth_names
2798
2603
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2799
2604
 
2800
2605
  new_options = opts.merge(
2801
- :operation => :"PlaidApi.dashboard_user_list",
2606
+ :operation => :"PlaidApi.credit_sessions_get",
2802
2607
  :header_params => header_params,
2803
2608
  :query_params => query_params,
2804
2609
  :form_params => form_params,
@@ -2809,33 +2614,33 @@ module Plaid
2809
2614
 
2810
2615
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2811
2616
  if @api_client.config.debugging
2812
- @api_client.config.logger.debug "API called: PlaidApi#dashboard_user_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2617
+ @api_client.config.logger.debug "API called: PlaidApi#credit_sessions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2813
2618
  end
2814
2619
  return data, status_code, headers
2815
2620
  end
2816
2621
 
2817
2622
  # Retrieve a dashboard user
2818
2623
  # Retrieve information about a dashboard user.
2819
- # @param get_dashboard_user_request [GetDashboardUserRequest]
2624
+ # @param dashboard_user_get_request [DashboardUserGetRequest]
2820
2625
  # @param [Hash] opts the optional parameters
2821
- # @return [DashboardUserResponse]
2822
- def dashobard_user_get(get_dashboard_user_request, opts = {})
2823
- data, _status_code, _headers = dashobard_user_get_with_http_info(get_dashboard_user_request, opts)
2626
+ # @return [DashboardUserGetResponse]
2627
+ def dashboard_user_get(dashboard_user_get_request, opts = {})
2628
+ data, _status_code, _headers = dashboard_user_get_with_http_info(dashboard_user_get_request, opts)
2824
2629
  data
2825
2630
  end
2826
2631
 
2827
2632
  # Retrieve a dashboard user
2828
2633
  # Retrieve information about a dashboard user.
2829
- # @param get_dashboard_user_request [GetDashboardUserRequest]
2634
+ # @param dashboard_user_get_request [DashboardUserGetRequest]
2830
2635
  # @param [Hash] opts the optional parameters
2831
- # @return [Array<(DashboardUserResponse, Integer, Hash)>] DashboardUserResponse data, response status code and response headers
2832
- def dashobard_user_get_with_http_info(get_dashboard_user_request, opts = {})
2636
+ # @return [Array<(DashboardUserGetResponse, Integer, Hash)>] DashboardUserGetResponse data, response status code and response headers
2637
+ def dashboard_user_get_with_http_info(dashboard_user_get_request, opts = {})
2833
2638
  if @api_client.config.debugging
2834
- @api_client.config.logger.debug 'Calling API: PlaidApi.dashobard_user_get ...'
2639
+ @api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_get ...'
2835
2640
  end
2836
- # verify the required parameter 'get_dashboard_user_request' is set
2837
- if @api_client.config.client_side_validation && get_dashboard_user_request.nil?
2838
- fail ArgumentError, "Missing the required parameter 'get_dashboard_user_request' when calling PlaidApi.dashobard_user_get"
2641
+ # verify the required parameter 'dashboard_user_get_request' is set
2642
+ if @api_client.config.client_side_validation && dashboard_user_get_request.nil?
2643
+ fail ArgumentError, "Missing the required parameter 'dashboard_user_get_request' when calling PlaidApi.dashboard_user_get"
2839
2644
  end
2840
2645
  # resource path
2841
2646
  local_var_path = '/dashboard_user/get'
@@ -2854,16 +2659,16 @@ module Plaid
2854
2659
  form_params = opts[:form_params] || {}
2855
2660
 
2856
2661
  # http body (model)
2857
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_dashboard_user_request)
2662
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_user_get_request)
2858
2663
 
2859
2664
  # return_type
2860
- return_type = opts[:debug_return_type] || 'DashboardUserResponse'
2665
+ return_type = opts[:debug_return_type] || 'DashboardUserGetResponse'
2861
2666
 
2862
2667
  # auth_names
2863
2668
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2864
2669
 
2865
2670
  new_options = opts.merge(
2866
- :operation => :"PlaidApi.dashobard_user_get",
2671
+ :operation => :"PlaidApi.dashboard_user_get",
2867
2672
  :header_params => header_params,
2868
2673
  :query_params => query_params,
2869
2674
  :form_params => form_params,
@@ -2874,7 +2679,72 @@ module Plaid
2874
2679
 
2875
2680
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2876
2681
  if @api_client.config.debugging
2877
- @api_client.config.logger.debug "API called: PlaidApi#dashobard_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2682
+ @api_client.config.logger.debug "API called: PlaidApi#dashboard_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2683
+ end
2684
+ return data, status_code, headers
2685
+ end
2686
+
2687
+ # List dashboard users
2688
+ # List all dashboard users associated with your account.
2689
+ # @param dashboard_user_list_request [DashboardUserListRequest]
2690
+ # @param [Hash] opts the optional parameters
2691
+ # @return [DashboardUserListResponse]
2692
+ def dashboard_user_list(dashboard_user_list_request, opts = {})
2693
+ data, _status_code, _headers = dashboard_user_list_with_http_info(dashboard_user_list_request, opts)
2694
+ data
2695
+ end
2696
+
2697
+ # List dashboard users
2698
+ # List all dashboard users associated with your account.
2699
+ # @param dashboard_user_list_request [DashboardUserListRequest]
2700
+ # @param [Hash] opts the optional parameters
2701
+ # @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
2702
+ def dashboard_user_list_with_http_info(dashboard_user_list_request, opts = {})
2703
+ if @api_client.config.debugging
2704
+ @api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_list ...'
2705
+ end
2706
+ # verify the required parameter 'dashboard_user_list_request' is set
2707
+ if @api_client.config.client_side_validation && dashboard_user_list_request.nil?
2708
+ fail ArgumentError, "Missing the required parameter 'dashboard_user_list_request' when calling PlaidApi.dashboard_user_list"
2709
+ end
2710
+ # resource path
2711
+ local_var_path = '/dashboard_user/list'
2712
+
2713
+ # query parameters
2714
+ query_params = opts[:query_params] || {}
2715
+
2716
+ # header parameters
2717
+ header_params = opts[:header_params] || {}
2718
+ # HTTP header 'Accept' (if needed)
2719
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2720
+ # HTTP header 'Content-Type'
2721
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2722
+
2723
+ # form parameters
2724
+ form_params = opts[:form_params] || {}
2725
+
2726
+ # http body (model)
2727
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_user_list_request)
2728
+
2729
+ # return_type
2730
+ return_type = opts[:debug_return_type] || 'DashboardUserListResponse'
2731
+
2732
+ # auth_names
2733
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2734
+
2735
+ new_options = opts.merge(
2736
+ :operation => :"PlaidApi.dashboard_user_list",
2737
+ :header_params => header_params,
2738
+ :query_params => query_params,
2739
+ :form_params => form_params,
2740
+ :body => post_body,
2741
+ :auth_names => auth_names,
2742
+ :return_type => return_type
2743
+ )
2744
+
2745
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2746
+ if @api_client.config.debugging
2747
+ @api_client.config.logger.debug "API called: PlaidApi#dashboard_user_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2878
2748
  end
2879
2749
  return data, status_code, headers
2880
2750
  end
@@ -3403,7 +3273,7 @@ module Plaid
3403
3273
  # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
3404
3274
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
3405
3275
  # @param [Hash] opts the optional parameters
3406
- # @return [IdentityVerificationResponse]
3276
+ # @return [IdentityVerificationCreateResponse]
3407
3277
  def identity_verification_create(identity_verification_create_request, opts = {})
3408
3278
  data, _status_code, _headers = identity_verification_create_with_http_info(identity_verification_create_request, opts)
3409
3279
  data
@@ -3413,7 +3283,7 @@ module Plaid
3413
3283
  # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code.
3414
3284
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
3415
3285
  # @param [Hash] opts the optional parameters
3416
- # @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
3286
+ # @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
3417
3287
  def identity_verification_create_with_http_info(identity_verification_create_request, opts = {})
3418
3288
  if @api_client.config.debugging
3419
3289
  @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_create ...'
@@ -3442,7 +3312,7 @@ module Plaid
3442
3312
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_create_request)
3443
3313
 
3444
3314
  # return_type
3445
- return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
3315
+ return_type = opts[:debug_return_type] || 'IdentityVerificationCreateResponse'
3446
3316
 
3447
3317
  # auth_names
3448
3318
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -3466,26 +3336,26 @@ module Plaid
3466
3336
 
3467
3337
  # Retrieve Identity Verification
3468
3338
  # Retrieve a previously created identity verification
3469
- # @param get_identity_verification_request [GetIdentityVerificationRequest]
3339
+ # @param identity_verification_get_request [IdentityVerificationGetRequest]
3470
3340
  # @param [Hash] opts the optional parameters
3471
- # @return [IdentityVerificationResponse]
3472
- def identity_verification_get(get_identity_verification_request, opts = {})
3473
- data, _status_code, _headers = identity_verification_get_with_http_info(get_identity_verification_request, opts)
3341
+ # @return [IdentityVerificationGetResponse]
3342
+ def identity_verification_get(identity_verification_get_request, opts = {})
3343
+ data, _status_code, _headers = identity_verification_get_with_http_info(identity_verification_get_request, opts)
3474
3344
  data
3475
3345
  end
3476
3346
 
3477
3347
  # Retrieve Identity Verification
3478
3348
  # Retrieve a previously created identity verification
3479
- # @param get_identity_verification_request [GetIdentityVerificationRequest]
3349
+ # @param identity_verification_get_request [IdentityVerificationGetRequest]
3480
3350
  # @param [Hash] opts the optional parameters
3481
- # @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
3482
- def identity_verification_get_with_http_info(get_identity_verification_request, opts = {})
3351
+ # @return [Array<(IdentityVerificationGetResponse, Integer, Hash)>] IdentityVerificationGetResponse data, response status code and response headers
3352
+ def identity_verification_get_with_http_info(identity_verification_get_request, opts = {})
3483
3353
  if @api_client.config.debugging
3484
3354
  @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_get ...'
3485
3355
  end
3486
- # verify the required parameter 'get_identity_verification_request' is set
3487
- if @api_client.config.client_side_validation && get_identity_verification_request.nil?
3488
- fail ArgumentError, "Missing the required parameter 'get_identity_verification_request' when calling PlaidApi.identity_verification_get"
3356
+ # verify the required parameter 'identity_verification_get_request' is set
3357
+ if @api_client.config.client_side_validation && identity_verification_get_request.nil?
3358
+ fail ArgumentError, "Missing the required parameter 'identity_verification_get_request' when calling PlaidApi.identity_verification_get"
3489
3359
  end
3490
3360
  # resource path
3491
3361
  local_var_path = '/identity_verification/get'
@@ -3504,10 +3374,10 @@ module Plaid
3504
3374
  form_params = opts[:form_params] || {}
3505
3375
 
3506
3376
  # http body (model)
3507
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_identity_verification_request)
3377
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_get_request)
3508
3378
 
3509
3379
  # return_type
3510
- return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
3380
+ return_type = opts[:debug_return_type] || 'IdentityVerificationGetResponse'
3511
3381
 
3512
3382
  # auth_names
3513
3383
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -3531,26 +3401,26 @@ module Plaid
3531
3401
 
3532
3402
  # List Identity Verifications
3533
3403
  # Filter and list Identity Verifications created by your account
3534
- # @param list_identity_verification_request [ListIdentityVerificationRequest]
3404
+ # @param identity_verification_list_request [IdentityVerificationListRequest]
3535
3405
  # @param [Hash] opts the optional parameters
3536
- # @return [PaginatedIdentityVerificationListResponse]
3537
- def identity_verification_list(list_identity_verification_request, opts = {})
3538
- data, _status_code, _headers = identity_verification_list_with_http_info(list_identity_verification_request, opts)
3406
+ # @return [IdentityVerificationListResponse]
3407
+ def identity_verification_list(identity_verification_list_request, opts = {})
3408
+ data, _status_code, _headers = identity_verification_list_with_http_info(identity_verification_list_request, opts)
3539
3409
  data
3540
3410
  end
3541
3411
 
3542
3412
  # List Identity Verifications
3543
3413
  # Filter and list Identity Verifications created by your account
3544
- # @param list_identity_verification_request [ListIdentityVerificationRequest]
3414
+ # @param identity_verification_list_request [IdentityVerificationListRequest]
3545
3415
  # @param [Hash] opts the optional parameters
3546
- # @return [Array<(PaginatedIdentityVerificationListResponse, Integer, Hash)>] PaginatedIdentityVerificationListResponse data, response status code and response headers
3547
- def identity_verification_list_with_http_info(list_identity_verification_request, opts = {})
3416
+ # @return [Array<(IdentityVerificationListResponse, Integer, Hash)>] IdentityVerificationListResponse data, response status code and response headers
3417
+ def identity_verification_list_with_http_info(identity_verification_list_request, opts = {})
3548
3418
  if @api_client.config.debugging
3549
3419
  @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_list ...'
3550
3420
  end
3551
- # verify the required parameter 'list_identity_verification_request' is set
3552
- if @api_client.config.client_side_validation && list_identity_verification_request.nil?
3553
- fail ArgumentError, "Missing the required parameter 'list_identity_verification_request' when calling PlaidApi.identity_verification_list"
3421
+ # verify the required parameter 'identity_verification_list_request' is set
3422
+ if @api_client.config.client_side_validation && identity_verification_list_request.nil?
3423
+ fail ArgumentError, "Missing the required parameter 'identity_verification_list_request' when calling PlaidApi.identity_verification_list"
3554
3424
  end
3555
3425
  # resource path
3556
3426
  local_var_path = '/identity_verification/list'
@@ -3569,10 +3439,10 @@ module Plaid
3569
3439
  form_params = opts[:form_params] || {}
3570
3440
 
3571
3441
  # http body (model)
3572
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_identity_verification_request)
3442
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_list_request)
3573
3443
 
3574
3444
  # return_type
3575
- return_type = opts[:debug_return_type] || 'PaginatedIdentityVerificationListResponse'
3445
+ return_type = opts[:debug_return_type] || 'IdentityVerificationListResponse'
3576
3446
 
3577
3447
  # auth_names
3578
3448
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -3598,7 +3468,7 @@ module Plaid
3598
3468
  # Allow a customer to retry their identity verification
3599
3469
  # @param identity_verification_retry_request [IdentityVerificationRetryRequest]
3600
3470
  # @param [Hash] opts the optional parameters
3601
- # @return [IdentityVerificationResponse]
3471
+ # @return [IdentityVerificationRetryResponse]
3602
3472
  def identity_verification_retry(identity_verification_retry_request, opts = {})
3603
3473
  data, _status_code, _headers = identity_verification_retry_with_http_info(identity_verification_retry_request, opts)
3604
3474
  data
@@ -3608,7 +3478,7 @@ module Plaid
3608
3478
  # Allow a customer to retry their identity verification
3609
3479
  # @param identity_verification_retry_request [IdentityVerificationRetryRequest]
3610
3480
  # @param [Hash] opts the optional parameters
3611
- # @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
3481
+ # @return [Array<(IdentityVerificationRetryResponse, Integer, Hash)>] IdentityVerificationRetryResponse data, response status code and response headers
3612
3482
  def identity_verification_retry_with_http_info(identity_verification_retry_request, opts = {})
3613
3483
  if @api_client.config.debugging
3614
3484
  @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_retry ...'
@@ -3637,7 +3507,7 @@ module Plaid
3637
3507
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_retry_request)
3638
3508
 
3639
3509
  # return_type
3640
- return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
3510
+ return_type = opts[:debug_return_type] || 'IdentityVerificationRetryResponse'
3641
3511
 
3642
3512
  # auth_names
3643
3513
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -5024,6 +4894,136 @@ module Plaid
5024
4894
  return data, status_code, headers
5025
4895
  end
5026
4896
 
4897
+ # Create link delivery session
4898
+ # Use the `/link_delivery/create` endpoint to create a Link Delivery session.
4899
+ # @param link_delivery_create_request [LinkDeliveryCreateRequest]
4900
+ # @param [Hash] opts the optional parameters
4901
+ # @return [LinkDeliveryCreateResponse]
4902
+ def link_delivery_create(link_delivery_create_request, opts = {})
4903
+ data, _status_code, _headers = link_delivery_create_with_http_info(link_delivery_create_request, opts)
4904
+ data
4905
+ end
4906
+
4907
+ # Create link delivery session
4908
+ # Use the &#x60;/link_delivery/create&#x60; endpoint to create a Link Delivery session.
4909
+ # @param link_delivery_create_request [LinkDeliveryCreateRequest]
4910
+ # @param [Hash] opts the optional parameters
4911
+ # @return [Array<(LinkDeliveryCreateResponse, Integer, Hash)>] LinkDeliveryCreateResponse data, response status code and response headers
4912
+ def link_delivery_create_with_http_info(link_delivery_create_request, opts = {})
4913
+ if @api_client.config.debugging
4914
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_create ...'
4915
+ end
4916
+ # verify the required parameter 'link_delivery_create_request' is set
4917
+ if @api_client.config.client_side_validation && link_delivery_create_request.nil?
4918
+ fail ArgumentError, "Missing the required parameter 'link_delivery_create_request' when calling PlaidApi.link_delivery_create"
4919
+ end
4920
+ # resource path
4921
+ local_var_path = '/link_delivery/create'
4922
+
4923
+ # query parameters
4924
+ query_params = opts[:query_params] || {}
4925
+
4926
+ # header parameters
4927
+ header_params = opts[:header_params] || {}
4928
+ # HTTP header 'Accept' (if needed)
4929
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4930
+ # HTTP header 'Content-Type'
4931
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4932
+
4933
+ # form parameters
4934
+ form_params = opts[:form_params] || {}
4935
+
4936
+ # http body (model)
4937
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_create_request)
4938
+
4939
+ # return_type
4940
+ return_type = opts[:debug_return_type] || 'LinkDeliveryCreateResponse'
4941
+
4942
+ # auth_names
4943
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4944
+
4945
+ new_options = opts.merge(
4946
+ :operation => :"PlaidApi.link_delivery_create",
4947
+ :header_params => header_params,
4948
+ :query_params => query_params,
4949
+ :form_params => form_params,
4950
+ :body => post_body,
4951
+ :auth_names => auth_names,
4952
+ :return_type => return_type
4953
+ )
4954
+
4955
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4956
+ if @api_client.config.debugging
4957
+ @api_client.config.logger.debug "API called: PlaidApi#link_delivery_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4958
+ end
4959
+ return data, status_code, headers
4960
+ end
4961
+
4962
+ # Get link delivery session
4963
+ # Use the `/link_delivery/get` endpoint to get the status of a Link Delivery session.
4964
+ # @param link_delivery_get_request [LinkDeliveryGetRequest]
4965
+ # @param [Hash] opts the optional parameters
4966
+ # @return [LinkDeliveryGetResponse]
4967
+ def link_delivery_get(link_delivery_get_request, opts = {})
4968
+ data, _status_code, _headers = link_delivery_get_with_http_info(link_delivery_get_request, opts)
4969
+ data
4970
+ end
4971
+
4972
+ # Get link delivery session
4973
+ # Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Link Delivery session.
4974
+ # @param link_delivery_get_request [LinkDeliveryGetRequest]
4975
+ # @param [Hash] opts the optional parameters
4976
+ # @return [Array<(LinkDeliveryGetResponse, Integer, Hash)>] LinkDeliveryGetResponse data, response status code and response headers
4977
+ def link_delivery_get_with_http_info(link_delivery_get_request, opts = {})
4978
+ if @api_client.config.debugging
4979
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_get ...'
4980
+ end
4981
+ # verify the required parameter 'link_delivery_get_request' is set
4982
+ if @api_client.config.client_side_validation && link_delivery_get_request.nil?
4983
+ fail ArgumentError, "Missing the required parameter 'link_delivery_get_request' when calling PlaidApi.link_delivery_get"
4984
+ end
4985
+ # resource path
4986
+ local_var_path = '/link_delivery/get'
4987
+
4988
+ # query parameters
4989
+ query_params = opts[:query_params] || {}
4990
+
4991
+ # header parameters
4992
+ header_params = opts[:header_params] || {}
4993
+ # HTTP header 'Accept' (if needed)
4994
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4995
+ # HTTP header 'Content-Type'
4996
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4997
+
4998
+ # form parameters
4999
+ form_params = opts[:form_params] || {}
5000
+
5001
+ # http body (model)
5002
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_get_request)
5003
+
5004
+ # return_type
5005
+ return_type = opts[:debug_return_type] || 'LinkDeliveryGetResponse'
5006
+
5007
+ # auth_names
5008
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5009
+
5010
+ new_options = opts.merge(
5011
+ :operation => :"PlaidApi.link_delivery_get",
5012
+ :header_params => header_params,
5013
+ :query_params => query_params,
5014
+ :form_params => form_params,
5015
+ :body => post_body,
5016
+ :auth_names => auth_names,
5017
+ :return_type => return_type
5018
+ )
5019
+
5020
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5021
+ if @api_client.config.debugging
5022
+ @api_client.config.logger.debug "API called: PlaidApi#link_delivery_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5023
+ end
5024
+ return data, status_code, headers
5025
+ end
5026
+
5027
5027
  # Create Link Token
5028
5028
  # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
5029
5029
  # @param link_token_create_request [LinkTokenCreateRequest]
@@ -5154,31 +5154,96 @@ module Plaid
5154
5154
  return data, status_code, headers
5155
5155
  end
5156
5156
 
5157
- # Creates a new client for a reseller partner end customer.
5158
- # The `/partner/v1/customers/create` endpoint is used by reseller partners to create an end customer client.
5159
- # @param partner_customers_create_request [PartnerCustomersCreateRequest]
5157
+ # Creates a new end customer for a Plaid reseller.
5158
+ # The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
5159
+ # @param partner_customer_create_request [PartnerCustomerCreateRequest]
5160
+ # @param [Hash] opts the optional parameters
5161
+ # @return [PartnerCustomerCreateResponse]
5162
+ def partner_customer_create(partner_customer_create_request, opts = {})
5163
+ data, _status_code, _headers = partner_customer_create_with_http_info(partner_customer_create_request, opts)
5164
+ data
5165
+ end
5166
+
5167
+ # Creates a new end customer for a Plaid reseller.
5168
+ # The &#x60;/partner/customer/create&#x60; endpoint is used by reseller partners to create end customers.
5169
+ # @param partner_customer_create_request [PartnerCustomerCreateRequest]
5170
+ # @param [Hash] opts the optional parameters
5171
+ # @return [Array<(PartnerCustomerCreateResponse, Integer, Hash)>] PartnerCustomerCreateResponse data, response status code and response headers
5172
+ def partner_customer_create_with_http_info(partner_customer_create_request, opts = {})
5173
+ if @api_client.config.debugging
5174
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_create ...'
5175
+ end
5176
+ # verify the required parameter 'partner_customer_create_request' is set
5177
+ if @api_client.config.client_side_validation && partner_customer_create_request.nil?
5178
+ fail ArgumentError, "Missing the required parameter 'partner_customer_create_request' when calling PlaidApi.partner_customer_create"
5179
+ end
5180
+ # resource path
5181
+ local_var_path = '/partner/customer/create'
5182
+
5183
+ # query parameters
5184
+ query_params = opts[:query_params] || {}
5185
+
5186
+ # header parameters
5187
+ header_params = opts[:header_params] || {}
5188
+ # HTTP header 'Accept' (if needed)
5189
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5190
+ # HTTP header 'Content-Type'
5191
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5192
+
5193
+ # form parameters
5194
+ form_params = opts[:form_params] || {}
5195
+
5196
+ # http body (model)
5197
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_create_request)
5198
+
5199
+ # return_type
5200
+ return_type = opts[:debug_return_type] || 'PartnerCustomerCreateResponse'
5201
+
5202
+ # auth_names
5203
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5204
+
5205
+ new_options = opts.merge(
5206
+ :operation => :"PlaidApi.partner_customer_create",
5207
+ :header_params => header_params,
5208
+ :query_params => query_params,
5209
+ :form_params => form_params,
5210
+ :body => post_body,
5211
+ :auth_names => auth_names,
5212
+ :return_type => return_type
5213
+ )
5214
+
5215
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5216
+ if @api_client.config.debugging
5217
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5218
+ end
5219
+ return data, status_code, headers
5220
+ end
5221
+
5222
+ # Returns a Plaid reseller's end customer.
5223
+ # The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.
5224
+ # @param partner_customer_get_request [PartnerCustomerGetRequest]
5160
5225
  # @param [Hash] opts the optional parameters
5161
- # @return [PartnerCustomersCreateResponse]
5162
- def partner_customers_create(partner_customers_create_request, opts = {})
5163
- data, _status_code, _headers = partner_customers_create_with_http_info(partner_customers_create_request, opts)
5226
+ # @return [PartnerCustomerGetResponse]
5227
+ def partner_customer_get(partner_customer_get_request, opts = {})
5228
+ data, _status_code, _headers = partner_customer_get_with_http_info(partner_customer_get_request, opts)
5164
5229
  data
5165
5230
  end
5166
5231
 
5167
- # Creates a new client for a reseller partner end customer.
5168
- # The &#x60;/partner/v1/customers/create&#x60; endpoint is used by reseller partners to create an end customer client.
5169
- # @param partner_customers_create_request [PartnerCustomersCreateRequest]
5232
+ # Returns a Plaid reseller&#39;s end customer.
5233
+ # The &#x60;/partner/customer/get&#x60; endpoint is used by reseller partners to retrieve data about a single end customer.
5234
+ # @param partner_customer_get_request [PartnerCustomerGetRequest]
5170
5235
  # @param [Hash] opts the optional parameters
5171
- # @return [Array<(PartnerCustomersCreateResponse, Integer, Hash)>] PartnerCustomersCreateResponse data, response status code and response headers
5172
- def partner_customers_create_with_http_info(partner_customers_create_request, opts = {})
5236
+ # @return [Array<(PartnerCustomerGetResponse, Integer, Hash)>] PartnerCustomerGetResponse data, response status code and response headers
5237
+ def partner_customer_get_with_http_info(partner_customer_get_request, opts = {})
5173
5238
  if @api_client.config.debugging
5174
- @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customers_create ...'
5239
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_get ...'
5175
5240
  end
5176
- # verify the required parameter 'partner_customers_create_request' is set
5177
- if @api_client.config.client_side_validation && partner_customers_create_request.nil?
5178
- fail ArgumentError, "Missing the required parameter 'partner_customers_create_request' when calling PlaidApi.partner_customers_create"
5241
+ # verify the required parameter 'partner_customer_get_request' is set
5242
+ if @api_client.config.client_side_validation && partner_customer_get_request.nil?
5243
+ fail ArgumentError, "Missing the required parameter 'partner_customer_get_request' when calling PlaidApi.partner_customer_get"
5179
5244
  end
5180
5245
  # resource path
5181
- local_var_path = '/beta/partner/v1/customers/create'
5246
+ local_var_path = '/partner/customer/get'
5182
5247
 
5183
5248
  # query parameters
5184
5249
  query_params = opts[:query_params] || {}
@@ -5194,16 +5259,16 @@ module Plaid
5194
5259
  form_params = opts[:form_params] || {}
5195
5260
 
5196
5261
  # http body (model)
5197
- post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customers_create_request)
5262
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_get_request)
5198
5263
 
5199
5264
  # return_type
5200
- return_type = opts[:debug_return_type] || 'PartnerCustomersCreateResponse'
5265
+ return_type = opts[:debug_return_type] || 'PartnerCustomerGetResponse'
5201
5266
 
5202
5267
  # auth_names
5203
5268
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5204
5269
 
5205
5270
  new_options = opts.merge(
5206
- :operation => :"PlaidApi.partner_customers_create",
5271
+ :operation => :"PlaidApi.partner_customer_get",
5207
5272
  :header_params => header_params,
5208
5273
  :query_params => query_params,
5209
5274
  :form_params => form_params,
@@ -5214,7 +5279,7 @@ module Plaid
5214
5279
 
5215
5280
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5216
5281
  if @api_client.config.debugging
5217
- @api_client.config.logger.debug "API called: PlaidApi#partner_customers_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5282
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5218
5283
  end
5219
5284
  return data, status_code, headers
5220
5285
  end
@@ -5675,7 +5740,7 @@ module Plaid
5675
5740
  end
5676
5741
 
5677
5742
  # Reverse an existing payment
5678
- # Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
5743
+ # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use `/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
5679
5744
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5680
5745
  # @param [Hash] opts the optional parameters
5681
5746
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -5685,7 +5750,7 @@ module Plaid
5685
5750
  end
5686
5751
 
5687
5752
  # Reverse an existing payment
5688
- # Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender&#39;s account.
5753
+ # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use &#x60;/wallet/transaction/execute&#x60;, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
5689
5754
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5690
5755
  # @param [Hash] opts the optional parameters
5691
5756
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -5740,7 +5805,7 @@ module Plaid
5740
5805
  end
5741
5806
 
5742
5807
  # Create payment recipient
5743
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
5808
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
5744
5809
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
5745
5810
  # @param [Hash] opts the optional parameters
5746
5811
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -5750,7 +5815,7 @@ module Plaid
5750
5815
  end
5751
5816
 
5752
5817
  # Create payment recipient
5753
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
5818
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
5754
5819
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
5755
5820
  # @param [Hash] opts the optional parameters
5756
5821
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -5935,7 +6000,7 @@ module Plaid
5935
6000
  end
5936
6001
 
5937
6002
  # Create payment profile
5938
- # Use `/payment_profile/create` endpoint to create a new payment profile, the return value is a Payment Profile ID. Attach it to the link token create request and the link workflow will then \"activate\" this Payment Profile if the linkage is successful. It can then be used to create Transfers using `/transfer/authorization/create` and /transfer/create`.
6003
+ # Use `/payment_profile/create` endpoint to create a new payment profile, identified by a Payment Profile ID. To initiate the account linking experience, call `/link/token/create` and provide the Payment Profile ID in the `transfer.payment_profile_id` field. You can then use the Payment Profile ID when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
5939
6004
  # @param payment_profile_create_request [PaymentProfileCreateRequest]
5940
6005
  # @param [Hash] opts the optional parameters
5941
6006
  # @return [PaymentProfileCreateResponse]
@@ -5945,7 +6010,7 @@ module Plaid
5945
6010
  end
5946
6011
 
5947
6012
  # Create payment profile
5948
- # Use &#x60;/payment_profile/create&#x60; endpoint to create a new payment profile, the return value is a Payment Profile ID. Attach it to the link token create request and the link workflow will then \&quot;activate\&quot; this Payment Profile if the linkage is successful. It can then be used to create Transfers using &#x60;/transfer/authorization/create&#x60; and /transfer/create&#x60;.
6013
+ # Use &#x60;/payment_profile/create&#x60; endpoint to create a new payment profile, identified by a Payment Profile ID. To initiate the account linking experience, call &#x60;/link/token/create&#x60; and provide the Payment Profile ID in the &#x60;transfer.payment_profile_id&#x60; field. You can then use the Payment Profile ID when creating transfers using &#x60;/transfer/authorization/create&#x60; and &#x60;/transfer/create&#x60;.
5949
6014
  # @param payment_profile_create_request [PaymentProfileCreateRequest]
5950
6015
  # @param [Hash] opts the optional parameters
5951
6016
  # @return [Array<(PaymentProfileCreateResponse, Integer, Hash)>] PaymentProfileCreateResponse data, response status code and response headers
@@ -6000,7 +6065,7 @@ module Plaid
6000
6065
  end
6001
6066
 
6002
6067
  # Get payment profile
6003
- # Use the `/payment_profile/get` endpoint to get the status of a given Payment Profile.
6068
+ # Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
6004
6069
  # @param payment_profile_get_request [PaymentProfileGetRequest]
6005
6070
  # @param [Hash] opts the optional parameters
6006
6071
  # @return [PaymentProfileGetResponse]
@@ -6010,7 +6075,7 @@ module Plaid
6010
6075
  end
6011
6076
 
6012
6077
  # Get payment profile
6013
- # Use the &#x60;/payment_profile/get&#x60; endpoint to get the status of a given Payment Profile.
6078
+ # Use &#x60;/payment_profile/get&#x60; endpoint to get the status of a given Payment Profile.
6014
6079
  # @param payment_profile_get_request [PaymentProfileGetRequest]
6015
6080
  # @param [Hash] opts the optional parameters
6016
6081
  # @return [Array<(PaymentProfileGetResponse, Integer, Hash)>] PaymentProfileGetResponse data, response status code and response headers
@@ -6455,7 +6520,7 @@ module Plaid
6455
6520
  end
6456
6521
 
6457
6522
  # Create Stripe bank account token
6458
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Bank account tokens can also be revoked, using `/item/remove`.
6523
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
6459
6524
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
6460
6525
  # @param [Hash] opts the optional parameters
6461
6526
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -6465,7 +6530,7 @@ module Plaid
6465
6530
  end
6466
6531
 
6467
6532
  # Create Stripe bank account token
6468
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.
6533
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user&#39;s bank account information changes or they revoke Plaid&#39;s permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new &#x60;access_token&#x60;. Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.&#39;
6469
6534
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
6470
6535
  # @param [Hash] opts the optional parameters
6471
6536
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -6520,7 +6585,7 @@ module Plaid
6520
6585
  end
6521
6586
 
6522
6587
  # Create processor token
6523
- # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using `/item/remove`.
6588
+ # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
6524
6589
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
6525
6590
  # @param [Hash] opts the optional parameters
6526
6591
  # @return [ProcessorTokenCreateResponse]
@@ -6530,7 +6595,7 @@ module Plaid
6530
6595
  end
6531
6596
 
6532
6597
  # Create processor token
6533
- # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.
6598
+ # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new &#x60;access_token&#x60;. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.
6534
6599
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
6535
6600
  # @param [Hash] opts the optional parameters
6536
6601
  # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
@@ -8210,7 +8275,7 @@ module Plaid
8210
8275
  end
8211
8276
 
8212
8277
  # Create a transfer authorization
8213
- # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. For guaranteed ACH customers, the following fields are required : `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
8278
+ # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
8214
8279
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8215
8280
  # @param [Hash] opts the optional parameters
8216
8281
  # @return [TransferAuthorizationCreateResponse]
@@ -8220,7 +8285,7 @@ module Plaid
8220
8285
  end
8221
8286
 
8222
8287
  # Create a transfer authorization
8223
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. For guaranteed ACH customers, the following fields are required : &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.
8288
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : &#x60;idempotency_key&#x60;, &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.
8224
8289
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8225
8290
  # @param [Hash] opts the optional parameters
8226
8291
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -8275,7 +8340,7 @@ module Plaid
8275
8340
  end
8276
8341
 
8277
8342
  # Cancel a transfer
8278
- # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
8343
+ # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
8279
8344
  # @param transfer_cancel_request [TransferCancelRequest]
8280
8345
  # @param [Hash] opts the optional parameters
8281
8346
  # @return [TransferCancelResponse]
@@ -8285,7 +8350,7 @@ module Plaid
8285
8350
  end
8286
8351
 
8287
8352
  # Cancel a transfer
8288
- # Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
8353
+ # Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancellation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
8289
8354
  # @param transfer_cancel_request [TransferCancelRequest]
8290
8355
  # @param [Hash] opts the optional parameters
8291
8356
  # @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
@@ -9120,7 +9185,7 @@ module Plaid
9120
9185
  end
9121
9186
 
9122
9187
  # Create user
9123
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`.
9188
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
9124
9189
  # @param user_create_request [UserCreateRequest]
9125
9190
  # @param [Hash] opts the optional parameters
9126
9191
  # @return [UserCreateResponse]
@@ -9130,7 +9195,7 @@ module Plaid
9130
9195
  end
9131
9196
 
9132
9197
  # Create user
9133
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;.
9198
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
9134
9199
  # @param user_create_request [UserCreateRequest]
9135
9200
  # @param [Hash] opts the optional parameters
9136
9201
  # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
@@ -9380,7 +9445,7 @@ module Plaid
9380
9445
  end
9381
9446
 
9382
9447
  # Execute a transaction using an e-wallet
9383
- # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
9448
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
9384
9449
  # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
9385
9450
  # @param [Hash] opts the optional parameters
9386
9451
  # @return [WalletTransactionExecuteResponse]
@@ -9390,7 +9455,7 @@ module Plaid
9390
9455
  end
9391
9456
 
9392
9457
  # Execute a transaction using an e-wallet
9393
- # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
9458
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
9394
9459
  # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
9395
9460
  # @param [Hash] opts the optional parameters
9396
9461
  # @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
@@ -9444,6 +9509,7 @@ module Plaid
9444
9509
  return data, status_code, headers
9445
9510
  end
9446
9511
 
9512
+ # Fetch an e-wallet transaction
9447
9513
  # Fetch a specific e-wallet transaction
9448
9514
  # @param wallet_transaction_get_request [WalletTransactionGetRequest]
9449
9515
  # @param [Hash] opts the optional parameters
@@ -9453,6 +9519,7 @@ module Plaid
9453
9519
  data
9454
9520
  end
9455
9521
 
9522
+ # Fetch an e-wallet transaction
9456
9523
  # Fetch a specific e-wallet transaction
9457
9524
  # @param wallet_transaction_get_request [WalletTransactionGetRequest]
9458
9525
  # @param [Hash] opts the optional parameters
@@ -9574,26 +9641,26 @@ module Plaid
9574
9641
 
9575
9642
  # Create a watchlist screening for an entity
9576
9643
  # Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
9577
- # @param create_entity_screening_request [CreateEntityScreeningRequest]
9644
+ # @param watchlist_screening_entity_create_request [WatchlistScreeningEntityCreateRequest]
9578
9645
  # @param [Hash] opts the optional parameters
9579
- # @return [EntityWatchlistScreeningResponse]
9580
- def watchlist_screening_entity_create(create_entity_screening_request, opts = {})
9581
- data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(create_entity_screening_request, opts)
9646
+ # @return [WatchlistScreeningEntityCreateResponse]
9647
+ def watchlist_screening_entity_create(watchlist_screening_entity_create_request, opts = {})
9648
+ data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts)
9582
9649
  data
9583
9650
  end
9584
9651
 
9585
9652
  # Create a watchlist screening for an entity
9586
9653
  # Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
9587
- # @param create_entity_screening_request [CreateEntityScreeningRequest]
9654
+ # @param watchlist_screening_entity_create_request [WatchlistScreeningEntityCreateRequest]
9588
9655
  # @param [Hash] opts the optional parameters
9589
- # @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
9590
- def watchlist_screening_entity_create_with_http_info(create_entity_screening_request, opts = {})
9656
+ # @return [Array<(WatchlistScreeningEntityCreateResponse, Integer, Hash)>] WatchlistScreeningEntityCreateResponse data, response status code and response headers
9657
+ def watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts = {})
9591
9658
  if @api_client.config.debugging
9592
9659
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_create ...'
9593
9660
  end
9594
- # verify the required parameter 'create_entity_screening_request' is set
9595
- if @api_client.config.client_side_validation && create_entity_screening_request.nil?
9596
- fail ArgumentError, "Missing the required parameter 'create_entity_screening_request' when calling PlaidApi.watchlist_screening_entity_create"
9661
+ # verify the required parameter 'watchlist_screening_entity_create_request' is set
9662
+ if @api_client.config.client_side_validation && watchlist_screening_entity_create_request.nil?
9663
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_create_request' when calling PlaidApi.watchlist_screening_entity_create"
9597
9664
  end
9598
9665
  # resource path
9599
9666
  local_var_path = '/watchlist_screening/entity/create'
@@ -9612,10 +9679,10 @@ module Plaid
9612
9679
  form_params = opts[:form_params] || {}
9613
9680
 
9614
9681
  # http body (model)
9615
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_entity_screening_request)
9682
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_create_request)
9616
9683
 
9617
9684
  # return_type
9618
- return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
9685
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityCreateResponse'
9619
9686
 
9620
9687
  # auth_names
9621
9688
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -9639,26 +9706,26 @@ module Plaid
9639
9706
 
9640
9707
  # Get an entity screening
9641
9708
  # Retrieve an entity watchlist screening.
9642
- # @param get_entity_watchlist_screening_request [GetEntityWatchlistScreeningRequest]
9709
+ # @param watchlist_screening_entity_get_request [WatchlistScreeningEntityGetRequest]
9643
9710
  # @param [Hash] opts the optional parameters
9644
- # @return [EntityWatchlistScreeningResponse]
9645
- def watchlist_screening_entity_get(get_entity_watchlist_screening_request, opts = {})
9646
- data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(get_entity_watchlist_screening_request, opts)
9711
+ # @return [WatchlistScreeningEntityGetResponse]
9712
+ def watchlist_screening_entity_get(watchlist_screening_entity_get_request, opts = {})
9713
+ data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts)
9647
9714
  data
9648
9715
  end
9649
9716
 
9650
9717
  # Get an entity screening
9651
9718
  # Retrieve an entity watchlist screening.
9652
- # @param get_entity_watchlist_screening_request [GetEntityWatchlistScreeningRequest]
9719
+ # @param watchlist_screening_entity_get_request [WatchlistScreeningEntityGetRequest]
9653
9720
  # @param [Hash] opts the optional parameters
9654
- # @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
9655
- def watchlist_screening_entity_get_with_http_info(get_entity_watchlist_screening_request, opts = {})
9721
+ # @return [Array<(WatchlistScreeningEntityGetResponse, Integer, Hash)>] WatchlistScreeningEntityGetResponse data, response status code and response headers
9722
+ def watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts = {})
9656
9723
  if @api_client.config.debugging
9657
9724
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_get ...'
9658
9725
  end
9659
- # verify the required parameter 'get_entity_watchlist_screening_request' is set
9660
- if @api_client.config.client_side_validation && get_entity_watchlist_screening_request.nil?
9661
- fail ArgumentError, "Missing the required parameter 'get_entity_watchlist_screening_request' when calling PlaidApi.watchlist_screening_entity_get"
9726
+ # verify the required parameter 'watchlist_screening_entity_get_request' is set
9727
+ if @api_client.config.client_side_validation && watchlist_screening_entity_get_request.nil?
9728
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_get_request' when calling PlaidApi.watchlist_screening_entity_get"
9662
9729
  end
9663
9730
  # resource path
9664
9731
  local_var_path = '/watchlist_screening/entity/get'
@@ -9677,10 +9744,10 @@ module Plaid
9677
9744
  form_params = opts[:form_params] || {}
9678
9745
 
9679
9746
  # http body (model)
9680
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_entity_watchlist_screening_request)
9747
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_get_request)
9681
9748
 
9682
9749
  # return_type
9683
- return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
9750
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityGetResponse'
9684
9751
 
9685
9752
  # auth_names
9686
9753
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -9704,26 +9771,26 @@ module Plaid
9704
9771
 
9705
9772
  # List history for entity watchlist screenings
9706
9773
  # List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
9707
- # @param list_watchlist_screening_entity_history_request [ListWatchlistScreeningEntityHistoryRequest]
9774
+ # @param watchlist_screening_entity_history_list_request [WatchlistScreeningEntityHistoryListRequest]
9708
9775
  # @param [Hash] opts the optional parameters
9709
- # @return [PaginatedEntityWatchlistScreeningListResponse]
9710
- def watchlist_screening_entity_history_list(list_watchlist_screening_entity_history_request, opts = {})
9711
- data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(list_watchlist_screening_entity_history_request, opts)
9776
+ # @return [WatchlistScreeningEntityHistoryListResponse]
9777
+ def watchlist_screening_entity_history_list(watchlist_screening_entity_history_list_request, opts = {})
9778
+ data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts)
9712
9779
  data
9713
9780
  end
9714
9781
 
9715
9782
  # List history for entity watchlist screenings
9716
9783
  # List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
9717
- # @param list_watchlist_screening_entity_history_request [ListWatchlistScreeningEntityHistoryRequest]
9784
+ # @param watchlist_screening_entity_history_list_request [WatchlistScreeningEntityHistoryListRequest]
9718
9785
  # @param [Hash] opts the optional parameters
9719
- # @return [Array<(PaginatedEntityWatchlistScreeningListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningListResponse data, response status code and response headers
9720
- def watchlist_screening_entity_history_list_with_http_info(list_watchlist_screening_entity_history_request, opts = {})
9786
+ # @return [Array<(WatchlistScreeningEntityHistoryListResponse, Integer, Hash)>] WatchlistScreeningEntityHistoryListResponse data, response status code and response headers
9787
+ def watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts = {})
9721
9788
  if @api_client.config.debugging
9722
9789
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_history_list ...'
9723
9790
  end
9724
- # verify the required parameter 'list_watchlist_screening_entity_history_request' is set
9725
- if @api_client.config.client_side_validation && list_watchlist_screening_entity_history_request.nil?
9726
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_history_request' when calling PlaidApi.watchlist_screening_entity_history_list"
9791
+ # verify the required parameter 'watchlist_screening_entity_history_list_request' is set
9792
+ if @api_client.config.client_side_validation && watchlist_screening_entity_history_list_request.nil?
9793
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_history_list_request' when calling PlaidApi.watchlist_screening_entity_history_list"
9727
9794
  end
9728
9795
  # resource path
9729
9796
  local_var_path = '/watchlist_screening/entity/history/list'
@@ -9742,10 +9809,10 @@ module Plaid
9742
9809
  form_params = opts[:form_params] || {}
9743
9810
 
9744
9811
  # http body (model)
9745
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_history_request)
9812
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_history_list_request)
9746
9813
 
9747
9814
  # return_type
9748
- return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningListResponse'
9815
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHistoryListResponse'
9749
9816
 
9750
9817
  # auth_names
9751
9818
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -9769,26 +9836,26 @@ module Plaid
9769
9836
 
9770
9837
  # List hits for entity watchlist screenings
9771
9838
  # List all hits for the entity watchlist screening.
9772
- # @param list_watchlist_screening_entity_hit_request [ListWatchlistScreeningEntityHitRequest]
9839
+ # @param watchlist_screening_entity_hit_list_request [WatchlistScreeningEntityHitListRequest]
9773
9840
  # @param [Hash] opts the optional parameters
9774
- # @return [PaginatedEntityWatchlistScreeningHitListResponse]
9775
- def watchlist_screening_entity_hits_list(list_watchlist_screening_entity_hit_request, opts = {})
9776
- data, _status_code, _headers = watchlist_screening_entity_hits_list_with_http_info(list_watchlist_screening_entity_hit_request, opts)
9841
+ # @return [WatchlistScreeningEntityHitListResponse]
9842
+ def watchlist_screening_entity_hit_list(watchlist_screening_entity_hit_list_request, opts = {})
9843
+ data, _status_code, _headers = watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts)
9777
9844
  data
9778
9845
  end
9779
9846
 
9780
9847
  # List hits for entity watchlist screenings
9781
9848
  # List all hits for the entity watchlist screening.
9782
- # @param list_watchlist_screening_entity_hit_request [ListWatchlistScreeningEntityHitRequest]
9849
+ # @param watchlist_screening_entity_hit_list_request [WatchlistScreeningEntityHitListRequest]
9783
9850
  # @param [Hash] opts the optional parameters
9784
- # @return [Array<(PaginatedEntityWatchlistScreeningHitListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningHitListResponse data, response status code and response headers
9785
- def watchlist_screening_entity_hits_list_with_http_info(list_watchlist_screening_entity_hit_request, opts = {})
9851
+ # @return [Array<(WatchlistScreeningEntityHitListResponse, Integer, Hash)>] WatchlistScreeningEntityHitListResponse data, response status code and response headers
9852
+ def watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts = {})
9786
9853
  if @api_client.config.debugging
9787
- @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_hits_list ...'
9854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_hit_list ...'
9788
9855
  end
9789
- # verify the required parameter 'list_watchlist_screening_entity_hit_request' is set
9790
- if @api_client.config.client_side_validation && list_watchlist_screening_entity_hit_request.nil?
9791
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_hit_request' when calling PlaidApi.watchlist_screening_entity_hits_list"
9856
+ # verify the required parameter 'watchlist_screening_entity_hit_list_request' is set
9857
+ if @api_client.config.client_side_validation && watchlist_screening_entity_hit_list_request.nil?
9858
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_hit_list_request' when calling PlaidApi.watchlist_screening_entity_hit_list"
9792
9859
  end
9793
9860
  # resource path
9794
9861
  local_var_path = '/watchlist_screening/entity/hit/list'
@@ -9807,16 +9874,16 @@ module Plaid
9807
9874
  form_params = opts[:form_params] || {}
9808
9875
 
9809
9876
  # http body (model)
9810
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_hit_request)
9877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_hit_list_request)
9811
9878
 
9812
9879
  # return_type
9813
- return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningHitListResponse'
9880
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHitListResponse'
9814
9881
 
9815
9882
  # auth_names
9816
9883
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9817
9884
 
9818
9885
  new_options = opts.merge(
9819
- :operation => :"PlaidApi.watchlist_screening_entity_hits_list",
9886
+ :operation => :"PlaidApi.watchlist_screening_entity_hit_list",
9820
9887
  :header_params => header_params,
9821
9888
  :query_params => query_params,
9822
9889
  :form_params => form_params,
@@ -9827,33 +9894,33 @@ module Plaid
9827
9894
 
9828
9895
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9829
9896
  if @api_client.config.debugging
9830
- @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_hits_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9897
+ @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_hit_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9831
9898
  end
9832
9899
  return data, status_code, headers
9833
9900
  end
9834
9901
 
9835
9902
  # List entity watchlist screenings
9836
9903
  # List all entity screenings.
9837
- # @param list_entity_watchlist_screening_request [ListEntityWatchlistScreeningRequest]
9904
+ # @param watchlist_screening_entity_list_request [WatchlistScreeningEntityListRequest]
9838
9905
  # @param [Hash] opts the optional parameters
9839
- # @return [PaginatedEntityWatchlistScreeningListResponse]
9840
- def watchlist_screening_entity_list(list_entity_watchlist_screening_request, opts = {})
9841
- data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(list_entity_watchlist_screening_request, opts)
9906
+ # @return [WatchlistScreeningEntityListResponse]
9907
+ def watchlist_screening_entity_list(watchlist_screening_entity_list_request, opts = {})
9908
+ data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts)
9842
9909
  data
9843
9910
  end
9844
9911
 
9845
9912
  # List entity watchlist screenings
9846
9913
  # List all entity screenings.
9847
- # @param list_entity_watchlist_screening_request [ListEntityWatchlistScreeningRequest]
9914
+ # @param watchlist_screening_entity_list_request [WatchlistScreeningEntityListRequest]
9848
9915
  # @param [Hash] opts the optional parameters
9849
- # @return [Array<(PaginatedEntityWatchlistScreeningListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningListResponse data, response status code and response headers
9850
- def watchlist_screening_entity_list_with_http_info(list_entity_watchlist_screening_request, opts = {})
9916
+ # @return [Array<(WatchlistScreeningEntityListResponse, Integer, Hash)>] WatchlistScreeningEntityListResponse data, response status code and response headers
9917
+ def watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts = {})
9851
9918
  if @api_client.config.debugging
9852
9919
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_list ...'
9853
9920
  end
9854
- # verify the required parameter 'list_entity_watchlist_screening_request' is set
9855
- if @api_client.config.client_side_validation && list_entity_watchlist_screening_request.nil?
9856
- fail ArgumentError, "Missing the required parameter 'list_entity_watchlist_screening_request' when calling PlaidApi.watchlist_screening_entity_list"
9921
+ # verify the required parameter 'watchlist_screening_entity_list_request' is set
9922
+ if @api_client.config.client_side_validation && watchlist_screening_entity_list_request.nil?
9923
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_list_request' when calling PlaidApi.watchlist_screening_entity_list"
9857
9924
  end
9858
9925
  # resource path
9859
9926
  local_var_path = '/watchlist_screening/entity/list'
@@ -9872,10 +9939,10 @@ module Plaid
9872
9939
  form_params = opts[:form_params] || {}
9873
9940
 
9874
9941
  # http body (model)
9875
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_entity_watchlist_screening_request)
9942
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_list_request)
9876
9943
 
9877
9944
  # return_type
9878
- return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningListResponse'
9945
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityListResponse'
9879
9946
 
9880
9947
  # auth_names
9881
9948
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -9899,26 +9966,26 @@ module Plaid
9899
9966
 
9900
9967
  # Get entity watchlist screening program
9901
9968
  # Get an entity watchlist screening program
9902
- # @param get_watchlist_screening_entity_program_request [GetWatchlistScreeningEntityProgramRequest]
9969
+ # @param watchlist_screening_entity_program_get_request [WatchlistScreeningEntityProgramGetRequest]
9903
9970
  # @param [Hash] opts the optional parameters
9904
- # @return [EntityWatchlistProgramResponse]
9905
- def watchlist_screening_entity_program_get(get_watchlist_screening_entity_program_request, opts = {})
9906
- data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(get_watchlist_screening_entity_program_request, opts)
9971
+ # @return [WatchlistScreeningEntityProgramGetResponse]
9972
+ def watchlist_screening_entity_program_get(watchlist_screening_entity_program_get_request, opts = {})
9973
+ data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts)
9907
9974
  data
9908
9975
  end
9909
9976
 
9910
9977
  # Get entity watchlist screening program
9911
9978
  # Get an entity watchlist screening program
9912
- # @param get_watchlist_screening_entity_program_request [GetWatchlistScreeningEntityProgramRequest]
9979
+ # @param watchlist_screening_entity_program_get_request [WatchlistScreeningEntityProgramGetRequest]
9913
9980
  # @param [Hash] opts the optional parameters
9914
- # @return [Array<(EntityWatchlistProgramResponse, Integer, Hash)>] EntityWatchlistProgramResponse data, response status code and response headers
9915
- def watchlist_screening_entity_program_get_with_http_info(get_watchlist_screening_entity_program_request, opts = {})
9981
+ # @return [Array<(WatchlistScreeningEntityProgramGetResponse, Integer, Hash)>] WatchlistScreeningEntityProgramGetResponse data, response status code and response headers
9982
+ def watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts = {})
9916
9983
  if @api_client.config.debugging
9917
9984
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_get ...'
9918
9985
  end
9919
- # verify the required parameter 'get_watchlist_screening_entity_program_request' is set
9920
- if @api_client.config.client_side_validation && get_watchlist_screening_entity_program_request.nil?
9921
- fail ArgumentError, "Missing the required parameter 'get_watchlist_screening_entity_program_request' when calling PlaidApi.watchlist_screening_entity_program_get"
9986
+ # verify the required parameter 'watchlist_screening_entity_program_get_request' is set
9987
+ if @api_client.config.client_side_validation && watchlist_screening_entity_program_get_request.nil?
9988
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_get_request' when calling PlaidApi.watchlist_screening_entity_program_get"
9922
9989
  end
9923
9990
  # resource path
9924
9991
  local_var_path = '/watchlist_screening/entity/program/get'
@@ -9937,10 +10004,10 @@ module Plaid
9937
10004
  form_params = opts[:form_params] || {}
9938
10005
 
9939
10006
  # http body (model)
9940
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_watchlist_screening_entity_program_request)
10007
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_get_request)
9941
10008
 
9942
10009
  # return_type
9943
- return_type = opts[:debug_return_type] || 'EntityWatchlistProgramResponse'
10010
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramGetResponse'
9944
10011
 
9945
10012
  # auth_names
9946
10013
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -9964,26 +10031,26 @@ module Plaid
9964
10031
 
9965
10032
  # List entity watchlist screening programs
9966
10033
  # List all entity watchlist screening programs
9967
- # @param list_watchlist_screening_entity_programs_request [ListWatchlistScreeningEntityProgramsRequest]
10034
+ # @param watchlist_screening_entity_program_list_request [WatchlistScreeningEntityProgramListRequest]
9968
10035
  # @param [Hash] opts the optional parameters
9969
- # @return [PaginatedEntityWatchlistProgramListResponse]
9970
- def watchlist_screening_entity_program_list(list_watchlist_screening_entity_programs_request, opts = {})
9971
- data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(list_watchlist_screening_entity_programs_request, opts)
10036
+ # @return [WatchlistScreeningEntityProgramListResponse]
10037
+ def watchlist_screening_entity_program_list(watchlist_screening_entity_program_list_request, opts = {})
10038
+ data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts)
9972
10039
  data
9973
10040
  end
9974
10041
 
9975
10042
  # List entity watchlist screening programs
9976
10043
  # List all entity watchlist screening programs
9977
- # @param list_watchlist_screening_entity_programs_request [ListWatchlistScreeningEntityProgramsRequest]
10044
+ # @param watchlist_screening_entity_program_list_request [WatchlistScreeningEntityProgramListRequest]
9978
10045
  # @param [Hash] opts the optional parameters
9979
- # @return [Array<(PaginatedEntityWatchlistProgramListResponse, Integer, Hash)>] PaginatedEntityWatchlistProgramListResponse data, response status code and response headers
9980
- def watchlist_screening_entity_program_list_with_http_info(list_watchlist_screening_entity_programs_request, opts = {})
10046
+ # @return [Array<(WatchlistScreeningEntityProgramListResponse, Integer, Hash)>] WatchlistScreeningEntityProgramListResponse data, response status code and response headers
10047
+ def watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts = {})
9981
10048
  if @api_client.config.debugging
9982
10049
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_list ...'
9983
10050
  end
9984
- # verify the required parameter 'list_watchlist_screening_entity_programs_request' is set
9985
- if @api_client.config.client_side_validation && list_watchlist_screening_entity_programs_request.nil?
9986
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_programs_request' when calling PlaidApi.watchlist_screening_entity_program_list"
10051
+ # verify the required parameter 'watchlist_screening_entity_program_list_request' is set
10052
+ if @api_client.config.client_side_validation && watchlist_screening_entity_program_list_request.nil?
10053
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_list_request' when calling PlaidApi.watchlist_screening_entity_program_list"
9987
10054
  end
9988
10055
  # resource path
9989
10056
  local_var_path = '/watchlist_screening/entity/program/list'
@@ -10002,10 +10069,10 @@ module Plaid
10002
10069
  form_params = opts[:form_params] || {}
10003
10070
 
10004
10071
  # http body (model)
10005
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_programs_request)
10072
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_list_request)
10006
10073
 
10007
10074
  # return_type
10008
- return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistProgramListResponse'
10075
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramListResponse'
10009
10076
 
10010
10077
  # auth_names
10011
10078
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10029,26 +10096,26 @@ module Plaid
10029
10096
 
10030
10097
  # Create a review for an entity watchlist screening
10031
10098
  # Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10032
- # @param create_entity_watchlist_screening_review_request [CreateEntityWatchlistScreeningReviewRequest]
10099
+ # @param watchlist_screening_entity_review_create_request [WatchlistScreeningEntityReviewCreateRequest]
10033
10100
  # @param [Hash] opts the optional parameters
10034
- # @return [EntityWatchlistScreeningReviewResponse]
10035
- def watchlist_screening_entity_review_create(create_entity_watchlist_screening_review_request, opts = {})
10036
- data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(create_entity_watchlist_screening_review_request, opts)
10101
+ # @return [WatchlistScreeningEntityReviewCreateResponse]
10102
+ def watchlist_screening_entity_review_create(watchlist_screening_entity_review_create_request, opts = {})
10103
+ data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts)
10037
10104
  data
10038
10105
  end
10039
10106
 
10040
10107
  # Create a review for an entity watchlist screening
10041
10108
  # Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10042
- # @param create_entity_watchlist_screening_review_request [CreateEntityWatchlistScreeningReviewRequest]
10109
+ # @param watchlist_screening_entity_review_create_request [WatchlistScreeningEntityReviewCreateRequest]
10043
10110
  # @param [Hash] opts the optional parameters
10044
- # @return [Array<(EntityWatchlistScreeningReviewResponse, Integer, Hash)>] EntityWatchlistScreeningReviewResponse data, response status code and response headers
10045
- def watchlist_screening_entity_review_create_with_http_info(create_entity_watchlist_screening_review_request, opts = {})
10111
+ # @return [Array<(WatchlistScreeningEntityReviewCreateResponse, Integer, Hash)>] WatchlistScreeningEntityReviewCreateResponse data, response status code and response headers
10112
+ def watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts = {})
10046
10113
  if @api_client.config.debugging
10047
10114
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_create ...'
10048
10115
  end
10049
- # verify the required parameter 'create_entity_watchlist_screening_review_request' is set
10050
- if @api_client.config.client_side_validation && create_entity_watchlist_screening_review_request.nil?
10051
- fail ArgumentError, "Missing the required parameter 'create_entity_watchlist_screening_review_request' when calling PlaidApi.watchlist_screening_entity_review_create"
10116
+ # verify the required parameter 'watchlist_screening_entity_review_create_request' is set
10117
+ if @api_client.config.client_side_validation && watchlist_screening_entity_review_create_request.nil?
10118
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_create_request' when calling PlaidApi.watchlist_screening_entity_review_create"
10052
10119
  end
10053
10120
  # resource path
10054
10121
  local_var_path = '/watchlist_screening/entity/review/create'
@@ -10067,10 +10134,10 @@ module Plaid
10067
10134
  form_params = opts[:form_params] || {}
10068
10135
 
10069
10136
  # http body (model)
10070
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_entity_watchlist_screening_review_request)
10137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_create_request)
10071
10138
 
10072
10139
  # return_type
10073
- return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningReviewResponse'
10140
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewCreateResponse'
10074
10141
 
10075
10142
  # auth_names
10076
10143
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10094,26 +10161,26 @@ module Plaid
10094
10161
 
10095
10162
  # List reviews for entity watchlist screenings
10096
10163
  # List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10097
- # @param list_watchlist_screening_entity_reviews_request [ListWatchlistScreeningEntityReviewsRequest]
10164
+ # @param watchlist_screening_entity_review_list_request [WatchlistScreeningEntityReviewListRequest]
10098
10165
  # @param [Hash] opts the optional parameters
10099
- # @return [PaginatedEntityWatchlistScreeningReviewListResponse]
10100
- def watchlist_screening_entity_review_list(list_watchlist_screening_entity_reviews_request, opts = {})
10101
- data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(list_watchlist_screening_entity_reviews_request, opts)
10166
+ # @return [WatchlistScreeningEntityReviewListResponse]
10167
+ def watchlist_screening_entity_review_list(watchlist_screening_entity_review_list_request, opts = {})
10168
+ data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts)
10102
10169
  data
10103
10170
  end
10104
10171
 
10105
10172
  # List reviews for entity watchlist screenings
10106
10173
  # List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10107
- # @param list_watchlist_screening_entity_reviews_request [ListWatchlistScreeningEntityReviewsRequest]
10174
+ # @param watchlist_screening_entity_review_list_request [WatchlistScreeningEntityReviewListRequest]
10108
10175
  # @param [Hash] opts the optional parameters
10109
- # @return [Array<(PaginatedEntityWatchlistScreeningReviewListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningReviewListResponse data, response status code and response headers
10110
- def watchlist_screening_entity_review_list_with_http_info(list_watchlist_screening_entity_reviews_request, opts = {})
10176
+ # @return [Array<(WatchlistScreeningEntityReviewListResponse, Integer, Hash)>] WatchlistScreeningEntityReviewListResponse data, response status code and response headers
10177
+ def watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts = {})
10111
10178
  if @api_client.config.debugging
10112
10179
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_list ...'
10113
10180
  end
10114
- # verify the required parameter 'list_watchlist_screening_entity_reviews_request' is set
10115
- if @api_client.config.client_side_validation && list_watchlist_screening_entity_reviews_request.nil?
10116
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_reviews_request' when calling PlaidApi.watchlist_screening_entity_review_list"
10181
+ # verify the required parameter 'watchlist_screening_entity_review_list_request' is set
10182
+ if @api_client.config.client_side_validation && watchlist_screening_entity_review_list_request.nil?
10183
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_list_request' when calling PlaidApi.watchlist_screening_entity_review_list"
10117
10184
  end
10118
10185
  # resource path
10119
10186
  local_var_path = '/watchlist_screening/entity/review/list'
@@ -10132,10 +10199,10 @@ module Plaid
10132
10199
  form_params = opts[:form_params] || {}
10133
10200
 
10134
10201
  # http body (model)
10135
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_reviews_request)
10202
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_list_request)
10136
10203
 
10137
10204
  # return_type
10138
- return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningReviewListResponse'
10205
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewListResponse'
10139
10206
 
10140
10207
  # auth_names
10141
10208
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10159,26 +10226,26 @@ module Plaid
10159
10226
 
10160
10227
  # Update an entity screening
10161
10228
  # Update an entity watchlist screening.
10162
- # @param update_entity_screening_request [UpdateEntityScreeningRequest] The entity screening was successfully updated.
10229
+ # @param watchlist_screening_entity_update_request [WatchlistScreeningEntityUpdateRequest] The entity screening was successfully updated.
10163
10230
  # @param [Hash] opts the optional parameters
10164
- # @return [EntityWatchlistScreeningResponse]
10165
- def watchlist_screening_entity_update(update_entity_screening_request, opts = {})
10166
- data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(update_entity_screening_request, opts)
10231
+ # @return [WatchlistScreeningEntityUpdateResponse]
10232
+ def watchlist_screening_entity_update(watchlist_screening_entity_update_request, opts = {})
10233
+ data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts)
10167
10234
  data
10168
10235
  end
10169
10236
 
10170
10237
  # Update an entity screening
10171
10238
  # Update an entity watchlist screening.
10172
- # @param update_entity_screening_request [UpdateEntityScreeningRequest] The entity screening was successfully updated.
10239
+ # @param watchlist_screening_entity_update_request [WatchlistScreeningEntityUpdateRequest] The entity screening was successfully updated.
10173
10240
  # @param [Hash] opts the optional parameters
10174
- # @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
10175
- def watchlist_screening_entity_update_with_http_info(update_entity_screening_request, opts = {})
10241
+ # @return [Array<(WatchlistScreeningEntityUpdateResponse, Integer, Hash)>] WatchlistScreeningEntityUpdateResponse data, response status code and response headers
10242
+ def watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts = {})
10176
10243
  if @api_client.config.debugging
10177
10244
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_update ...'
10178
10245
  end
10179
- # verify the required parameter 'update_entity_screening_request' is set
10180
- if @api_client.config.client_side_validation && update_entity_screening_request.nil?
10181
- fail ArgumentError, "Missing the required parameter 'update_entity_screening_request' when calling PlaidApi.watchlist_screening_entity_update"
10246
+ # verify the required parameter 'watchlist_screening_entity_update_request' is set
10247
+ if @api_client.config.client_side_validation && watchlist_screening_entity_update_request.nil?
10248
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_update_request' when calling PlaidApi.watchlist_screening_entity_update"
10182
10249
  end
10183
10250
  # resource path
10184
10251
  local_var_path = '/watchlist_screening/entity/update'
@@ -10197,10 +10264,10 @@ module Plaid
10197
10264
  form_params = opts[:form_params] || {}
10198
10265
 
10199
10266
  # http body (model)
10200
- post_body = opts[:debug_body] || @api_client.object_to_http_body(update_entity_screening_request)
10267
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_update_request)
10201
10268
 
10202
10269
  # return_type
10203
- return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
10270
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityUpdateResponse'
10204
10271
 
10205
10272
  # auth_names
10206
10273
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10224,26 +10291,26 @@ module Plaid
10224
10291
 
10225
10292
  # Create a watchlist screening for a person
10226
10293
  # Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
10227
- # @param watchlist_screening_create_request [WatchlistScreeningCreateRequest]
10294
+ # @param watchlist_screening_individual_create_request [WatchlistScreeningIndividualCreateRequest]
10228
10295
  # @param [Hash] opts the optional parameters
10229
- # @return [WatchlistScreeningIndividualResponse]
10230
- def watchlist_screening_individual_create(watchlist_screening_create_request, opts = {})
10231
- data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(watchlist_screening_create_request, opts)
10296
+ # @return [WatchlistScreeningIndividualCreateResponse]
10297
+ def watchlist_screening_individual_create(watchlist_screening_individual_create_request, opts = {})
10298
+ data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts)
10232
10299
  data
10233
10300
  end
10234
10301
 
10235
10302
  # Create a watchlist screening for a person
10236
10303
  # Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
10237
- # @param watchlist_screening_create_request [WatchlistScreeningCreateRequest]
10304
+ # @param watchlist_screening_individual_create_request [WatchlistScreeningIndividualCreateRequest]
10238
10305
  # @param [Hash] opts the optional parameters
10239
- # @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
10240
- def watchlist_screening_individual_create_with_http_info(watchlist_screening_create_request, opts = {})
10306
+ # @return [Array<(WatchlistScreeningIndividualCreateResponse, Integer, Hash)>] WatchlistScreeningIndividualCreateResponse data, response status code and response headers
10307
+ def watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts = {})
10241
10308
  if @api_client.config.debugging
10242
10309
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_create ...'
10243
10310
  end
10244
- # verify the required parameter 'watchlist_screening_create_request' is set
10245
- if @api_client.config.client_side_validation && watchlist_screening_create_request.nil?
10246
- fail ArgumentError, "Missing the required parameter 'watchlist_screening_create_request' when calling PlaidApi.watchlist_screening_individual_create"
10311
+ # verify the required parameter 'watchlist_screening_individual_create_request' is set
10312
+ if @api_client.config.client_side_validation && watchlist_screening_individual_create_request.nil?
10313
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_create_request' when calling PlaidApi.watchlist_screening_individual_create"
10247
10314
  end
10248
10315
  # resource path
10249
10316
  local_var_path = '/watchlist_screening/individual/create'
@@ -10262,10 +10329,10 @@ module Plaid
10262
10329
  form_params = opts[:form_params] || {}
10263
10330
 
10264
10331
  # http body (model)
10265
- post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_create_request)
10332
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_create_request)
10266
10333
 
10267
10334
  # return_type
10268
- return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
10335
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualCreateResponse'
10269
10336
 
10270
10337
  # auth_names
10271
10338
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10289,26 +10356,26 @@ module Plaid
10289
10356
 
10290
10357
  # Retrieve an individual watchlist screening
10291
10358
  # Retrieve a previously created individual watchlist screening
10292
- # @param get_individual_watchlist_screening_request [GetIndividualWatchlistScreeningRequest]
10359
+ # @param watchlist_screening_individual_get_request [WatchlistScreeningIndividualGetRequest]
10293
10360
  # @param [Hash] opts the optional parameters
10294
- # @return [WatchlistScreeningIndividualResponse]
10295
- def watchlist_screening_individual_get(get_individual_watchlist_screening_request, opts = {})
10296
- data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(get_individual_watchlist_screening_request, opts)
10361
+ # @return [WatchlistScreeningIndividualGetResponse]
10362
+ def watchlist_screening_individual_get(watchlist_screening_individual_get_request, opts = {})
10363
+ data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts)
10297
10364
  data
10298
10365
  end
10299
10366
 
10300
10367
  # Retrieve an individual watchlist screening
10301
10368
  # Retrieve a previously created individual watchlist screening
10302
- # @param get_individual_watchlist_screening_request [GetIndividualWatchlistScreeningRequest]
10369
+ # @param watchlist_screening_individual_get_request [WatchlistScreeningIndividualGetRequest]
10303
10370
  # @param [Hash] opts the optional parameters
10304
- # @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
10305
- def watchlist_screening_individual_get_with_http_info(get_individual_watchlist_screening_request, opts = {})
10371
+ # @return [Array<(WatchlistScreeningIndividualGetResponse, Integer, Hash)>] WatchlistScreeningIndividualGetResponse data, response status code and response headers
10372
+ def watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts = {})
10306
10373
  if @api_client.config.debugging
10307
10374
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_get ...'
10308
10375
  end
10309
- # verify the required parameter 'get_individual_watchlist_screening_request' is set
10310
- if @api_client.config.client_side_validation && get_individual_watchlist_screening_request.nil?
10311
- fail ArgumentError, "Missing the required parameter 'get_individual_watchlist_screening_request' when calling PlaidApi.watchlist_screening_individual_get"
10376
+ # verify the required parameter 'watchlist_screening_individual_get_request' is set
10377
+ if @api_client.config.client_side_validation && watchlist_screening_individual_get_request.nil?
10378
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_get_request' when calling PlaidApi.watchlist_screening_individual_get"
10312
10379
  end
10313
10380
  # resource path
10314
10381
  local_var_path = '/watchlist_screening/individual/get'
@@ -10327,10 +10394,10 @@ module Plaid
10327
10394
  form_params = opts[:form_params] || {}
10328
10395
 
10329
10396
  # http body (model)
10330
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_individual_watchlist_screening_request)
10397
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_get_request)
10331
10398
 
10332
10399
  # return_type
10333
- return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
10400
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualGetResponse'
10334
10401
 
10335
10402
  # auth_names
10336
10403
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10354,26 +10421,26 @@ module Plaid
10354
10421
 
10355
10422
  # List history for individual watchlist screenings
10356
10423
  # List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
10357
- # @param list_watchlist_screening_individual_history_request [ListWatchlistScreeningIndividualHistoryRequest]
10424
+ # @param watchlist_screening_individual_history_list_request [WatchlistScreeningIndividualHistoryListRequest]
10358
10425
  # @param [Hash] opts the optional parameters
10359
- # @return [PaginatedIndividualWatchlistScreeningListResponse]
10360
- def watchlist_screening_individual_history_list(list_watchlist_screening_individual_history_request, opts = {})
10361
- data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(list_watchlist_screening_individual_history_request, opts)
10426
+ # @return [WatchlistScreeningIndividualHistoryListResponse]
10427
+ def watchlist_screening_individual_history_list(watchlist_screening_individual_history_list_request, opts = {})
10428
+ data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts)
10362
10429
  data
10363
10430
  end
10364
10431
 
10365
10432
  # List history for individual watchlist screenings
10366
10433
  # List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
10367
- # @param list_watchlist_screening_individual_history_request [ListWatchlistScreeningIndividualHistoryRequest]
10434
+ # @param watchlist_screening_individual_history_list_request [WatchlistScreeningIndividualHistoryListRequest]
10368
10435
  # @param [Hash] opts the optional parameters
10369
- # @return [Array<(PaginatedIndividualWatchlistScreeningListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningListResponse data, response status code and response headers
10370
- def watchlist_screening_individual_history_list_with_http_info(list_watchlist_screening_individual_history_request, opts = {})
10436
+ # @return [Array<(WatchlistScreeningIndividualHistoryListResponse, Integer, Hash)>] WatchlistScreeningIndividualHistoryListResponse data, response status code and response headers
10437
+ def watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts = {})
10371
10438
  if @api_client.config.debugging
10372
10439
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_history_list ...'
10373
10440
  end
10374
- # verify the required parameter 'list_watchlist_screening_individual_history_request' is set
10375
- if @api_client.config.client_side_validation && list_watchlist_screening_individual_history_request.nil?
10376
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_history_request' when calling PlaidApi.watchlist_screening_individual_history_list"
10441
+ # verify the required parameter 'watchlist_screening_individual_history_list_request' is set
10442
+ if @api_client.config.client_side_validation && watchlist_screening_individual_history_list_request.nil?
10443
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_history_list_request' when calling PlaidApi.watchlist_screening_individual_history_list"
10377
10444
  end
10378
10445
  # resource path
10379
10446
  local_var_path = '/watchlist_screening/individual/history/list'
@@ -10392,10 +10459,10 @@ module Plaid
10392
10459
  form_params = opts[:form_params] || {}
10393
10460
 
10394
10461
  # http body (model)
10395
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_history_request)
10462
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_history_list_request)
10396
10463
 
10397
10464
  # return_type
10398
- return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningListResponse'
10465
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHistoryListResponse'
10399
10466
 
10400
10467
  # auth_names
10401
10468
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10419,26 +10486,26 @@ module Plaid
10419
10486
 
10420
10487
  # List hits for individual watchlist screening
10421
10488
  # List all hits found by Plaid for a particular individual watchlist screening.
10422
- # @param list_watchlist_screening_individual_hit_request [ListWatchlistScreeningIndividualHitRequest]
10489
+ # @param watchlist_screening_individual_hit_list_request [WatchlistScreeningIndividualHitListRequest]
10423
10490
  # @param [Hash] opts the optional parameters
10424
- # @return [PaginatedIndividualWatchlistScreeningHitListResponse]
10425
- def watchlist_screening_individual_hit_list(list_watchlist_screening_individual_hit_request, opts = {})
10426
- data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(list_watchlist_screening_individual_hit_request, opts)
10491
+ # @return [WatchlistScreeningIndividualHitListResponse]
10492
+ def watchlist_screening_individual_hit_list(watchlist_screening_individual_hit_list_request, opts = {})
10493
+ data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts)
10427
10494
  data
10428
10495
  end
10429
10496
 
10430
10497
  # List hits for individual watchlist screening
10431
10498
  # List all hits found by Plaid for a particular individual watchlist screening.
10432
- # @param list_watchlist_screening_individual_hit_request [ListWatchlistScreeningIndividualHitRequest]
10499
+ # @param watchlist_screening_individual_hit_list_request [WatchlistScreeningIndividualHitListRequest]
10433
10500
  # @param [Hash] opts the optional parameters
10434
- # @return [Array<(PaginatedIndividualWatchlistScreeningHitListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningHitListResponse data, response status code and response headers
10435
- def watchlist_screening_individual_hit_list_with_http_info(list_watchlist_screening_individual_hit_request, opts = {})
10501
+ # @return [Array<(WatchlistScreeningIndividualHitListResponse, Integer, Hash)>] WatchlistScreeningIndividualHitListResponse data, response status code and response headers
10502
+ def watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts = {})
10436
10503
  if @api_client.config.debugging
10437
10504
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_hit_list ...'
10438
10505
  end
10439
- # verify the required parameter 'list_watchlist_screening_individual_hit_request' is set
10440
- if @api_client.config.client_side_validation && list_watchlist_screening_individual_hit_request.nil?
10441
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_hit_request' when calling PlaidApi.watchlist_screening_individual_hit_list"
10506
+ # verify the required parameter 'watchlist_screening_individual_hit_list_request' is set
10507
+ if @api_client.config.client_side_validation && watchlist_screening_individual_hit_list_request.nil?
10508
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_hit_list_request' when calling PlaidApi.watchlist_screening_individual_hit_list"
10442
10509
  end
10443
10510
  # resource path
10444
10511
  local_var_path = '/watchlist_screening/individual/hit/list'
@@ -10457,10 +10524,10 @@ module Plaid
10457
10524
  form_params = opts[:form_params] || {}
10458
10525
 
10459
10526
  # http body (model)
10460
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_hit_request)
10527
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_hit_list_request)
10461
10528
 
10462
10529
  # return_type
10463
- return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningHitListResponse'
10530
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHitListResponse'
10464
10531
 
10465
10532
  # auth_names
10466
10533
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10484,26 +10551,26 @@ module Plaid
10484
10551
 
10485
10552
  # List Individual Watchlist Screenings
10486
10553
  # List previously created watchlist screenings for individuals
10487
- # @param list_individual_watchlist_screening_request [ListIndividualWatchlistScreeningRequest]
10554
+ # @param watchlist_screening_individual_list_request [WatchlistScreeningIndividualListRequest]
10488
10555
  # @param [Hash] opts the optional parameters
10489
- # @return [PaginatedIndividualWatchlistScreeningListResponse]
10490
- def watchlist_screening_individual_list(list_individual_watchlist_screening_request, opts = {})
10491
- data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(list_individual_watchlist_screening_request, opts)
10556
+ # @return [WatchlistScreeningIndividualListResponse]
10557
+ def watchlist_screening_individual_list(watchlist_screening_individual_list_request, opts = {})
10558
+ data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts)
10492
10559
  data
10493
10560
  end
10494
10561
 
10495
10562
  # List Individual Watchlist Screenings
10496
10563
  # List previously created watchlist screenings for individuals
10497
- # @param list_individual_watchlist_screening_request [ListIndividualWatchlistScreeningRequest]
10564
+ # @param watchlist_screening_individual_list_request [WatchlistScreeningIndividualListRequest]
10498
10565
  # @param [Hash] opts the optional parameters
10499
- # @return [Array<(PaginatedIndividualWatchlistScreeningListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningListResponse data, response status code and response headers
10500
- def watchlist_screening_individual_list_with_http_info(list_individual_watchlist_screening_request, opts = {})
10566
+ # @return [Array<(WatchlistScreeningIndividualListResponse, Integer, Hash)>] WatchlistScreeningIndividualListResponse data, response status code and response headers
10567
+ def watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts = {})
10501
10568
  if @api_client.config.debugging
10502
10569
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_list ...'
10503
10570
  end
10504
- # verify the required parameter 'list_individual_watchlist_screening_request' is set
10505
- if @api_client.config.client_side_validation && list_individual_watchlist_screening_request.nil?
10506
- fail ArgumentError, "Missing the required parameter 'list_individual_watchlist_screening_request' when calling PlaidApi.watchlist_screening_individual_list"
10571
+ # verify the required parameter 'watchlist_screening_individual_list_request' is set
10572
+ if @api_client.config.client_side_validation && watchlist_screening_individual_list_request.nil?
10573
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_list_request' when calling PlaidApi.watchlist_screening_individual_list"
10507
10574
  end
10508
10575
  # resource path
10509
10576
  local_var_path = '/watchlist_screening/individual/list'
@@ -10522,10 +10589,10 @@ module Plaid
10522
10589
  form_params = opts[:form_params] || {}
10523
10590
 
10524
10591
  # http body (model)
10525
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_individual_watchlist_screening_request)
10592
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_list_request)
10526
10593
 
10527
10594
  # return_type
10528
- return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningListResponse'
10595
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualListResponse'
10529
10596
 
10530
10597
  # auth_names
10531
10598
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10549,26 +10616,26 @@ module Plaid
10549
10616
 
10550
10617
  # Get individual watchlist screening program
10551
10618
  # Get an individual watchlist screening program
10552
- # @param get_watchlist_screening_individual_program_request [GetWatchlistScreeningIndividualProgramRequest]
10619
+ # @param watchlist_screening_individual_program_get_request [WatchlistScreeningIndividualProgramGetRequest]
10553
10620
  # @param [Hash] opts the optional parameters
10554
- # @return [IndividualWatchlistProgramResponse]
10555
- def watchlist_screening_individual_program_get(get_watchlist_screening_individual_program_request, opts = {})
10556
- data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(get_watchlist_screening_individual_program_request, opts)
10621
+ # @return [WatchlistScreeningIndividualProgramGetResponse]
10622
+ def watchlist_screening_individual_program_get(watchlist_screening_individual_program_get_request, opts = {})
10623
+ data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts)
10557
10624
  data
10558
10625
  end
10559
10626
 
10560
10627
  # Get individual watchlist screening program
10561
10628
  # Get an individual watchlist screening program
10562
- # @param get_watchlist_screening_individual_program_request [GetWatchlistScreeningIndividualProgramRequest]
10629
+ # @param watchlist_screening_individual_program_get_request [WatchlistScreeningIndividualProgramGetRequest]
10563
10630
  # @param [Hash] opts the optional parameters
10564
- # @return [Array<(IndividualWatchlistProgramResponse, Integer, Hash)>] IndividualWatchlistProgramResponse data, response status code and response headers
10565
- def watchlist_screening_individual_program_get_with_http_info(get_watchlist_screening_individual_program_request, opts = {})
10631
+ # @return [Array<(WatchlistScreeningIndividualProgramGetResponse, Integer, Hash)>] WatchlistScreeningIndividualProgramGetResponse data, response status code and response headers
10632
+ def watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts = {})
10566
10633
  if @api_client.config.debugging
10567
10634
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_get ...'
10568
10635
  end
10569
- # verify the required parameter 'get_watchlist_screening_individual_program_request' is set
10570
- if @api_client.config.client_side_validation && get_watchlist_screening_individual_program_request.nil?
10571
- fail ArgumentError, "Missing the required parameter 'get_watchlist_screening_individual_program_request' when calling PlaidApi.watchlist_screening_individual_program_get"
10636
+ # verify the required parameter 'watchlist_screening_individual_program_get_request' is set
10637
+ if @api_client.config.client_side_validation && watchlist_screening_individual_program_get_request.nil?
10638
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_get_request' when calling PlaidApi.watchlist_screening_individual_program_get"
10572
10639
  end
10573
10640
  # resource path
10574
10641
  local_var_path = '/watchlist_screening/individual/program/get'
@@ -10587,10 +10654,10 @@ module Plaid
10587
10654
  form_params = opts[:form_params] || {}
10588
10655
 
10589
10656
  # http body (model)
10590
- post_body = opts[:debug_body] || @api_client.object_to_http_body(get_watchlist_screening_individual_program_request)
10657
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_get_request)
10591
10658
 
10592
10659
  # return_type
10593
- return_type = opts[:debug_return_type] || 'IndividualWatchlistProgramResponse'
10660
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramGetResponse'
10594
10661
 
10595
10662
  # auth_names
10596
10663
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10614,26 +10681,26 @@ module Plaid
10614
10681
 
10615
10682
  # List individual watchlist screening programs
10616
10683
  # List all individual watchlist screening programs
10617
- # @param list_watchlist_screening_individual_programs_request [ListWatchlistScreeningIndividualProgramsRequest]
10684
+ # @param watchlist_screening_individual_program_list_request [WatchlistScreeningIndividualProgramListRequest]
10618
10685
  # @param [Hash] opts the optional parameters
10619
- # @return [PaginatedIndividualWatchlistProgramListResponse]
10620
- def watchlist_screening_individual_program_list(list_watchlist_screening_individual_programs_request, opts = {})
10621
- data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(list_watchlist_screening_individual_programs_request, opts)
10686
+ # @return [WatchlistScreeningIndividualProgramListResponse]
10687
+ def watchlist_screening_individual_program_list(watchlist_screening_individual_program_list_request, opts = {})
10688
+ data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts)
10622
10689
  data
10623
10690
  end
10624
10691
 
10625
10692
  # List individual watchlist screening programs
10626
10693
  # List all individual watchlist screening programs
10627
- # @param list_watchlist_screening_individual_programs_request [ListWatchlistScreeningIndividualProgramsRequest]
10694
+ # @param watchlist_screening_individual_program_list_request [WatchlistScreeningIndividualProgramListRequest]
10628
10695
  # @param [Hash] opts the optional parameters
10629
- # @return [Array<(PaginatedIndividualWatchlistProgramListResponse, Integer, Hash)>] PaginatedIndividualWatchlistProgramListResponse data, response status code and response headers
10630
- def watchlist_screening_individual_program_list_with_http_info(list_watchlist_screening_individual_programs_request, opts = {})
10696
+ # @return [Array<(WatchlistScreeningIndividualProgramListResponse, Integer, Hash)>] WatchlistScreeningIndividualProgramListResponse data, response status code and response headers
10697
+ def watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts = {})
10631
10698
  if @api_client.config.debugging
10632
10699
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_list ...'
10633
10700
  end
10634
- # verify the required parameter 'list_watchlist_screening_individual_programs_request' is set
10635
- if @api_client.config.client_side_validation && list_watchlist_screening_individual_programs_request.nil?
10636
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_programs_request' when calling PlaidApi.watchlist_screening_individual_program_list"
10701
+ # verify the required parameter 'watchlist_screening_individual_program_list_request' is set
10702
+ if @api_client.config.client_side_validation && watchlist_screening_individual_program_list_request.nil?
10703
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_list_request' when calling PlaidApi.watchlist_screening_individual_program_list"
10637
10704
  end
10638
10705
  # resource path
10639
10706
  local_var_path = '/watchlist_screening/individual/program/list'
@@ -10652,10 +10719,10 @@ module Plaid
10652
10719
  form_params = opts[:form_params] || {}
10653
10720
 
10654
10721
  # http body (model)
10655
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_programs_request)
10722
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_list_request)
10656
10723
 
10657
10724
  # return_type
10658
- return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistProgramListResponse'
10725
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramListResponse'
10659
10726
 
10660
10727
  # auth_names
10661
10728
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10679,26 +10746,26 @@ module Plaid
10679
10746
 
10680
10747
  # Create a review for an individual watchlist screening
10681
10748
  # Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10682
- # @param create_individual_watchlist_screening_review_request [CreateIndividualWatchlistScreeningReviewRequest]
10749
+ # @param watchlist_screening_individual_review_create_request [WatchlistScreeningIndividualReviewCreateRequest]
10683
10750
  # @param [Hash] opts the optional parameters
10684
- # @return [WatchlistScreeningReviewResponse]
10685
- def watchlist_screening_individual_review_create(create_individual_watchlist_screening_review_request, opts = {})
10686
- data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(create_individual_watchlist_screening_review_request, opts)
10751
+ # @return [WatchlistScreeningIndividualReviewCreateResponse]
10752
+ def watchlist_screening_individual_review_create(watchlist_screening_individual_review_create_request, opts = {})
10753
+ data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts)
10687
10754
  data
10688
10755
  end
10689
10756
 
10690
10757
  # Create a review for an individual watchlist screening
10691
10758
  # Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
10692
- # @param create_individual_watchlist_screening_review_request [CreateIndividualWatchlistScreeningReviewRequest]
10759
+ # @param watchlist_screening_individual_review_create_request [WatchlistScreeningIndividualReviewCreateRequest]
10693
10760
  # @param [Hash] opts the optional parameters
10694
- # @return [Array<(WatchlistScreeningReviewResponse, Integer, Hash)>] WatchlistScreeningReviewResponse data, response status code and response headers
10695
- def watchlist_screening_individual_review_create_with_http_info(create_individual_watchlist_screening_review_request, opts = {})
10761
+ # @return [Array<(WatchlistScreeningIndividualReviewCreateResponse, Integer, Hash)>] WatchlistScreeningIndividualReviewCreateResponse data, response status code and response headers
10762
+ def watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts = {})
10696
10763
  if @api_client.config.debugging
10697
10764
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_create ...'
10698
10765
  end
10699
- # verify the required parameter 'create_individual_watchlist_screening_review_request' is set
10700
- if @api_client.config.client_side_validation && create_individual_watchlist_screening_review_request.nil?
10701
- fail ArgumentError, "Missing the required parameter 'create_individual_watchlist_screening_review_request' when calling PlaidApi.watchlist_screening_individual_review_create"
10766
+ # verify the required parameter 'watchlist_screening_individual_review_create_request' is set
10767
+ if @api_client.config.client_side_validation && watchlist_screening_individual_review_create_request.nil?
10768
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_create_request' when calling PlaidApi.watchlist_screening_individual_review_create"
10702
10769
  end
10703
10770
  # resource path
10704
10771
  local_var_path = '/watchlist_screening/individual/review/create'
@@ -10717,10 +10784,10 @@ module Plaid
10717
10784
  form_params = opts[:form_params] || {}
10718
10785
 
10719
10786
  # http body (model)
10720
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_individual_watchlist_screening_review_request)
10787
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_create_request)
10721
10788
 
10722
10789
  # return_type
10723
- return_type = opts[:debug_return_type] || 'WatchlistScreeningReviewResponse'
10790
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewCreateResponse'
10724
10791
 
10725
10792
  # auth_names
10726
10793
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -10744,26 +10811,26 @@ module Plaid
10744
10811
 
10745
10812
  # List reviews for individual watchlist screenings
10746
10813
  # List all reviews for the individual watchlist screening.
10747
- # @param list_watchlist_screening_individual_reviews_request [ListWatchlistScreeningIndividualReviewsRequest]
10814
+ # @param watchlist_screening_individual_review_list_request [WatchlistScreeningIndividualReviewListRequest]
10748
10815
  # @param [Hash] opts the optional parameters
10749
- # @return [PaginatedIndividualWatchlistScreeningReviewListResponse]
10750
- def watchlist_screening_individual_reviews_list(list_watchlist_screening_individual_reviews_request, opts = {})
10751
- data, _status_code, _headers = watchlist_screening_individual_reviews_list_with_http_info(list_watchlist_screening_individual_reviews_request, opts)
10816
+ # @return [WatchlistScreeningIndividualReviewListResponse]
10817
+ def watchlist_screening_individual_review_list(watchlist_screening_individual_review_list_request, opts = {})
10818
+ data, _status_code, _headers = watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts)
10752
10819
  data
10753
10820
  end
10754
10821
 
10755
10822
  # List reviews for individual watchlist screenings
10756
10823
  # List all reviews for the individual watchlist screening.
10757
- # @param list_watchlist_screening_individual_reviews_request [ListWatchlistScreeningIndividualReviewsRequest]
10824
+ # @param watchlist_screening_individual_review_list_request [WatchlistScreeningIndividualReviewListRequest]
10758
10825
  # @param [Hash] opts the optional parameters
10759
- # @return [Array<(PaginatedIndividualWatchlistScreeningReviewListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningReviewListResponse data, response status code and response headers
10760
- def watchlist_screening_individual_reviews_list_with_http_info(list_watchlist_screening_individual_reviews_request, opts = {})
10826
+ # @return [Array<(WatchlistScreeningIndividualReviewListResponse, Integer, Hash)>] WatchlistScreeningIndividualReviewListResponse data, response status code and response headers
10827
+ def watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts = {})
10761
10828
  if @api_client.config.debugging
10762
- @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_reviews_list ...'
10829
+ @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_list ...'
10763
10830
  end
10764
- # verify the required parameter 'list_watchlist_screening_individual_reviews_request' is set
10765
- if @api_client.config.client_side_validation && list_watchlist_screening_individual_reviews_request.nil?
10766
- fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_reviews_request' when calling PlaidApi.watchlist_screening_individual_reviews_list"
10831
+ # verify the required parameter 'watchlist_screening_individual_review_list_request' is set
10832
+ if @api_client.config.client_side_validation && watchlist_screening_individual_review_list_request.nil?
10833
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_list_request' when calling PlaidApi.watchlist_screening_individual_review_list"
10767
10834
  end
10768
10835
  # resource path
10769
10836
  local_var_path = '/watchlist_screening/individual/review/list'
@@ -10782,16 +10849,16 @@ module Plaid
10782
10849
  form_params = opts[:form_params] || {}
10783
10850
 
10784
10851
  # http body (model)
10785
- post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_reviews_request)
10852
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_list_request)
10786
10853
 
10787
10854
  # return_type
10788
- return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningReviewListResponse'
10855
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewListResponse'
10789
10856
 
10790
10857
  # auth_names
10791
10858
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10792
10859
 
10793
10860
  new_options = opts.merge(
10794
- :operation => :"PlaidApi.watchlist_screening_individual_reviews_list",
10861
+ :operation => :"PlaidApi.watchlist_screening_individual_review_list",
10795
10862
  :header_params => header_params,
10796
10863
  :query_params => query_params,
10797
10864
  :form_params => form_params,
@@ -10802,33 +10869,33 @@ module Plaid
10802
10869
 
10803
10870
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10804
10871
  if @api_client.config.debugging
10805
- @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_reviews_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10872
+ @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_review_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10806
10873
  end
10807
10874
  return data, status_code, headers
10808
10875
  end
10809
10876
 
10810
10877
  # Update individual watchlist screening
10811
10878
  # Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.
10812
- # @param update_individual_screening_request [UpdateIndividualScreeningRequest]
10879
+ # @param watchlist_screening_individual_update_request [WatchlistScreeningIndividualUpdateRequest]
10813
10880
  # @param [Hash] opts the optional parameters
10814
- # @return [WatchlistScreeningIndividualResponse]
10815
- def watchlist_screening_individual_update(update_individual_screening_request, opts = {})
10816
- data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(update_individual_screening_request, opts)
10881
+ # @return [WatchlistScreeningIndividualUpdateResponse]
10882
+ def watchlist_screening_individual_update(watchlist_screening_individual_update_request, opts = {})
10883
+ data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts)
10817
10884
  data
10818
10885
  end
10819
10886
 
10820
10887
  # Update individual watchlist screening
10821
10888
  # Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update &#x60;search_terms&#x60; and &#x60;status&#x60; at the same time since editing &#x60;search_terms&#x60; may trigger an automatic &#x60;status&#x60; change.
10822
- # @param update_individual_screening_request [UpdateIndividualScreeningRequest]
10889
+ # @param watchlist_screening_individual_update_request [WatchlistScreeningIndividualUpdateRequest]
10823
10890
  # @param [Hash] opts the optional parameters
10824
- # @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
10825
- def watchlist_screening_individual_update_with_http_info(update_individual_screening_request, opts = {})
10891
+ # @return [Array<(WatchlistScreeningIndividualUpdateResponse, Integer, Hash)>] WatchlistScreeningIndividualUpdateResponse data, response status code and response headers
10892
+ def watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts = {})
10826
10893
  if @api_client.config.debugging
10827
10894
  @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_update ...'
10828
10895
  end
10829
- # verify the required parameter 'update_individual_screening_request' is set
10830
- if @api_client.config.client_side_validation && update_individual_screening_request.nil?
10831
- fail ArgumentError, "Missing the required parameter 'update_individual_screening_request' when calling PlaidApi.watchlist_screening_individual_update"
10896
+ # verify the required parameter 'watchlist_screening_individual_update_request' is set
10897
+ if @api_client.config.client_side_validation && watchlist_screening_individual_update_request.nil?
10898
+ fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_update_request' when calling PlaidApi.watchlist_screening_individual_update"
10832
10899
  end
10833
10900
  # resource path
10834
10901
  local_var_path = '/watchlist_screening/individual/update'
@@ -10847,10 +10914,10 @@ module Plaid
10847
10914
  form_params = opts[:form_params] || {}
10848
10915
 
10849
10916
  # http body (model)
10850
- post_body = opts[:debug_body] || @api_client.object_to_http_body(update_individual_screening_request)
10917
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_update_request)
10851
10918
 
10852
10919
  # return_type
10853
- return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
10920
+ return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualUpdateResponse'
10854
10921
 
10855
10922
  # auth_names
10856
10923
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']