plaid 13.2.0 → 42.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1908) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4719 -4
  3. data/CONTRIBUTING.md +14 -59
  4. data/Dockerfile +15 -0
  5. data/Gemfile.lock +58 -45
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +11 -0
  8. data/README.md +254 -122
  9. data/Rakefile +8 -79
  10. data/UPGRADING.md +4 -0
  11. data/lib/plaid/api/plaid_api.rb +20823 -0
  12. data/lib/plaid/api_client.rb +412 -0
  13. data/lib/plaid/api_error.rb +58 -0
  14. data/lib/plaid/configuration.rb +317 -0
  15. data/lib/plaid/models/account_access.rb +249 -0
  16. data/lib/plaid/models/account_assets.rb +440 -0
  17. data/lib/plaid/models/account_balance.rb +277 -0
  18. data/lib/plaid/models/account_base.rb +384 -0
  19. data/lib/plaid/models/account_base_nullable.rb +391 -0
  20. data/lib/plaid/models/account_filter.rb +259 -0
  21. data/lib/plaid/models/account_filters_response.rb +247 -0
  22. data/lib/plaid/models/account_holder_category.rb +40 -0
  23. data/lib/plaid/models/account_identity.rb +409 -0
  24. data/lib/plaid/models/account_identity_all_of.rb +227 -0
  25. data/lib/plaid/models/account_identity_document_upload.rb +422 -0
  26. data/lib/plaid/models/account_identity_document_upload_all_of.rb +240 -0
  27. data/lib/plaid/models/account_identity_match_score.rb +432 -0
  28. data/lib/plaid/models/account_identity_match_score_all_of.rb +250 -0
  29. data/lib/plaid/models/account_product_access.rb +250 -0
  30. data/lib/plaid/models/account_product_access_nullable.rb +257 -0
  31. data/lib/plaid/models/account_selection_cardinality.rb +40 -0
  32. data/lib/plaid/models/account_subtype.rb +107 -0
  33. data/lib/plaid/models/account_type.rb +43 -0
  34. data/lib/plaid/models/account_verification_insights.rb +281 -0
  35. data/lib/plaid/models/account_verification_insights_account_number_format.rb +40 -0
  36. data/lib/plaid/models/account_verification_insights_network_status.rb +241 -0
  37. data/lib/plaid/models/account_verification_insights_previous_returns.rb +226 -0
  38. data/lib/plaid/models/accounts_balance_get_request.rb +255 -0
  39. data/lib/plaid/models/accounts_balance_get_request_options.rb +233 -0
  40. data/lib/plaid/models/accounts_get_request.rb +255 -0
  41. data/lib/plaid/models/accounts_get_request_options.rb +223 -0
  42. data/lib/plaid/models/accounts_get_response.rb +257 -0
  43. data/lib/plaid/models/ach_class.rb +41 -0
  44. data/lib/plaid/models/action_state.rb +42 -0
  45. data/lib/plaid/models/activity.rb +335 -0
  46. data/lib/plaid/models/activity_type.rb +47 -0
  47. data/lib/plaid/models/address.rb +235 -0
  48. data/lib/plaid/models/address_data.rb +270 -0
  49. data/lib/plaid/models/address_data_not_required.rb +265 -0
  50. data/lib/plaid/models/address_data_nullable.rb +277 -0
  51. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +272 -0
  52. data/lib/plaid/models/address_match_score.rb +233 -0
  53. data/lib/plaid/models/address_nullable.rb +242 -0
  54. data/lib/plaid/models/address_purpose_label.rb +40 -0
  55. data/lib/plaid/models/application.rb +366 -0
  56. data/lib/plaid/models/application_get_request.rb +256 -0
  57. data/lib/plaid/models/application_get_response.rb +240 -0
  58. data/lib/plaid/models/apr.rb +297 -0
  59. data/lib/plaid/models/asset.rb +281 -0
  60. data/lib/plaid/models/asset_detail.rb +370 -0
  61. data/lib/plaid/models/asset_holder.rb +225 -0
  62. data/lib/plaid/models/asset_holder_name.rb +226 -0
  63. data/lib/plaid/models/asset_owner.rb +222 -0
  64. data/lib/plaid/models/asset_owners.rb +228 -0
  65. data/lib/plaid/models/asset_report.rb +298 -0
  66. data/lib/plaid/models/asset_report_account_balance.rb +288 -0
  67. data/lib/plaid/models/asset_report_add_ons.rb +39 -0
  68. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +256 -0
  69. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +241 -0
  70. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +246 -0
  71. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +246 -0
  72. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +241 -0
  73. data/lib/plaid/models/asset_report_create_request.rb +315 -0
  74. data/lib/plaid/models/asset_report_create_request_options.rb +290 -0
  75. data/lib/plaid/models/asset_report_create_response.rb +256 -0
  76. data/lib/plaid/models/asset_report_filter_request.rb +263 -0
  77. data/lib/plaid/models/asset_report_filter_response.rb +256 -0
  78. data/lib/plaid/models/asset_report_freddie.rb +253 -0
  79. data/lib/plaid/models/asset_report_freddie_get_request.rb +246 -0
  80. data/lib/plaid/models/asset_report_freddie_get_response.rb +255 -0
  81. data/lib/plaid/models/asset_report_get_request.rb +284 -0
  82. data/lib/plaid/models/asset_report_get_request_options.rb +248 -0
  83. data/lib/plaid/models/asset_report_get_response.rb +257 -0
  84. data/lib/plaid/models/asset_report_investment_holding.rb +341 -0
  85. data/lib/plaid/models/asset_report_investment_security.rb +259 -0
  86. data/lib/plaid/models/asset_report_investment_transaction.rb +440 -0
  87. data/lib/plaid/models/asset_report_investments.rb +247 -0
  88. data/lib/plaid/models/asset_report_item.rb +288 -0
  89. data/lib/plaid/models/asset_report_pdf_get_request.rb +255 -0
  90. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +248 -0
  91. data/lib/plaid/models/asset_report_refresh_request.rb +292 -0
  92. data/lib/plaid/models/asset_report_refresh_request_options.rb +242 -0
  93. data/lib/plaid/models/asset_report_refresh_response.rb +256 -0
  94. data/lib/plaid/models/asset_report_remove_request.rb +246 -0
  95. data/lib/plaid/models/asset_report_remove_response.rb +241 -0
  96. data/lib/plaid/models/asset_report_transaction.rb +477 -0
  97. data/lib/plaid/models/asset_report_transaction_type.rb +41 -0
  98. data/lib/plaid/models/asset_report_type.rb +39 -0
  99. data/lib/plaid/models/asset_report_user.rb +288 -0
  100. data/lib/plaid/models/asset_transaction.rb +242 -0
  101. data/lib/plaid/models/asset_transaction_category_type.rb +144 -0
  102. data/lib/plaid/models/asset_transaction_description.rb +226 -0
  103. data/lib/plaid/models/asset_transaction_detail.rb +350 -0
  104. data/lib/plaid/models/asset_transaction_type.rb +39 -0
  105. data/lib/plaid/models/asset_transactions.rb +227 -0
  106. data/lib/plaid/models/asset_type.rb +42 -0
  107. data/lib/plaid/models/assets.rb +228 -0
  108. data/lib/plaid/models/assets_error_webhook.rb +312 -0
  109. data/lib/plaid/models/assets_product_ready_webhook.rb +311 -0
  110. data/lib/plaid/models/auth_default_update_webhook.rb +336 -0
  111. data/lib/plaid/models/auth_get_numbers.rb +279 -0
  112. data/lib/plaid/models/auth_get_request.rb +255 -0
  113. data/lib/plaid/models/auth_get_request_options.rb +223 -0
  114. data/lib/plaid/models/auth_get_response.rb +271 -0
  115. data/lib/plaid/models/auth_metadata.rb +221 -0
  116. data/lib/plaid/models/auth_supported_methods.rb +271 -0
  117. data/lib/plaid/models/auth_update_types.rb +39 -0
  118. data/lib/plaid/models/automatically_verified_webhook.rb +317 -0
  119. data/lib/plaid/models/bank_income_complete_result.rb +39 -0
  120. data/lib/plaid/models/bank_income_complete_webhook.rb +306 -0
  121. data/lib/plaid/models/bank_income_refresh_complete_result.rb +39 -0
  122. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +306 -0
  123. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +292 -0
  124. data/lib/plaid/models/bank_initiated_return_risk.rb +301 -0
  125. data/lib/plaid/models/bank_transfer.rb +476 -0
  126. data/lib/plaid/models/bank_transfer_balance.rb +241 -0
  127. data/lib/plaid/models/bank_transfer_balance_get_request.rb +242 -0
  128. data/lib/plaid/models/bank_transfer_balance_get_response.rb +251 -0
  129. data/lib/plaid/models/bank_transfer_cancel_request.rb +246 -0
  130. data/lib/plaid/models/bank_transfer_cancel_response.rb +226 -0
  131. data/lib/plaid/models/bank_transfer_create_request.rb +497 -0
  132. data/lib/plaid/models/bank_transfer_create_response.rb +240 -0
  133. data/lib/plaid/models/bank_transfer_direction.rb +40 -0
  134. data/lib/plaid/models/bank_transfer_event.rb +403 -0
  135. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
  136. data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
  137. data/lib/plaid/models/bank_transfer_event_list_request.rb +409 -0
  138. data/lib/plaid/models/bank_transfer_event_list_response.rb +242 -0
  139. data/lib/plaid/models/bank_transfer_event_sync_request.rb +306 -0
  140. data/lib/plaid/models/bank_transfer_event_sync_response.rb +242 -0
  141. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  142. data/lib/plaid/models/bank_transfer_failure.rb +232 -0
  143. data/lib/plaid/models/bank_transfer_get_request.rb +246 -0
  144. data/lib/plaid/models/bank_transfer_get_response.rb +240 -0
  145. data/lib/plaid/models/bank_transfer_list_request.rb +363 -0
  146. data/lib/plaid/models/bank_transfer_list_response.rb +242 -0
  147. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +286 -0
  148. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +256 -0
  149. data/lib/plaid/models/bank_transfer_network.rb +40 -0
  150. data/lib/plaid/models/bank_transfer_status.rb +42 -0
  151. data/lib/plaid/models/bank_transfer_sweep.rb +271 -0
  152. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +246 -0
  153. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +240 -0
  154. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +303 -0
  155. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +242 -0
  156. data/lib/plaid/models/bank_transfer_type.rb +39 -0
  157. data/lib/plaid/models/bank_transfer_user.rb +247 -0
  158. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +277 -0
  159. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +277 -0
  160. data/lib/plaid/models/base_report.rb +293 -0
  161. data/lib/plaid/models/base_report_account.rb +443 -0
  162. data/lib/plaid/models/base_report_account_balances.rb +311 -0
  163. data/lib/plaid/models/base_report_account_insights.rb +323 -0
  164. data/lib/plaid/models/base_report_account_metadata.rb +233 -0
  165. data/lib/plaid/models/base_report_attributes.rb +353 -0
  166. data/lib/plaid/models/base_report_average_flow_insights.rb +255 -0
  167. data/lib/plaid/models/base_report_average_monthly_balances.rb +255 -0
  168. data/lib/plaid/models/base_report_historical_balance.rb +263 -0
  169. data/lib/plaid/models/base_report_item.rb +288 -0
  170. data/lib/plaid/models/base_report_longest_gap_insights.rb +242 -0
  171. data/lib/plaid/models/base_report_number_flow_insights.rb +256 -0
  172. data/lib/plaid/models/base_report_transaction.rb +449 -0
  173. data/lib/plaid/models/base_report_transaction_type.rb +41 -0
  174. data/lib/plaid/models/base_report_user_attributes.rb +331 -0
  175. data/lib/plaid/models/base_report_warning.rb +272 -0
  176. data/lib/plaid/models/base_report_warning_code.rb +40 -0
  177. data/lib/plaid/models/base_reports_error_webhook.rb +302 -0
  178. data/lib/plaid/models/beacon_account_risk_attributes.rb +519 -0
  179. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +271 -0
  180. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +519 -0
  181. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +42 -0
  182. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +346 -0
  183. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +223 -0
  184. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +243 -0
  185. data/lib/plaid/models/beacon_audit_trail.rb +273 -0
  186. data/lib/plaid/models/beacon_audit_trail_source.rb +41 -0
  187. data/lib/plaid/models/beacon_bank_account_insights.rb +286 -0
  188. data/lib/plaid/models/beacon_bank_accounts.rb +242 -0
  189. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +292 -0
  190. data/lib/plaid/models/beacon_duplicate_get_request.rb +246 -0
  191. data/lib/plaid/models/beacon_duplicate_get_response.rb +283 -0
  192. data/lib/plaid/models/beacon_match_summary_analysis.rb +331 -0
  193. data/lib/plaid/models/beacon_match_summary_code.rb +41 -0
  194. data/lib/plaid/models/beacon_report.rb +342 -0
  195. data/lib/plaid/models/beacon_report_create_request.rb +307 -0
  196. data/lib/plaid/models/beacon_report_create_response.rb +357 -0
  197. data/lib/plaid/models/beacon_report_create_type.rb +43 -0
  198. data/lib/plaid/models/beacon_report_created_webhook.rb +292 -0
  199. data/lib/plaid/models/beacon_report_get_request.rb +246 -0
  200. data/lib/plaid/models/beacon_report_get_response.rb +357 -0
  201. data/lib/plaid/models/beacon_report_list_request.rb +257 -0
  202. data/lib/plaid/models/beacon_report_list_response.rb +253 -0
  203. data/lib/plaid/models/beacon_report_syndication.rb +269 -0
  204. data/lib/plaid/models/beacon_report_syndication_analysis.rb +347 -0
  205. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +292 -0
  206. data/lib/plaid/models/beacon_report_syndication_get_request.rb +246 -0
  207. data/lib/plaid/models/beacon_report_syndication_get_response.rb +284 -0
  208. data/lib/plaid/models/beacon_report_syndication_list_request.rb +257 -0
  209. data/lib/plaid/models/beacon_report_syndication_list_response.rb +253 -0
  210. data/lib/plaid/models/beacon_report_syndication_original_report.rb +299 -0
  211. data/lib/plaid/models/beacon_report_type.rb +43 -0
  212. data/lib/plaid/models/beacon_report_updated_webhook.rb +292 -0
  213. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +277 -0
  214. data/lib/plaid/models/beacon_user.rb +394 -0
  215. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +261 -0
  216. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +285 -0
  217. data/lib/plaid/models/beacon_user_address.rb +289 -0
  218. data/lib/plaid/models/beacon_user_create_request.rb +288 -0
  219. data/lib/plaid/models/beacon_user_create_response.rb +409 -0
  220. data/lib/plaid/models/beacon_user_data.rb +313 -0
  221. data/lib/plaid/models/beacon_user_depository_account.rb +256 -0
  222. data/lib/plaid/models/beacon_user_get_request.rb +246 -0
  223. data/lib/plaid/models/beacon_user_get_response.rb +409 -0
  224. data/lib/plaid/models/beacon_user_history_list_request.rb +257 -0
  225. data/lib/plaid/models/beacon_user_history_list_response.rb +253 -0
  226. data/lib/plaid/models/beacon_user_id_number.rb +262 -0
  227. data/lib/plaid/models/beacon_user_name.rb +241 -0
  228. data/lib/plaid/models/beacon_user_name_nullable.rb +241 -0
  229. data/lib/plaid/models/beacon_user_request_address.rb +289 -0
  230. data/lib/plaid/models/beacon_user_request_address_nullable.rb +289 -0
  231. data/lib/plaid/models/beacon_user_request_data.rb +299 -0
  232. data/lib/plaid/models/beacon_user_request_depository_account.rb +241 -0
  233. data/lib/plaid/models/beacon_user_review_request.rb +282 -0
  234. data/lib/plaid/models/beacon_user_revision.rb +241 -0
  235. data/lib/plaid/models/beacon_user_status.rb +40 -0
  236. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +292 -0
  237. data/lib/plaid/models/beacon_user_update_request.rb +269 -0
  238. data/lib/plaid/models/beacon_user_update_request_data.rb +294 -0
  239. data/lib/plaid/models/beacon_user_update_response.rb +409 -0
  240. data/lib/plaid/models/business_account.rb +404 -0
  241. data/lib/plaid/models/business_account_all_of.rb +222 -0
  242. data/lib/plaid/models/business_finance_category.rb +252 -0
  243. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +41 -0
  244. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +306 -0
  245. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +306 -0
  246. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +306 -0
  247. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +306 -0
  248. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +306 -0
  249. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +306 -0
  250. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +306 -0
  251. data/lib/plaid/models/cashflow_attributes_version.rb +39 -0
  252. data/lib/plaid/models/cashflow_report_account_insights.rb +245 -0
  253. data/lib/plaid/models/cashflow_report_get_request.rb +348 -0
  254. data/lib/plaid/models/cashflow_report_get_request_options.rb +223 -0
  255. data/lib/plaid/models/cashflow_report_get_response.rb +334 -0
  256. data/lib/plaid/models/cashflow_report_historical_balance.rb +263 -0
  257. data/lib/plaid/models/cashflow_report_insights_get_request.rb +246 -0
  258. data/lib/plaid/models/cashflow_report_insights_get_response.rb +286 -0
  259. data/lib/plaid/models/cashflow_report_monthly_summary.rb +448 -0
  260. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +248 -0
  261. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +248 -0
  262. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +248 -0
  263. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +248 -0
  264. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +248 -0
  265. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +248 -0
  266. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +248 -0
  267. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +248 -0
  268. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +248 -0
  269. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +248 -0
  270. data/lib/plaid/models/cashflow_report_payment_meta.rb +299 -0
  271. data/lib/plaid/models/cashflow_report_refresh_request.rb +293 -0
  272. data/lib/plaid/models/cashflow_report_refresh_response.rb +226 -0
  273. data/lib/plaid/models/cashflow_report_transaction.rb +559 -0
  274. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +303 -0
  275. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +223 -0
  276. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +319 -0
  277. data/lib/plaid/models/categories_get_response.rb +243 -0
  278. data/lib/plaid/models/category.rb +258 -0
  279. data/lib/plaid/models/category_insight_details.rb +283 -0
  280. data/lib/plaid/models/category_insights.rb +235 -0
  281. data/lib/plaid/models/cause.rb +376 -0
  282. data/lib/plaid/models/cause_all_of.rb +220 -0
  283. data/lib/plaid/models/check_report_warning.rb +272 -0
  284. data/lib/plaid/models/check_report_warning_code.rb +40 -0
  285. data/lib/plaid/models/client_provided_enhanced_transaction.rb +285 -0
  286. data/lib/plaid/models/client_provided_enriched_transaction.rb +356 -0
  287. data/lib/plaid/models/client_provided_raw_transaction.rb +271 -0
  288. data/lib/plaid/models/client_provided_transaction.rb +376 -0
  289. data/lib/plaid/models/client_provided_transaction_location.rb +261 -0
  290. data/lib/plaid/models/connected_application.rb +310 -0
  291. data/lib/plaid/models/consent_event.rb +338 -0
  292. data/lib/plaid/models/consent_event_code.rb +42 -0
  293. data/lib/plaid/models/consent_event_initiator.rb +41 -0
  294. data/lib/plaid/models/consent_event_type.rb +40 -0
  295. data/lib/plaid/models/consent_events_get_request.rb +246 -0
  296. data/lib/plaid/models/consent_events_get_response.rb +243 -0
  297. data/lib/plaid/models/consented_account.rb +292 -0
  298. data/lib/plaid/models/consumer_dispute.rb +292 -0
  299. data/lib/plaid/models/consumer_dispute_category.rb +41 -0
  300. data/lib/plaid/models/consumer_report_pdf_get_request.rb +246 -0
  301. data/lib/plaid/models/consumer_report_permissible_purpose.rb +45 -0
  302. data/lib/plaid/models/consumer_report_user_identity.rb +348 -0
  303. data/lib/plaid/models/counterparty.rb +327 -0
  304. data/lib/plaid/models/counterparty_insights.rb +235 -0
  305. data/lib/plaid/models/counterparty_numbers.rb +231 -0
  306. data/lib/plaid/models/counterparty_numbers_bacs.rb +233 -0
  307. data/lib/plaid/models/counterparty_numbers_international.rb +258 -0
  308. data/lib/plaid/models/counterparty_type.rb +43 -0
  309. data/lib/plaid/models/country_code.rb +57 -0
  310. data/lib/plaid/models/cra_bank_income_account.rb +339 -0
  311. data/lib/plaid/models/cra_bank_income_account_metadata.rb +233 -0
  312. data/lib/plaid/models/cra_bank_income_bonus_type.rb +40 -0
  313. data/lib/plaid/models/cra_bank_income_cause.rb +292 -0
  314. data/lib/plaid/models/cra_bank_income_complete_result.rb +39 -0
  315. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +301 -0
  316. data/lib/plaid/models/cra_bank_income_employer.rb +222 -0
  317. data/lib/plaid/models/cra_bank_income_error_webhook.rb +292 -0
  318. data/lib/plaid/models/cra_bank_income_historical_summary.rb +254 -0
  319. data/lib/plaid/models/cra_bank_income_item.rb +285 -0
  320. data/lib/plaid/models/cra_bank_income_source.rb +424 -0
  321. data/lib/plaid/models/cra_bank_income_summary.rb +356 -0
  322. data/lib/plaid/models/cra_bank_income_transaction.rb +357 -0
  323. data/lib/plaid/models/cra_bank_income_warning.rb +260 -0
  324. data/lib/plaid/models/cra_bank_income_warning_code.rb +41 -0
  325. data/lib/plaid/models/cra_cashflow_insights_report.rb +261 -0
  326. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +264 -0
  327. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +257 -0
  328. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +253 -0
  329. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +261 -0
  330. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +252 -0
  331. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +243 -0
  332. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +233 -0
  333. data/lib/plaid/models/cra_check_report_create_request.rb +431 -0
  334. data/lib/plaid/models/cra_check_report_create_response.rb +221 -0
  335. data/lib/plaid/models/cra_check_report_failed_webhook.rb +292 -0
  336. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +246 -0
  337. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +255 -0
  338. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +253 -0
  339. data/lib/plaid/models/cra_check_report_gse_options.rb +228 -0
  340. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +251 -0
  341. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +247 -0
  342. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +251 -0
  343. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +252 -0
  344. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +233 -0
  345. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +221 -0
  346. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +270 -0
  347. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +247 -0
  348. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +263 -0
  349. data/lib/plaid/models/cra_check_report_ready_webhook.rb +331 -0
  350. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +247 -0
  351. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +39 -0
  352. data/lib/plaid/models/cra_check_report_verification_get_request.rb +268 -0
  353. data/lib/plaid/models/cra_check_report_verification_get_response.rb +257 -0
  354. data/lib/plaid/models/cra_employment_refresh_report.rb +258 -0
  355. data/lib/plaid/models/cra_employment_refresh_report_account.rb +315 -0
  356. data/lib/plaid/models/cra_employment_refresh_report_item.rb +288 -0
  357. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +286 -0
  358. data/lib/plaid/models/cra_income_insights.rb +285 -0
  359. data/lib/plaid/models/cra_loan_application.rb +311 -0
  360. data/lib/plaid/models/cra_loan_application_decision.rb +40 -0
  361. data/lib/plaid/models/cra_loan_closed_status.rb +262 -0
  362. data/lib/plaid/models/cra_loan_opened_status.rb +262 -0
  363. data/lib/plaid/models/cra_loan_payment_history.rb +276 -0
  364. data/lib/plaid/models/cra_loan_payment_schedule.rb +44 -0
  365. data/lib/plaid/models/cra_loan_register.rb +339 -0
  366. data/lib/plaid/models/cra_loan_register_application.rb +231 -0
  367. data/lib/plaid/models/cra_loan_status.rb +47 -0
  368. data/lib/plaid/models/cra_loan_status_history_update.rb +262 -0
  369. data/lib/plaid/models/cra_loan_type.rb +46 -0
  370. data/lib/plaid/models/cra_loan_unregister.rb +240 -0
  371. data/lib/plaid/models/cra_loan_unregister_response.rb +226 -0
  372. data/lib/plaid/models/cra_loan_update.rb +245 -0
  373. data/lib/plaid/models/cra_loans_applications_register_request.rb +248 -0
  374. data/lib/plaid/models/cra_loans_applications_register_response.rb +226 -0
  375. data/lib/plaid/models/cra_loans_register_request.rb +248 -0
  376. data/lib/plaid/models/cra_loans_register_response.rb +226 -0
  377. data/lib/plaid/models/cra_loans_unregister_request.rb +248 -0
  378. data/lib/plaid/models/cra_loans_update_request.rb +248 -0
  379. data/lib/plaid/models/cra_loans_update_response.rb +226 -0
  380. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +282 -0
  381. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +258 -0
  382. data/lib/plaid/models/cra_monitoring_insights_item.rb +307 -0
  383. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +274 -0
  384. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +241 -0
  385. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +246 -0
  386. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +226 -0
  387. data/lib/plaid/models/cra_network_insights_item.rb +256 -0
  388. data/lib/plaid/models/cra_network_insights_report.rb +273 -0
  389. data/lib/plaid/models/cra_partner_insights.rb +263 -0
  390. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +292 -0
  391. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +292 -0
  392. data/lib/plaid/models/cra_partner_insights_get_request.rb +246 -0
  393. data/lib/plaid/models/cra_partner_insights_get_response.rb +237 -0
  394. data/lib/plaid/models/cra_partner_insights_item.rb +253 -0
  395. data/lib/plaid/models/cra_partner_insights_item_account.rb +339 -0
  396. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +233 -0
  397. data/lib/plaid/models/cra_partner_insights_prism.rb +276 -0
  398. data/lib/plaid/models/cra_pdf_add_ons.rb +38 -0
  399. data/lib/plaid/models/cra_prediction_interval.rb +244 -0
  400. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +309 -0
  401. data/lib/plaid/models/cra_verification_report.rb +257 -0
  402. data/lib/plaid/models/cra_voa_report.rb +272 -0
  403. data/lib/plaid/models/cra_voa_report_account.rb +396 -0
  404. data/lib/plaid/models/cra_voa_report_account_balances.rb +309 -0
  405. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +263 -0
  406. data/lib/plaid/models/cra_voa_report_attributes.rb +231 -0
  407. data/lib/plaid/models/cra_voa_report_item.rb +288 -0
  408. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +250 -0
  409. data/lib/plaid/models/credit1099.rb +795 -0
  410. data/lib/plaid/models/credit1099_filer.rb +253 -0
  411. data/lib/plaid/models/credit1099_payer.rb +253 -0
  412. data/lib/plaid/models/credit1099_recipient.rb +275 -0
  413. data/lib/plaid/models/credit_account_subtype.rb +40 -0
  414. data/lib/plaid/models/credit_ach_class.rb +40 -0
  415. data/lib/plaid/models/credit_amount_with_currency.rb +248 -0
  416. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +248 -0
  417. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +241 -0
  418. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +246 -0
  419. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +241 -0
  420. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +263 -0
  421. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +241 -0
  422. data/lib/plaid/models/credit_bank_employer.rb +226 -0
  423. data/lib/plaid/models/credit_bank_employment.rb +285 -0
  424. data/lib/plaid/models/credit_bank_employment_get_request.rb +246 -0
  425. data/lib/plaid/models/credit_bank_employment_get_response.rb +243 -0
  426. data/lib/plaid/models/credit_bank_employment_item.rb +305 -0
  427. data/lib/plaid/models/credit_bank_employment_report.rb +290 -0
  428. data/lib/plaid/models/credit_bank_employment_warning.rb +275 -0
  429. data/lib/plaid/models/credit_bank_employment_warning_type.rb +38 -0
  430. data/lib/plaid/models/credit_bank_income.rb +274 -0
  431. data/lib/plaid/models/credit_bank_income_account.rb +330 -0
  432. data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
  433. data/lib/plaid/models/credit_bank_income_category.rb +52 -0
  434. data/lib/plaid/models/credit_bank_income_cause.rb +307 -0
  435. data/lib/plaid/models/credit_bank_income_error_type.rb +53 -0
  436. data/lib/plaid/models/credit_bank_income_get_request.rb +250 -0
  437. data/lib/plaid/models/credit_bank_income_get_request_options.rb +223 -0
  438. data/lib/plaid/models/credit_bank_income_get_response.rb +237 -0
  439. data/lib/plaid/models/credit_bank_income_historical_summary.rb +286 -0
  440. data/lib/plaid/models/credit_bank_income_item.rb +275 -0
  441. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +43 -0
  442. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +246 -0
  443. data/lib/plaid/models/credit_bank_income_refresh_request.rb +255 -0
  444. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +221 -0
  445. data/lib/plaid/models/credit_bank_income_refresh_response.rb +226 -0
  446. data/lib/plaid/models/credit_bank_income_source.rb +332 -0
  447. data/lib/plaid/models/credit_bank_income_summary.rb +316 -0
  448. data/lib/plaid/models/credit_bank_income_transaction.rb +305 -0
  449. data/lib/plaid/models/credit_bank_income_warning.rb +260 -0
  450. data/lib/plaid/models/credit_bank_income_warning_code.rb +42 -0
  451. data/lib/plaid/models/credit_bank_income_warning_type.rb +38 -0
  452. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +261 -0
  453. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +226 -0
  454. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +236 -0
  455. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +266 -0
  456. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +297 -0
  457. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +255 -0
  458. data/lib/plaid/models/credit_bank_statement_upload_item.rb +263 -0
  459. data/lib/plaid/models/credit_bank_statement_upload_object.rb +270 -0
  460. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +255 -0
  461. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +255 -0
  462. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +223 -0
  463. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +243 -0
  464. data/lib/plaid/models/credit_card_liability.rb +316 -0
  465. data/lib/plaid/models/credit_category.rb +241 -0
  466. data/lib/plaid/models/credit_document_metadata.rb +281 -0
  467. data/lib/plaid/models/credit_employer_verification.rb +222 -0
  468. data/lib/plaid/models/credit_employment_get_request.rb +246 -0
  469. data/lib/plaid/models/credit_employment_get_response.rb +243 -0
  470. data/lib/plaid/models/credit_employment_item.rb +252 -0
  471. data/lib/plaid/models/credit_employment_verification.rb +316 -0
  472. data/lib/plaid/models/credit_filter.rb +228 -0
  473. data/lib/plaid/models/credit_freddie_mac_asset.rb +281 -0
  474. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +242 -0
  475. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +227 -0
  476. data/lib/plaid/models/credit_freddie_mac_assets.rb +228 -0
  477. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +256 -0
  478. data/lib/plaid/models/credit_freddie_mac_loan.rb +240 -0
  479. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +227 -0
  480. data/lib/plaid/models/credit_freddie_mac_loans.rb +225 -0
  481. data/lib/plaid/models/credit_freddie_mac_parties.rb +227 -0
  482. data/lib/plaid/models/credit_freddie_mac_party.rb +253 -0
  483. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +225 -0
  484. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +256 -0
  485. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +246 -0
  486. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +255 -0
  487. data/lib/plaid/models/credit_freddie_mac_service.rb +241 -0
  488. data/lib/plaid/models/credit_freddie_mac_services.rb +225 -0
  489. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +253 -0
  490. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +225 -0
  491. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +253 -0
  492. data/lib/plaid/models/credit_pay_stub.rb +320 -0
  493. data/lib/plaid/models/credit_pay_stub_address.rb +266 -0
  494. data/lib/plaid/models/credit_pay_stub_deductions.rb +241 -0
  495. data/lib/plaid/models/credit_pay_stub_earnings.rb +241 -0
  496. data/lib/plaid/models/credit_pay_stub_employee.rb +261 -0
  497. data/lib/plaid/models/credit_pay_stub_employer.rb +236 -0
  498. data/lib/plaid/models/credit_pay_stub_net_pay.rb +266 -0
  499. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +40 -0
  500. data/lib/plaid/models/credit_payroll_income_get_request.rb +250 -0
  501. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +223 -0
  502. data/lib/plaid/models/credit_payroll_income_get_response.rb +253 -0
  503. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +273 -0
  504. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +226 -0
  505. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +283 -0
  506. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +262 -0
  507. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +255 -0
  508. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +233 -0
  509. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +241 -0
  510. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +241 -0
  511. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +253 -0
  512. data/lib/plaid/models/credit_platform_ids.rb +244 -0
  513. data/lib/plaid/models/credit_relay_create_request.rb +274 -0
  514. data/lib/plaid/models/credit_relay_create_response.rb +241 -0
  515. data/lib/plaid/models/credit_relay_get_request.rb +294 -0
  516. data/lib/plaid/models/credit_relay_pdf_get_request.rb +282 -0
  517. data/lib/plaid/models/credit_relay_refresh_request.rb +293 -0
  518. data/lib/plaid/models/credit_relay_refresh_response.rb +250 -0
  519. data/lib/plaid/models/credit_relay_remove_request.rb +246 -0
  520. data/lib/plaid/models/credit_relay_remove_response.rb +241 -0
  521. data/lib/plaid/models/credit_session.rb +252 -0
  522. data/lib/plaid/models/credit_session_bank_employment_result.rb +262 -0
  523. data/lib/plaid/models/credit_session_bank_employment_status.rb +40 -0
  524. data/lib/plaid/models/credit_session_bank_income_result.rb +262 -0
  525. data/lib/plaid/models/credit_session_bank_income_status.rb +40 -0
  526. data/lib/plaid/models/credit_session_document_income_result.rb +271 -0
  527. data/lib/plaid/models/credit_session_error.rb +252 -0
  528. data/lib/plaid/models/credit_session_item_add_result.rb +241 -0
  529. data/lib/plaid/models/credit_session_payroll_income_result.rb +251 -0
  530. data/lib/plaid/models/credit_session_results.rb +269 -0
  531. data/lib/plaid/models/credit_sessions_get_request.rb +246 -0
  532. data/lib/plaid/models/credit_sessions_get_response.rb +238 -0
  533. data/lib/plaid/models/credit_w2.rb +487 -0
  534. data/lib/plaid/models/custom_sandbox_transaction.rb +281 -0
  535. data/lib/plaid/models/customer_initiated_return_risk.rb +301 -0
  536. data/lib/plaid/models/dashboard_user.rb +292 -0
  537. data/lib/plaid/models/dashboard_user_get_request.rb +246 -0
  538. data/lib/plaid/models/dashboard_user_get_response.rb +307 -0
  539. data/lib/plaid/models/dashboard_user_list_request.rb +242 -0
  540. data/lib/plaid/models/dashboard_user_list_response.rb +254 -0
  541. data/lib/plaid/models/dashboard_user_status.rb +40 -0
  542. data/lib/plaid/models/data_sources.rb +40 -0
  543. data/lib/plaid/models/date_range.rb +241 -0
  544. data/lib/plaid/models/deductions.rb +263 -0
  545. data/lib/plaid/models/deductions_breakdown.rb +266 -0
  546. data/lib/plaid/models/deductions_total.rb +255 -0
  547. data/lib/plaid/models/default_update_webhook.rb +317 -0
  548. data/lib/plaid/models/depository_account_subtype.rb +47 -0
  549. data/lib/plaid/models/depository_filter.rb +228 -0
  550. data/lib/plaid/models/detailed_originator.rb +289 -0
  551. data/lib/plaid/models/detected_account.rb +308 -0
  552. data/lib/plaid/models/device_id.rb +230 -0
  553. data/lib/plaid/models/distribution_breakdown.rb +297 -0
  554. data/lib/plaid/models/doc_type.rb +49 -0
  555. data/lib/plaid/models/document_analysis.rb +301 -0
  556. data/lib/plaid/models/document_authenticity_match_code.rb +41 -0
  557. data/lib/plaid/models/document_date_of_birth_match_code.rb +41 -0
  558. data/lib/plaid/models/document_metadata.rb +273 -0
  559. data/lib/plaid/models/document_name_match_code.rb +41 -0
  560. data/lib/plaid/models/document_risk_signal.rb +298 -0
  561. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +226 -0
  562. data/lib/plaid/models/document_risk_signals_object.rb +256 -0
  563. data/lib/plaid/models/document_risk_summary.rb +222 -0
  564. data/lib/plaid/models/document_status.rb +40 -0
  565. data/lib/plaid/models/documentary_verification.rb +243 -0
  566. data/lib/plaid/models/documentary_verification_document.rb +311 -0
  567. data/lib/plaid/models/earnings.rb +253 -0
  568. data/lib/plaid/models/earnings_breakdown.rb +320 -0
  569. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +47 -0
  570. data/lib/plaid/models/earnings_total.rb +284 -0
  571. data/lib/plaid/models/email.rb +290 -0
  572. data/lib/plaid/models/email_address_match_score.rb +222 -0
  573. data/lib/plaid/models/employee.rb +256 -0
  574. data/lib/plaid/models/employee_income_summary_field_string.rb +269 -0
  575. data/lib/plaid/models/employer.rb +266 -0
  576. data/lib/plaid/models/employer_income_summary_field_string.rb +269 -0
  577. data/lib/plaid/models/employer_verification.rb +222 -0
  578. data/lib/plaid/models/employers_search_request.rb +263 -0
  579. data/lib/plaid/models/employers_search_response.rb +243 -0
  580. data/lib/plaid/models/employment_details.rb +231 -0
  581. data/lib/plaid/models/employment_source_type.rb +39 -0
  582. data/lib/plaid/models/employment_verification.rb +294 -0
  583. data/lib/plaid/models/employment_verification_get_request.rb +246 -0
  584. data/lib/plaid/models/employment_verification_get_response.rb +243 -0
  585. data/lib/plaid/models/employment_verification_status.rb +40 -0
  586. data/lib/plaid/models/enhancements.rb +365 -0
  587. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  588. data/lib/plaid/models/enrichments.rb +403 -0
  589. data/lib/plaid/models/entity_document.rb +262 -0
  590. data/lib/plaid/models/entity_document_type.rb +43 -0
  591. data/lib/plaid/models/entity_screening_hit_analysis.rb +302 -0
  592. data/lib/plaid/models/entity_screening_hit_data.rb +283 -0
  593. data/lib/plaid/models/entity_screening_hit_documents_items.rb +229 -0
  594. data/lib/plaid/models/entity_screening_hit_emails.rb +226 -0
  595. data/lib/plaid/models/entity_screening_hit_emails_items.rb +229 -0
  596. data/lib/plaid/models/entity_screening_hit_names.rb +277 -0
  597. data/lib/plaid/models/entity_screening_hit_names_items.rb +229 -0
  598. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +262 -0
  599. data/lib/plaid/models/entity_screening_hit_urls.rb +226 -0
  600. data/lib/plaid/models/entity_screening_hit_urls_items.rb +229 -0
  601. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +229 -0
  602. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +292 -0
  603. data/lib/plaid/models/entity_watchlist_code.rb +53 -0
  604. data/lib/plaid/models/entity_watchlist_program.rb +365 -0
  605. data/lib/plaid/models/entity_watchlist_screening.rb +312 -0
  606. data/lib/plaid/models/entity_watchlist_screening_hit.rb +357 -0
  607. data/lib/plaid/models/entity_watchlist_screening_review.rb +285 -0
  608. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +311 -0
  609. data/lib/plaid/models/entity_watchlist_search_terms.rb +296 -0
  610. data/lib/plaid/models/expiration_date.rb +40 -0
  611. data/lib/plaid/models/extended_recipient_metadata.rb +383 -0
  612. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +255 -0
  613. data/lib/plaid/models/external_payment_initiation_consent_options.rb +269 -0
  614. data/lib/plaid/models/external_payment_options.rb +301 -0
  615. data/lib/plaid/models/external_payment_refund_details.rb +247 -0
  616. data/lib/plaid/models/external_payment_schedule_base.rb +284 -0
  617. data/lib/plaid/models/external_payment_schedule_get.rb +306 -0
  618. data/lib/plaid/models/external_payment_schedule_request.rb +306 -0
  619. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +318 -0
  620. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +318 -0
  621. data/lib/plaid/models/fdx_content_types.rb +43 -0
  622. data/lib/plaid/models/fdx_hateoas_link.rb +279 -0
  623. data/lib/plaid/models/fdx_hateoas_link_action.rb +42 -0
  624. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +251 -0
  625. data/lib/plaid/models/fdx_notification.rb +350 -0
  626. data/lib/plaid/models/fdx_notification_category.rb +42 -0
  627. data/lib/plaid/models/fdx_notification_payload.rb +263 -0
  628. data/lib/plaid/models/fdx_notification_payload_id_type.rb +42 -0
  629. data/lib/plaid/models/fdx_notification_priority.rb +40 -0
  630. data/lib/plaid/models/fdx_notification_severity.rb +42 -0
  631. data/lib/plaid/models/fdx_notification_type.rb +43 -0
  632. data/lib/plaid/models/fdx_party.rb +311 -0
  633. data/lib/plaid/models/fdx_party_registry.rb +41 -0
  634. data/lib/plaid/models/fdx_party_type.rb +43 -0
  635. data/lib/plaid/models/fdx_recipient_metadata.rb +330 -0
  636. data/lib/plaid/models/fdxfi_attribute.rb +241 -0
  637. data/lib/plaid/models/financial_institution_insights.rb +265 -0
  638. data/lib/plaid/models/fixed_income.rb +254 -0
  639. data/lib/plaid/models/forecasted_monthly_income.rb +241 -0
  640. data/lib/plaid/models/form1099_type.rb +40 -0
  641. data/lib/plaid/models/forwarded_json_response.rb +226 -0
  642. data/lib/plaid/models/fraud_amount.rb +262 -0
  643. data/lib/plaid/models/fraud_analysis_details.rb +331 -0
  644. data/lib/plaid/models/fraud_check_outcome.rb +39 -0
  645. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +40 -0
  646. data/lib/plaid/models/generic_screening_hit_location_items.rb +229 -0
  647. data/lib/plaid/models/get_recipient_response.rb +337 -0
  648. data/lib/plaid/models/get_recipients_response.rb +227 -0
  649. data/lib/plaid/models/gse_report_type.rb +39 -0
  650. data/lib/plaid/models/health_incident.rb +269 -0
  651. data/lib/plaid/models/hidden_match_summary_code.rb +42 -0
  652. data/lib/plaid/models/historical_annual_income.rb +241 -0
  653. data/lib/plaid/models/historical_balance.rb +263 -0
  654. data/lib/plaid/models/historical_update_webhook.rb +317 -0
  655. data/lib/plaid/models/holding.rb +363 -0
  656. data/lib/plaid/models/holdings_default_update_webhook.rb +332 -0
  657. data/lib/plaid/models/holdings_override.rb +290 -0
  658. data/lib/plaid/models/hosted_link_delivery_method.rb +39 -0
  659. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +317 -0
  660. data/lib/plaid/models/human_review.rb +247 -0
  661. data/lib/plaid/models/human_review_status.rb +40 -0
  662. data/lib/plaid/models/id_number_type.rb +72 -0
  663. data/lib/plaid/models/identity_default_update_webhook.rb +319 -0
  664. data/lib/plaid/models/identity_document_metadata.rb +239 -0
  665. data/lib/plaid/models/identity_document_upload.rb +239 -0
  666. data/lib/plaid/models/identity_document_upload_metadata.rb +264 -0
  667. data/lib/plaid/models/identity_document_upload_risk_insights.rb +232 -0
  668. data/lib/plaid/models/identity_document_upload_risk_signal.rb +255 -0
  669. data/lib/plaid/models/identity_document_upload_risk_summary.rb +222 -0
  670. data/lib/plaid/models/identity_documents_uploads_get_request.rb +255 -0
  671. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +223 -0
  672. data/lib/plaid/models/identity_documents_uploads_get_response.rb +257 -0
  673. data/lib/plaid/models/identity_get_request.rb +255 -0
  674. data/lib/plaid/models/identity_get_request_options.rb +223 -0
  675. data/lib/plaid/models/identity_get_response.rb +257 -0
  676. data/lib/plaid/models/identity_match_request.rb +264 -0
  677. data/lib/plaid/models/identity_match_request_options.rb +223 -0
  678. data/lib/plaid/models/identity_match_response.rb +257 -0
  679. data/lib/plaid/models/identity_match_user.rb +254 -0
  680. data/lib/plaid/models/identity_refresh_request.rb +246 -0
  681. data/lib/plaid/models/identity_refresh_response.rb +226 -0
  682. data/lib/plaid/models/identity_update_types.rb +41 -0
  683. data/lib/plaid/models/identity_verification.rb +461 -0
  684. data/lib/plaid/models/identity_verification_autofill_address.rb +335 -0
  685. data/lib/plaid/models/identity_verification_autofill_create_request.rb +246 -0
  686. data/lib/plaid/models/identity_verification_autofill_create_response.rb +272 -0
  687. data/lib/plaid/models/identity_verification_autofill_status.rb +39 -0
  688. data/lib/plaid/models/identity_verification_autofill_user_data.rb +241 -0
  689. data/lib/plaid/models/identity_verification_create_request.rb +319 -0
  690. data/lib/plaid/models/identity_verification_create_request_user.rb +283 -0
  691. data/lib/plaid/models/identity_verification_create_response.rb +476 -0
  692. data/lib/plaid/models/identity_verification_document_address_response.rb +278 -0
  693. data/lib/plaid/models/identity_verification_document_name_response.rb +241 -0
  694. data/lib/plaid/models/identity_verification_get_request.rb +246 -0
  695. data/lib/plaid/models/identity_verification_get_response.rb +476 -0
  696. data/lib/plaid/models/identity_verification_list_request.rb +282 -0
  697. data/lib/plaid/models/identity_verification_list_response.rb +254 -0
  698. data/lib/plaid/models/identity_verification_request_user.rb +272 -0
  699. data/lib/plaid/models/identity_verification_request_user_name.rb +241 -0
  700. data/lib/plaid/models/identity_verification_response_user_name.rb +241 -0
  701. data/lib/plaid/models/identity_verification_retried_webhook.rb +292 -0
  702. data/lib/plaid/models/identity_verification_retry_request.rb +328 -0
  703. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +271 -0
  704. data/lib/plaid/models/identity_verification_retry_response.rb +476 -0
  705. data/lib/plaid/models/identity_verification_status.rb +43 -0
  706. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +292 -0
  707. data/lib/plaid/models/identity_verification_step_status.rb +48 -0
  708. data/lib/plaid/models/identity_verification_step_summary.rb +331 -0
  709. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +292 -0
  710. data/lib/plaid/models/identity_verification_template_reference.rb +241 -0
  711. data/lib/plaid/models/identity_verification_user_address.rb +281 -0
  712. data/lib/plaid/models/identity_verification_user_data.rb +285 -0
  713. data/lib/plaid/models/image_quality.rb +40 -0
  714. data/lib/plaid/models/image_quality_details.rb +275 -0
  715. data/lib/plaid/models/image_quality_outcome.rb +39 -0
  716. data/lib/plaid/models/incident_update.rb +275 -0
  717. data/lib/plaid/models/income_breakdown.rb +276 -0
  718. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  719. data/lib/plaid/models/income_override.rb +235 -0
  720. data/lib/plaid/models/income_sources_counts.rb +241 -0
  721. data/lib/plaid/models/income_summary.rb +301 -0
  722. data/lib/plaid/models/income_summary_field_number.rb +262 -0
  723. data/lib/plaid/models/income_summary_field_string.rb +262 -0
  724. data/lib/plaid/models/income_verification_create_request.rb +265 -0
  725. data/lib/plaid/models/income_verification_create_request_options.rb +223 -0
  726. data/lib/plaid/models/income_verification_create_response.rb +241 -0
  727. data/lib/plaid/models/income_verification_doc_parsing_config.rb +39 -0
  728. data/lib/plaid/models/income_verification_documents_download_request.rb +264 -0
  729. data/lib/plaid/models/income_verification_payroll_flow_type.rb +39 -0
  730. data/lib/plaid/models/income_verification_paystubs_get_request.rb +253 -0
  731. data/lib/plaid/models/income_verification_paystubs_get_response.rb +264 -0
  732. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  733. data/lib/plaid/models/income_verification_precheck_employer.rb +254 -0
  734. data/lib/plaid/models/income_verification_precheck_employer_address.rb +268 -0
  735. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +261 -0
  736. data/lib/plaid/models/income_verification_precheck_military_info.rb +233 -0
  737. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +222 -0
  738. data/lib/plaid/models/income_verification_precheck_request.rb +292 -0
  739. data/lib/plaid/models/income_verification_precheck_response.rb +277 -0
  740. data/lib/plaid/models/income_verification_precheck_user.rb +254 -0
  741. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +292 -0
  742. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +312 -0
  743. data/lib/plaid/models/income_verification_source_type.rb +39 -0
  744. data/lib/plaid/models/income_verification_status_webhook.rb +317 -0
  745. data/lib/plaid/models/income_verification_taxforms_get_request.rb +253 -0
  746. data/lib/plaid/models/income_verification_taxforms_get_response.rb +264 -0
  747. data/lib/plaid/models/income_verification_webhook_status.rb +225 -0
  748. data/lib/plaid/models/individual_name.rb +241 -0
  749. data/lib/plaid/models/individual_screening_hit_names.rb +277 -0
  750. data/lib/plaid/models/individual_watchlist_code.rb +62 -0
  751. data/lib/plaid/models/individual_watchlist_program.rb +365 -0
  752. data/lib/plaid/models/inflow_model.rb +286 -0
  753. data/lib/plaid/models/initial_update_webhook.rb +318 -0
  754. data/lib/plaid/models/institution.rb +382 -0
  755. data/lib/plaid/models/institution_status.rb +304 -0
  756. data/lib/plaid/models/institution_status_alert_webhook.rb +307 -0
  757. data/lib/plaid/models/institution_supported_networks.rb +239 -0
  758. data/lib/plaid/models/institutions_get_by_id_request.rb +293 -0
  759. data/lib/plaid/models/institutions_get_by_id_request_options.rb +259 -0
  760. data/lib/plaid/models/institutions_get_by_id_response.rb +240 -0
  761. data/lib/plaid/models/institutions_get_request.rb +359 -0
  762. data/lib/plaid/models/institutions_get_request_options.rb +299 -0
  763. data/lib/plaid/models/institutions_get_response.rb +258 -0
  764. data/lib/plaid/models/institutions_search_account_filter.rb +255 -0
  765. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +233 -0
  766. data/lib/plaid/models/institutions_search_request.rb +323 -0
  767. data/lib/plaid/models/institutions_search_request_options.rb +268 -0
  768. data/lib/plaid/models/institutions_search_response.rb +243 -0
  769. data/lib/plaid/models/investment_account_subtype.rb +87 -0
  770. data/lib/plaid/models/investment_filter.rb +228 -0
  771. data/lib/plaid/models/investment_holdings_get_request_options.rb +223 -0
  772. data/lib/plaid/models/investment_transaction.rb +421 -0
  773. data/lib/plaid/models/investment_transaction_subtype.rb +85 -0
  774. data/lib/plaid/models/investment_transaction_type.rb +43 -0
  775. data/lib/plaid/models/investments_auth401k_contribution_details.rb +318 -0
  776. data/lib/plaid/models/investments_auth401k_fee_details.rb +241 -0
  777. data/lib/plaid/models/investments_auth_account_details401k.rb +239 -0
  778. data/lib/plaid/models/investments_auth_data_sources.rb +260 -0
  779. data/lib/plaid/models/investments_auth_get_numbers.rb +244 -0
  780. data/lib/plaid/models/investments_auth_get_request.rb +255 -0
  781. data/lib/plaid/models/investments_auth_get_request_options.rb +223 -0
  782. data/lib/plaid/models/investments_auth_get_response.rb +348 -0
  783. data/lib/plaid/models/investments_auth_owner.rb +233 -0
  784. data/lib/plaid/models/investments_default_update_webhook.rb +332 -0
  785. data/lib/plaid/models/investments_historical_update_webhook.rb +332 -0
  786. data/lib/plaid/models/investments_holdings_get_request.rb +255 -0
  787. data/lib/plaid/models/investments_holdings_get_response.rb +301 -0
  788. data/lib/plaid/models/investments_refresh_request.rb +246 -0
  789. data/lib/plaid/models/investments_refresh_response.rb +226 -0
  790. data/lib/plaid/models/investments_transactions_get_request.rb +285 -0
  791. data/lib/plaid/models/investments_transactions_get_request_options.rb +302 -0
  792. data/lib/plaid/models/investments_transactions_get_response.rb +316 -0
  793. data/lib/plaid/models/investments_transactions_override.rb +320 -0
  794. data/lib/plaid/models/iso_currency_code.rb +38 -0
  795. data/lib/plaid/models/issue.rb +306 -0
  796. data/lib/plaid/models/issue_resolved_webhook.rb +316 -0
  797. data/lib/plaid/models/issues_get_request.rb +246 -0
  798. data/lib/plaid/models/issues_get_response.rb +230 -0
  799. data/lib/plaid/models/issues_search_request.rb +261 -0
  800. data/lib/plaid/models/issues_search_response.rb +233 -0
  801. data/lib/plaid/models/issues_status.rb +43 -0
  802. data/lib/plaid/models/issues_subscribe_request.rb +261 -0
  803. data/lib/plaid/models/issues_subscribe_response.rb +226 -0
  804. data/lib/plaid/models/issuing_country.rb +39 -0
  805. data/lib/plaid/models/item.rb +397 -0
  806. data/lib/plaid/models/item_access_token_invalidate_request.rb +246 -0
  807. data/lib/plaid/models/item_access_token_invalidate_response.rb +241 -0
  808. data/lib/plaid/models/item_activity_list_request.rb +288 -0
  809. data/lib/plaid/models/item_activity_list_response.rb +270 -0
  810. data/lib/plaid/models/item_add_result_webhook.rb +322 -0
  811. data/lib/plaid/models/item_application_list_request.rb +242 -0
  812. data/lib/plaid/models/item_application_list_response.rb +238 -0
  813. data/lib/plaid/models/item_application_list_user_auth.rb +233 -0
  814. data/lib/plaid/models/item_application_scopes_update_request.rb +321 -0
  815. data/lib/plaid/models/item_application_scopes_update_response.rb +226 -0
  816. data/lib/plaid/models/item_application_unlink_request.rb +261 -0
  817. data/lib/plaid/models/item_application_unlink_response.rb +226 -0
  818. data/lib/plaid/models/item_auth_method.rb +46 -0
  819. data/lib/plaid/models/item_consented_data_scope.rb +45 -0
  820. data/lib/plaid/models/item_create_authentication.rb +40 -0
  821. data/lib/plaid/models/item_error_webhook.rb +302 -0
  822. data/lib/plaid/models/item_get_request.rb +246 -0
  823. data/lib/plaid/models/item_get_response.rb +250 -0
  824. data/lib/plaid/models/item_import_request.rb +302 -0
  825. data/lib/plaid/models/item_import_request_options.rb +221 -0
  826. data/lib/plaid/models/item_import_request_user_auth.rb +241 -0
  827. data/lib/plaid/models/item_import_response.rb +241 -0
  828. data/lib/plaid/models/item_login_repaired_webhook.rb +292 -0
  829. data/lib/plaid/models/item_product_ready_webhook.rb +302 -0
  830. data/lib/plaid/models/item_public_token_create_request.rb +246 -0
  831. data/lib/plaid/models/item_public_token_create_response.rb +250 -0
  832. data/lib/plaid/models/item_public_token_exchange_request.rb +246 -0
  833. data/lib/plaid/models/item_public_token_exchange_response.rb +256 -0
  834. data/lib/plaid/models/item_remove_request.rb +246 -0
  835. data/lib/plaid/models/item_remove_response.rb +226 -0
  836. data/lib/plaid/models/item_status.rb +241 -0
  837. data/lib/plaid/models/item_status_investments.rb +233 -0
  838. data/lib/plaid/models/item_status_last_webhook.rb +233 -0
  839. data/lib/plaid/models/item_status_nullable.rb +248 -0
  840. data/lib/plaid/models/item_status_transactions.rb +233 -0
  841. data/lib/plaid/models/item_webhook_update_request.rb +257 -0
  842. data/lib/plaid/models/item_webhook_update_response.rb +240 -0
  843. data/lib/plaid/models/item_with_consent_fields.rb +439 -0
  844. data/lib/plaid/models/item_with_consent_fields_all_of.rb +244 -0
  845. data/lib/plaid/models/jwk_public_key.rb +342 -0
  846. data/lib/plaid/models/jwt_header.rb +253 -0
  847. data/lib/plaid/models/kyc_check_address_summary.rb +321 -0
  848. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +274 -0
  849. data/lib/plaid/models/kyc_check_details.rb +296 -0
  850. data/lib/plaid/models/kyc_check_details_international_address.rb +317 -0
  851. data/lib/plaid/models/kyc_check_id_number_summary.rb +247 -0
  852. data/lib/plaid/models/kyc_check_name_summary.rb +265 -0
  853. data/lib/plaid/models/kyc_check_phone_summary.rb +261 -0
  854. data/lib/plaid/models/last_data_access_times.rb +314 -0
  855. data/lib/plaid/models/latest_scored_event.rb +274 -0
  856. data/lib/plaid/models/layer_authentication_passed_webhook.rb +307 -0
  857. data/lib/plaid/models/liabilities_default_update_webhook.rb +336 -0
  858. data/lib/plaid/models/liabilities_get_request.rb +255 -0
  859. data/lib/plaid/models/liabilities_get_request_options.rb +223 -0
  860. data/lib/plaid/models/liabilities_get_response.rb +271 -0
  861. data/lib/plaid/models/liabilities_object.rb +250 -0
  862. data/lib/plaid/models/liability_override.rb +567 -0
  863. data/lib/plaid/models/link_callback_metadata.rb +302 -0
  864. data/lib/plaid/models/link_delivery_account.rb +302 -0
  865. data/lib/plaid/models/link_delivery_callback_webhook.rb +295 -0
  866. data/lib/plaid/models/link_delivery_communication_method.rb +252 -0
  867. data/lib/plaid/models/link_delivery_create_request.rb +255 -0
  868. data/lib/plaid/models/link_delivery_create_response.rb +256 -0
  869. data/lib/plaid/models/link_delivery_delivery_method.rb +39 -0
  870. data/lib/plaid/models/link_delivery_get_request.rb +246 -0
  871. data/lib/plaid/models/link_delivery_get_response.rb +314 -0
  872. data/lib/plaid/models/link_delivery_institution.rb +231 -0
  873. data/lib/plaid/models/link_delivery_metadata.rb +251 -0
  874. data/lib/plaid/models/link_delivery_options.rb +220 -0
  875. data/lib/plaid/models/link_delivery_recipient.rb +233 -0
  876. data/lib/plaid/models/link_delivery_session_status.rb +42 -0
  877. data/lib/plaid/models/link_delivery_verification_status.rb +46 -0
  878. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +40 -0
  879. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +39 -0
  880. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +39 -0
  881. data/lib/plaid/models/link_event.rb +270 -0
  882. data/lib/plaid/models/link_event_metadata.rb +361 -0
  883. data/lib/plaid/models/link_event_name.rb +63 -0
  884. data/lib/plaid/models/link_events_webhook.rb +288 -0
  885. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +246 -0
  886. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +241 -0
  887. data/lib/plaid/models/link_session_bank_employment_result.rb +272 -0
  888. data/lib/plaid/models/link_session_bank_income_result.rb +272 -0
  889. data/lib/plaid/models/link_session_cra_document_upload_result.rb +226 -0
  890. data/lib/plaid/models/link_session_cra_item_add_result.rb +253 -0
  891. data/lib/plaid/models/link_session_exit.rb +231 -0
  892. data/lib/plaid/models/link_session_exit_deprecated.rb +231 -0
  893. data/lib/plaid/models/link_session_exit_metadata.rb +251 -0
  894. data/lib/plaid/models/link_session_exit_metadata_institution.rb +231 -0
  895. data/lib/plaid/models/link_session_finished_webhook.rb +344 -0
  896. data/lib/plaid/models/link_session_item_add_result.rb +253 -0
  897. data/lib/plaid/models/link_session_payroll_income_result.rb +251 -0
  898. data/lib/plaid/models/link_session_protect_result.rb +249 -0
  899. data/lib/plaid/models/link_session_results.rb +309 -0
  900. data/lib/plaid/models/link_session_success.rb +236 -0
  901. data/lib/plaid/models/link_session_success_metadata.rb +275 -0
  902. data/lib/plaid/models/link_session_success_metadata_account.rb +284 -0
  903. data/lib/plaid/models/link_session_success_metadata_institution.rb +231 -0
  904. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +40 -0
  905. data/lib/plaid/models/link_token_account_filters.rb +256 -0
  906. data/lib/plaid/models/link_token_cashflow_report.rb +249 -0
  907. data/lib/plaid/models/link_token_create_card_switch.rb +226 -0
  908. data/lib/plaid/models/link_token_create_credit_filter.rb +223 -0
  909. data/lib/plaid/models/link_token_create_depository_filter.rb +223 -0
  910. data/lib/plaid/models/link_token_create_hosted_link.rb +274 -0
  911. data/lib/plaid/models/link_token_create_identity.rb +245 -0
  912. data/lib/plaid/models/link_token_create_institution_data.rb +221 -0
  913. data/lib/plaid/models/link_token_create_investment_filter.rb +223 -0
  914. data/lib/plaid/models/link_token_create_loan_filter.rb +223 -0
  915. data/lib/plaid/models/link_token_create_request.rb +790 -0
  916. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +247 -0
  917. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +41 -0
  918. data/lib/plaid/models/link_token_create_request_auth.rb +357 -0
  919. data/lib/plaid/models/link_token_create_request_base_report.rb +267 -0
  920. data/lib/plaid/models/link_token_create_request_cra_options.rb +312 -0
  921. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +243 -0
  922. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +228 -0
  923. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +253 -0
  924. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +233 -0
  925. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +259 -0
  926. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +226 -0
  927. data/lib/plaid/models/link_token_create_request_employment.rb +232 -0
  928. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +226 -0
  929. data/lib/plaid/models/link_token_create_request_identity_verification.rb +246 -0
  930. data/lib/plaid/models/link_token_create_request_income_verification.rb +286 -0
  931. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +269 -0
  932. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +260 -0
  933. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +236 -0
  934. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +231 -0
  935. data/lib/plaid/models/link_token_create_request_statements.rb +241 -0
  936. data/lib/plaid/models/link_token_create_request_transfer.rb +241 -0
  937. data/lib/plaid/models/link_token_create_request_update.rb +258 -0
  938. data/lib/plaid/models/link_token_create_request_user.rb +347 -0
  939. data/lib/plaid/models/link_token_create_request_user_address.rb +287 -0
  940. data/lib/plaid/models/link_token_create_request_user_id_number.rb +268 -0
  941. data/lib/plaid/models/link_token_create_request_user_name.rb +247 -0
  942. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +290 -0
  943. data/lib/plaid/models/link_token_create_response.rb +276 -0
  944. data/lib/plaid/models/link_token_eu_config.rb +221 -0
  945. data/lib/plaid/models/link_token_get_metadata_response.rb +307 -0
  946. data/lib/plaid/models/link_token_get_request.rb +246 -0
  947. data/lib/plaid/models/link_token_get_response.rb +289 -0
  948. data/lib/plaid/models/link_token_get_sessions_response.rb +299 -0
  949. data/lib/plaid/models/link_token_investments.rb +231 -0
  950. data/lib/plaid/models/link_token_investments_auth.rb +263 -0
  951. data/lib/plaid/models/link_token_transactions.rb +249 -0
  952. data/lib/plaid/models/link_user_delivery_status_webhook.rb +285 -0
  953. data/lib/plaid/models/loan.rb +225 -0
  954. data/lib/plaid/models/loan_account_subtype.rb +49 -0
  955. data/lib/plaid/models/loan_filter.rb +228 -0
  956. data/lib/plaid/models/loan_identifier.rb +254 -0
  957. data/lib/plaid/models/loan_identifier_type.rb +39 -0
  958. data/lib/plaid/models/loan_identifiers.rb +225 -0
  959. data/lib/plaid/models/loan_payments_counts.rb +241 -0
  960. data/lib/plaid/models/loan_payments_merchant_counts.rb +241 -0
  961. data/lib/plaid/models/loans.rb +225 -0
  962. data/lib/plaid/models/location.rb +299 -0
  963. data/lib/plaid/models/match_summary.rb +247 -0
  964. data/lib/plaid/models/match_summary_code.rb +42 -0
  965. data/lib/plaid/models/merchant_insights.rb +315 -0
  966. data/lib/plaid/models/meta.rb +294 -0
  967. data/lib/plaid/models/mfa.rb +286 -0
  968. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +39 -0
  969. data/lib/plaid/models/monitoring_income_insights.rb +284 -0
  970. data/lib/plaid/models/monitoring_income_source.rb +292 -0
  971. data/lib/plaid/models/monitoring_insights.rb +239 -0
  972. data/lib/plaid/models/monitoring_insights_item_status.rb +258 -0
  973. data/lib/plaid/models/monitoring_insights_status.rb +39 -0
  974. data/lib/plaid/models/monitoring_item_status_code.rb +40 -0
  975. data/lib/plaid/models/monitoring_loan_insights.rb +254 -0
  976. data/lib/plaid/models/mortgage_interest_rate.rb +233 -0
  977. data/lib/plaid/models/mortgage_liability.rb +441 -0
  978. data/lib/plaid/models/mortgage_property_address.rb +266 -0
  979. data/lib/plaid/models/multi_document_risk_signal.rb +245 -0
  980. data/lib/plaid/models/name_match_score.rb +255 -0
  981. data/lib/plaid/models/net_pay.rb +275 -0
  982. data/lib/plaid/models/network_insights_item.rb +256 -0
  983. data/lib/plaid/models/network_insights_report.rb +273 -0
  984. data/lib/plaid/models/network_insights_report_get_request.rb +248 -0
  985. data/lib/plaid/models/network_insights_report_get_response.rb +240 -0
  986. data/lib/plaid/models/network_status_get_request.rb +255 -0
  987. data/lib/plaid/models/network_status_get_response.rb +272 -0
  988. data/lib/plaid/models/network_status_get_response_layer.rb +226 -0
  989. data/lib/plaid/models/network_status_get_response_network_status.rb +39 -0
  990. data/lib/plaid/models/network_status_get_user.rb +226 -0
  991. data/lib/plaid/models/new_accounts_available_webhook.rb +282 -0
  992. data/lib/plaid/models/numbers.rb +291 -0
  993. data/lib/plaid/models/numbers_acats.rb +258 -0
  994. data/lib/plaid/models/numbers_ach.rb +299 -0
  995. data/lib/plaid/models/numbers_ach_nullable.rb +306 -0
  996. data/lib/plaid/models/numbers_aton.rb +241 -0
  997. data/lib/plaid/models/numbers_bacs.rb +256 -0
  998. data/lib/plaid/models/numbers_bacs_nullable.rb +263 -0
  999. data/lib/plaid/models/numbers_eft.rb +271 -0
  1000. data/lib/plaid/models/numbers_eft_nullable.rb +278 -0
  1001. data/lib/plaid/models/numbers_iban_nullable.rb +211 -0
  1002. data/lib/plaid/models/numbers_international.rb +256 -0
  1003. data/lib/plaid/models/numbers_international_iban.rb +301 -0
  1004. data/lib/plaid/models/numbers_international_nullable.rb +263 -0
  1005. data/lib/plaid/models/numbers_retirement401k.rb +246 -0
  1006. data/lib/plaid/models/o_auth_error_code.rb +43 -0
  1007. data/lib/plaid/models/o_auth_error_response.rb +277 -0
  1008. data/lib/plaid/models/o_auth_grant_type.rb +40 -0
  1009. data/lib/plaid/models/o_auth_introspect_request.rb +256 -0
  1010. data/lib/plaid/models/o_auth_introspect_response.rb +331 -0
  1011. data/lib/plaid/models/o_auth_revoke_request.rb +256 -0
  1012. data/lib/plaid/models/o_auth_revoke_response.rb +226 -0
  1013. data/lib/plaid/models/o_auth_subject_token_type.rb +39 -0
  1014. data/lib/plaid/models/o_auth_token_request.rb +336 -0
  1015. data/lib/plaid/models/o_auth_token_response.rb +286 -0
  1016. data/lib/plaid/models/omittable_transfer_type.rb +39 -0
  1017. data/lib/plaid/models/option_contract.rb +271 -0
  1018. data/lib/plaid/models/originating_fund_source.rb +296 -0
  1019. data/lib/plaid/models/originator.rb +262 -0
  1020. data/lib/plaid/models/originator_expected_transfer_frequency.rb +41 -0
  1021. data/lib/plaid/models/other_account_subtype.rb +39 -0
  1022. data/lib/plaid/models/other_filter.rb +228 -0
  1023. data/lib/plaid/models/override_account_type.rb +43 -0
  1024. data/lib/plaid/models/override_accounts.rb +416 -0
  1025. data/lib/plaid/models/owner.rb +279 -0
  1026. data/lib/plaid/models/owner_override.rb +279 -0
  1027. data/lib/plaid/models/ownership_type.rb +42 -0
  1028. data/lib/plaid/models/parties.rb +227 -0
  1029. data/lib/plaid/models/partner_customer_create_request.rb +425 -0
  1030. data/lib/plaid/models/partner_customer_create_response.rb +230 -0
  1031. data/lib/plaid/models/partner_customer_enable_request.rb +245 -0
  1032. data/lib/plaid/models/partner_customer_enable_response.rb +231 -0
  1033. data/lib/plaid/models/partner_customer_get_request.rb +245 -0
  1034. data/lib/plaid/models/partner_customer_get_response.rb +230 -0
  1035. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +245 -0
  1036. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +273 -0
  1037. data/lib/plaid/models/partner_customer_remove_request.rb +246 -0
  1038. data/lib/plaid/models/partner_customer_remove_response.rb +221 -0
  1039. data/lib/plaid/models/partner_end_customer.rb +262 -0
  1040. data/lib/plaid/models/partner_end_customer_address.rb +257 -0
  1041. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +239 -0
  1042. data/lib/plaid/models/partner_end_customer_billing_contact.rb +238 -0
  1043. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +248 -0
  1044. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +41 -0
  1045. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +260 -0
  1046. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +42 -0
  1047. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +251 -0
  1048. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +42 -0
  1049. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +336 -0
  1050. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +40 -0
  1051. data/lib/plaid/models/partner_end_customer_secrets.rb +241 -0
  1052. data/lib/plaid/models/partner_end_customer_status.rb +41 -0
  1053. data/lib/plaid/models/partner_end_customer_technical_contact.rb +238 -0
  1054. data/lib/plaid/models/partner_end_customer_with_secrets.rb +279 -0
  1055. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +219 -0
  1056. data/lib/plaid/models/party.rb +253 -0
  1057. data/lib/plaid/models/party_individual.rb +225 -0
  1058. data/lib/plaid/models/party_role_type.rb +38 -0
  1059. data/lib/plaid/models/pay.rb +233 -0
  1060. data/lib/plaid/models/pay_frequency.rb +261 -0
  1061. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  1062. data/lib/plaid/models/pay_period_details.rb +320 -0
  1063. data/lib/plaid/models/pay_period_details_pay_frequency.rb +43 -0
  1064. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +266 -0
  1065. data/lib/plaid/models/pay_stub_deductions_total.rb +255 -0
  1066. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +288 -0
  1067. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +299 -0
  1068. data/lib/plaid/models/pay_stub_earnings_total.rb +266 -0
  1069. data/lib/plaid/models/pay_stub_pay_period_details.rb +346 -0
  1070. data/lib/plaid/models/pay_stub_taxpayer_id.rb +233 -0
  1071. data/lib/plaid/models/payment_amount.rb +262 -0
  1072. data/lib/plaid/models/payment_amount_currency.rb +43 -0
  1073. data/lib/plaid/models/payment_amount_nullable.rb +283 -0
  1074. data/lib/plaid/models/payment_amount_refunded.rb +290 -0
  1075. data/lib/plaid/models/payment_amount_to_refund.rb +290 -0
  1076. data/lib/plaid/models/payment_channel.rb +40 -0
  1077. data/lib/plaid/models/payment_consent_max_payment_amount.rb +269 -0
  1078. data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
  1079. data/lib/plaid/models/payment_consent_periodic_amount.rb +275 -0
  1080. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +269 -0
  1081. data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
  1082. data/lib/plaid/models/payment_consent_valid_date_time.rb +233 -0
  1083. data/lib/plaid/models/payment_initiation_address.rb +384 -0
  1084. data/lib/plaid/models/payment_initiation_consent.rb +394 -0
  1085. data/lib/plaid/models/payment_initiation_consent_constraints.rb +273 -0
  1086. data/lib/plaid/models/payment_initiation_consent_create_request.rb +385 -0
  1087. data/lib/plaid/models/payment_initiation_consent_create_response.rb +277 -0
  1088. data/lib/plaid/models/payment_initiation_consent_get_request.rb +246 -0
  1089. data/lib/plaid/models/payment_initiation_consent_get_response.rb +417 -0
  1090. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +306 -0
  1091. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +231 -0
  1092. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +382 -0
  1093. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +287 -0
  1094. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +39 -0
  1095. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +246 -0
  1096. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +221 -0
  1097. data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
  1098. data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
  1099. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +345 -0
  1100. data/lib/plaid/models/payment_initiation_consent_type.rb +39 -0
  1101. data/lib/plaid/models/payment_initiation_metadata.rb +298 -0
  1102. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +290 -0
  1103. data/lib/plaid/models/payment_initiation_payment.rb +469 -0
  1104. data/lib/plaid/models/payment_initiation_payment_create_request.rb +324 -0
  1105. data/lib/plaid/models/payment_initiation_payment_create_response.rb +277 -0
  1106. data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
  1107. data/lib/plaid/models/payment_initiation_payment_get_request.rb +246 -0
  1108. data/lib/plaid/models/payment_initiation_payment_get_response.rb +492 -0
  1109. data/lib/plaid/models/payment_initiation_payment_list_request.rb +292 -0
  1110. data/lib/plaid/models/payment_initiation_payment_list_response.rb +254 -0
  1111. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +366 -0
  1112. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +277 -0
  1113. data/lib/plaid/models/payment_initiation_payment_status.rb +51 -0
  1114. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +246 -0
  1115. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +256 -0
  1116. data/lib/plaid/models/payment_initiation_recipient.rb +272 -0
  1117. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +324 -0
  1118. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +241 -0
  1119. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +246 -0
  1120. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +295 -0
  1121. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +220 -0
  1122. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +297 -0
  1123. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +270 -0
  1124. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +258 -0
  1125. data/lib/plaid/models/payment_meta.rb +299 -0
  1126. data/lib/plaid/models/payment_profile_create_request.rb +231 -0
  1127. data/lib/plaid/models/payment_profile_create_response.rb +241 -0
  1128. data/lib/plaid/models/payment_profile_get_request.rb +246 -0
  1129. data/lib/plaid/models/payment_profile_get_response.rb +303 -0
  1130. data/lib/plaid/models/payment_profile_remove_request.rb +246 -0
  1131. data/lib/plaid/models/payment_profile_remove_response.rb +226 -0
  1132. data/lib/plaid/models/payment_profile_status.rb +40 -0
  1133. data/lib/plaid/models/payment_schedule_interval.rb +39 -0
  1134. data/lib/plaid/models/payment_scheme.rb +42 -0
  1135. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  1136. data/lib/plaid/models/payroll_income_account_data.rb +247 -0
  1137. data/lib/plaid/models/payroll_income_object.rb +273 -0
  1138. data/lib/plaid/models/payroll_income_rate_of_pay.rb +233 -0
  1139. data/lib/plaid/models/payroll_item.rb +309 -0
  1140. data/lib/plaid/models/payroll_item_status.rb +222 -0
  1141. data/lib/plaid/models/payroll_risk_signals_item.rb +243 -0
  1142. data/lib/plaid/models/paystub.rb +348 -0
  1143. data/lib/plaid/models/paystub_address.rb +299 -0
  1144. data/lib/plaid/models/paystub_deduction.rb +244 -0
  1145. data/lib/plaid/models/paystub_details.rb +287 -0
  1146. data/lib/plaid/models/paystub_employer.rb +231 -0
  1147. data/lib/plaid/models/paystub_override.rb +276 -0
  1148. data/lib/plaid/models/paystub_override_deductions.rb +231 -0
  1149. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +255 -0
  1150. data/lib/plaid/models/paystub_override_deductions_total.rb +244 -0
  1151. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +277 -0
  1152. data/lib/plaid/models/paystub_override_earnings.rb +231 -0
  1153. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +309 -0
  1154. data/lib/plaid/models/paystub_override_earnings_total.rb +244 -0
  1155. data/lib/plaid/models/paystub_override_employee.rb +250 -0
  1156. data/lib/plaid/models/paystub_override_employee_address.rb +261 -0
  1157. data/lib/plaid/models/paystub_override_employer.rb +231 -0
  1158. data/lib/plaid/models/paystub_override_employer_address.rb +261 -0
  1159. data/lib/plaid/models/paystub_override_net_pay.rb +244 -0
  1160. data/lib/plaid/models/paystub_override_pay_period_details.rb +320 -0
  1161. data/lib/plaid/models/paystub_override_taxpayer_id.rb +233 -0
  1162. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  1163. data/lib/plaid/models/paystub_ytd_details.rb +233 -0
  1164. data/lib/plaid/models/pending_disconnect_webhook.rb +306 -0
  1165. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +39 -0
  1166. data/lib/plaid/models/pending_expiration_webhook.rb +307 -0
  1167. data/lib/plaid/models/personal_finance_category.rb +252 -0
  1168. data/lib/plaid/models/phone_number.rb +290 -0
  1169. data/lib/plaid/models/phone_number_match_score.rb +222 -0
  1170. data/lib/plaid/models/phone_type.rb +39 -0
  1171. data/lib/plaid/models/physical_document_category.rb +43 -0
  1172. data/lib/plaid/models/physical_document_extracted_data.rb +326 -0
  1173. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +289 -0
  1174. data/lib/plaid/models/physical_document_images.rb +266 -0
  1175. data/lib/plaid/models/plaid_check_score.rb +245 -0
  1176. data/lib/plaid/models/plaid_check_score_version.rb +39 -0
  1177. data/lib/plaid/models/plaid_error.rb +353 -0
  1178. data/lib/plaid/models/plaid_error_type.rb +58 -0
  1179. data/lib/plaid/models/platform_ids.rb +244 -0
  1180. data/lib/plaid/models/po_box_status.rb +40 -0
  1181. data/lib/plaid/models/prism_cash_score.rb +278 -0
  1182. data/lib/plaid/models/prism_cash_score_metadata.rb +321 -0
  1183. data/lib/plaid/models/prism_cash_score_version.rb +41 -0
  1184. data/lib/plaid/models/prism_detect.rb +268 -0
  1185. data/lib/plaid/models/prism_detect_version.rb +39 -0
  1186. data/lib/plaid/models/prism_extend.rb +268 -0
  1187. data/lib/plaid/models/prism_extend_version.rb +39 -0
  1188. data/lib/plaid/models/prism_first_detect.rb +278 -0
  1189. data/lib/plaid/models/prism_first_detect_version.rb +39 -0
  1190. data/lib/plaid/models/prism_insights.rb +246 -0
  1191. data/lib/plaid/models/prism_insights_version.rb +40 -0
  1192. data/lib/plaid/models/prism_product.rb +39 -0
  1193. data/lib/plaid/models/prism_versions.rb +283 -0
  1194. data/lib/plaid/models/prism_versions_deprecated.rb +283 -0
  1195. data/lib/plaid/models/processor_account_get_request.rb +246 -0
  1196. data/lib/plaid/models/processor_account_get_response.rb +255 -0
  1197. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +261 -0
  1198. data/lib/plaid/models/processor_auth_get_request.rb +246 -0
  1199. data/lib/plaid/models/processor_auth_get_response.rb +254 -0
  1200. data/lib/plaid/models/processor_balance_get_request.rb +255 -0
  1201. data/lib/plaid/models/processor_balance_get_request_options.rb +221 -0
  1202. data/lib/plaid/models/processor_balance_get_response.rb +240 -0
  1203. data/lib/plaid/models/processor_bank_transfer_create_request.rb +482 -0
  1204. data/lib/plaid/models/processor_bank_transfer_create_response.rb +240 -0
  1205. data/lib/plaid/models/processor_default_update_webhook.rb +317 -0
  1206. data/lib/plaid/models/processor_historical_update_webhook.rb +317 -0
  1207. data/lib/plaid/models/processor_identity_get_request.rb +246 -0
  1208. data/lib/plaid/models/processor_identity_get_response.rb +240 -0
  1209. data/lib/plaid/models/processor_identity_match_request.rb +255 -0
  1210. data/lib/plaid/models/processor_identity_match_response.rb +240 -0
  1211. data/lib/plaid/models/processor_initial_update_webhook.rb +318 -0
  1212. data/lib/plaid/models/processor_investments_holdings_get_request.rb +246 -0
  1213. data/lib/plaid/models/processor_investments_holdings_get_response.rb +284 -0
  1214. data/lib/plaid/models/processor_investments_transactions_get_request.rb +285 -0
  1215. data/lib/plaid/models/processor_investments_transactions_get_response.rb +299 -0
  1216. data/lib/plaid/models/processor_liabilities_get_request.rb +246 -0
  1217. data/lib/plaid/models/processor_liabilities_get_response.rb +254 -0
  1218. data/lib/plaid/models/processor_number.rb +251 -0
  1219. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +292 -0
  1220. data/lib/plaid/models/processor_signal_decision_report_request.rb +387 -0
  1221. data/lib/plaid/models/processor_signal_decision_report_response.rb +226 -0
  1222. data/lib/plaid/models/processor_signal_evaluate_request.rb +378 -0
  1223. data/lib/plaid/models/processor_signal_evaluate_response.rb +267 -0
  1224. data/lib/plaid/models/processor_signal_prepare_request.rb +246 -0
  1225. data/lib/plaid/models/processor_signal_prepare_response.rb +226 -0
  1226. data/lib/plaid/models/processor_signal_return_report_request.rb +317 -0
  1227. data/lib/plaid/models/processor_signal_return_report_response.rb +226 -0
  1228. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +261 -0
  1229. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +241 -0
  1230. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +322 -0
  1231. data/lib/plaid/models/processor_token_create_request.rb +310 -0
  1232. data/lib/plaid/models/processor_token_create_response.rb +241 -0
  1233. data/lib/plaid/models/processor_token_permissions_get_request.rb +246 -0
  1234. data/lib/plaid/models/processor_token_permissions_get_response.rb +243 -0
  1235. data/lib/plaid/models/processor_token_permissions_set_request.rb +263 -0
  1236. data/lib/plaid/models/processor_token_permissions_set_response.rb +226 -0
  1237. data/lib/plaid/models/processor_token_webhook_update.rb +317 -0
  1238. data/lib/plaid/models/processor_token_webhook_update_request.rb +257 -0
  1239. data/lib/plaid/models/processor_token_webhook_update_response.rb +226 -0
  1240. data/lib/plaid/models/processor_transactions_get_request.rb +285 -0
  1241. data/lib/plaid/models/processor_transactions_get_request_options.rb +327 -0
  1242. data/lib/plaid/models/processor_transactions_get_response.rb +272 -0
  1243. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +255 -0
  1244. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +275 -0
  1245. data/lib/plaid/models/processor_transactions_refresh_request.rb +246 -0
  1246. data/lib/plaid/models/processor_transactions_refresh_response.rb +226 -0
  1247. data/lib/plaid/models/processor_transactions_removed_webhook.rb +319 -0
  1248. data/lib/plaid/models/processor_transactions_sync_request.rb +303 -0
  1249. data/lib/plaid/models/processor_transactions_sync_response.rb +353 -0
  1250. data/lib/plaid/models/product_access.rb +328 -0
  1251. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +292 -0
  1252. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +292 -0
  1253. data/lib/plaid/models/product_status.rb +289 -0
  1254. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  1255. data/lib/plaid/models/products.rb +71 -0
  1256. data/lib/plaid/models/profile_network_status_get_request.rb +245 -0
  1257. data/lib/plaid/models/profile_network_status_get_response.rb +262 -0
  1258. data/lib/plaid/models/program_name_sensitivity.rb +41 -0
  1259. data/lib/plaid/models/projected_income_summary_field_number.rb +269 -0
  1260. data/lib/plaid/models/protect_event.rb +275 -0
  1261. data/lib/plaid/models/protect_event_get_request.rb +246 -0
  1262. data/lib/plaid/models/protect_event_get_response.rb +279 -0
  1263. data/lib/plaid/models/protect_event_send_request.rb +271 -0
  1264. data/lib/plaid/models/protect_event_send_response.rb +264 -0
  1265. data/lib/plaid/models/protect_user_event_webhook.rb +297 -0
  1266. data/lib/plaid/models/protect_user_insights_get_request.rb +251 -0
  1267. data/lib/plaid/models/protect_user_insights_get_response.rb +251 -0
  1268. data/lib/plaid/models/proxy_type.rb +42 -0
  1269. data/lib/plaid/models/pslf_status.rb +244 -0
  1270. data/lib/plaid/models/reason_code.rb +52 -0
  1271. data/lib/plaid/models/recaptcha_required_error.rb +315 -0
  1272. data/lib/plaid/models/recipient_bacs.rb +283 -0
  1273. data/lib/plaid/models/recipient_bacs_nullable.rb +290 -0
  1274. data/lib/plaid/models/recommendation_string.rb +40 -0
  1275. data/lib/plaid/models/recurrence.rb +254 -0
  1276. data/lib/plaid/models/recurring_cancelled_webhook.rb +292 -0
  1277. data/lib/plaid/models/recurring_frequency.rb +46 -0
  1278. data/lib/plaid/models/recurring_insights_stream.rb +401 -0
  1279. data/lib/plaid/models/recurring_new_transfer_webhook.rb +307 -0
  1280. data/lib/plaid/models/recurring_transaction_frequency.rb +43 -0
  1281. data/lib/plaid/models/recurring_transactions.rb +245 -0
  1282. data/lib/plaid/models/recurring_transactions_update_webhook.rb +309 -0
  1283. data/lib/plaid/models/recurring_transfer.rb +471 -0
  1284. data/lib/plaid/models/recurring_transfer_nullable.rb +478 -0
  1285. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +330 -0
  1286. data/lib/plaid/models/refresh_result.rb +241 -0
  1287. data/lib/plaid/models/removed_transaction.rb +241 -0
  1288. data/lib/plaid/models/report_type.rb +38 -0
  1289. data/lib/plaid/models/reporting_information.rb +226 -0
  1290. data/lib/plaid/models/risk_check_behavior.rb +284 -0
  1291. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +40 -0
  1292. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +40 -0
  1293. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +41 -0
  1294. data/lib/plaid/models/risk_check_details.rb +314 -0
  1295. data/lib/plaid/models/risk_check_device.rb +286 -0
  1296. data/lib/plaid/models/risk_check_email.rb +397 -0
  1297. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +40 -0
  1298. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +40 -0
  1299. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +40 -0
  1300. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +40 -0
  1301. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +40 -0
  1302. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +231 -0
  1303. data/lib/plaid/models/risk_check_linked_service.rb +127 -0
  1304. data/lib/plaid/models/risk_check_network.rb +264 -0
  1305. data/lib/plaid/models/risk_check_phone.rb +283 -0
  1306. data/lib/plaid/models/risk_check_stolen_identity.rb +257 -0
  1307. data/lib/plaid/models/risk_check_synthetic_identity.rb +277 -0
  1308. data/lib/plaid/models/risk_level.rb +40 -0
  1309. data/lib/plaid/models/risk_level_with_no_data.rb +41 -0
  1310. data/lib/plaid/models/risk_profile.rb +231 -0
  1311. data/lib/plaid/models/risk_reason.rb +241 -0
  1312. data/lib/plaid/models/risk_signal_document_reference.rb +283 -0
  1313. data/lib/plaid/models/risk_signal_document_status.rb +42 -0
  1314. data/lib/plaid/models/risk_signal_document_type.rb +49 -0
  1315. data/lib/plaid/models/risk_signal_file_type.rb +45 -0
  1316. data/lib/plaid/models/role.rb +225 -0
  1317. data/lib/plaid/models/role_detail.rb +247 -0
  1318. data/lib/plaid/models/roles.rb +225 -0
  1319. data/lib/plaid/models/rule_details.rb +231 -0
  1320. data/lib/plaid/models/rule_result.rb +40 -0
  1321. data/lib/plaid/models/ruleset.rb +277 -0
  1322. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +291 -0
  1323. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +226 -0
  1324. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +39 -0
  1325. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +257 -0
  1326. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +246 -0
  1327. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +226 -0
  1328. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +271 -0
  1329. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +226 -0
  1330. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +259 -0
  1331. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +226 -0
  1332. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +329 -0
  1333. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +226 -0
  1334. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +39 -0
  1335. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +304 -0
  1336. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +241 -0
  1337. data/lib/plaid/models/sandbox_item_reset_login_request.rb +246 -0
  1338. data/lib/plaid/models/sandbox_item_reset_login_response.rb +241 -0
  1339. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +310 -0
  1340. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +226 -0
  1341. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +241 -0
  1342. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +246 -0
  1343. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +241 -0
  1344. data/lib/plaid/models/sandbox_payment_simulate_request.rb +276 -0
  1345. data/lib/plaid/models/sandbox_payment_simulate_response.rb +276 -0
  1346. data/lib/plaid/models/sandbox_processor_token_create_request.rb +255 -0
  1347. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +237 -0
  1348. data/lib/plaid/models/sandbox_processor_token_create_response.rb +241 -0
  1349. data/lib/plaid/models/sandbox_public_token_create_request.rb +303 -0
  1350. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +221 -0
  1351. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +275 -0
  1352. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +232 -0
  1353. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +241 -0
  1354. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +269 -0
  1355. data/lib/plaid/models/sandbox_public_token_create_response.rb +241 -0
  1356. data/lib/plaid/models/sandbox_transactions_create_request.rb +263 -0
  1357. data/lib/plaid/models/sandbox_transactions_create_response.rb +226 -0
  1358. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +246 -0
  1359. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +226 -0
  1360. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +292 -0
  1361. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +226 -0
  1362. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +274 -0
  1363. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +226 -0
  1364. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +292 -0
  1365. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +226 -0
  1366. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +292 -0
  1367. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +226 -0
  1368. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +231 -0
  1369. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +226 -0
  1370. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +292 -0
  1371. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +226 -0
  1372. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +252 -0
  1373. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +235 -0
  1374. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +261 -0
  1375. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +226 -0
  1376. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +242 -0
  1377. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +240 -0
  1378. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +246 -0
  1379. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +240 -0
  1380. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +321 -0
  1381. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +242 -0
  1382. data/lib/plaid/models/sandbox_user_reset_login_request.rb +259 -0
  1383. data/lib/plaid/models/sandbox_user_reset_login_response.rb +226 -0
  1384. data/lib/plaid/models/scopes.rb +244 -0
  1385. data/lib/plaid/models/scopes_context.rb +39 -0
  1386. data/lib/plaid/models/scopes_nullable.rb +251 -0
  1387. data/lib/plaid/models/screening_hit_analysis.rb +284 -0
  1388. data/lib/plaid/models/screening_hit_data.rb +259 -0
  1389. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +229 -0
  1390. data/lib/plaid/models/screening_hit_documents_items.rb +229 -0
  1391. data/lib/plaid/models/screening_hit_names_items.rb +229 -0
  1392. data/lib/plaid/models/screening_status_updated_webhook.rb +292 -0
  1393. data/lib/plaid/models/security.rb +444 -0
  1394. data/lib/plaid/models/security_override.rb +271 -0
  1395. data/lib/plaid/models/selfie_analysis.rb +271 -0
  1396. data/lib/plaid/models/selfie_analysis_document_comparison.rb +40 -0
  1397. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +401 -0
  1398. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +39 -0
  1399. data/lib/plaid/models/selfie_analysis_liveness_check.rb +39 -0
  1400. data/lib/plaid/models/selfie_capture.rb +233 -0
  1401. data/lib/plaid/models/selfie_check.rb +264 -0
  1402. data/lib/plaid/models/selfie_check_selfie.rb +290 -0
  1403. data/lib/plaid/models/selfie_check_status.rb +39 -0
  1404. data/lib/plaid/models/selfie_status.rb +39 -0
  1405. data/lib/plaid/models/sender_bacs_nullable.rb +290 -0
  1406. data/lib/plaid/models/service.rb +239 -0
  1407. data/lib/plaid/models/service_product_fulfillment.rb +225 -0
  1408. data/lib/plaid/models/service_product_fulfillment_detail.rb +258 -0
  1409. data/lib/plaid/models/service_product_fulfillment_identifier.rb +39 -0
  1410. data/lib/plaid/models/servicer_address_data.rb +266 -0
  1411. data/lib/plaid/models/services.rb +225 -0
  1412. data/lib/plaid/models/session_token_create_request.rb +290 -0
  1413. data/lib/plaid/models/session_token_create_request_user.rb +236 -0
  1414. data/lib/plaid/models/session_token_create_response.rb +235 -0
  1415. data/lib/plaid/models/session_token_create_response_link.rb +251 -0
  1416. data/lib/plaid/models/signal_address_data.rb +264 -0
  1417. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  1418. data/lib/plaid/models/signal_decision_report_request.rb +382 -0
  1419. data/lib/plaid/models/signal_decision_report_response.rb +226 -0
  1420. data/lib/plaid/models/signal_device.rb +233 -0
  1421. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1091 -0
  1422. data/lib/plaid/models/signal_evaluate_request.rb +404 -0
  1423. data/lib/plaid/models/signal_evaluate_response.rb +282 -0
  1424. data/lib/plaid/models/signal_payment_method.rb +42 -0
  1425. data/lib/plaid/models/signal_person_name.rb +266 -0
  1426. data/lib/plaid/models/signal_prepare_request.rb +246 -0
  1427. data/lib/plaid/models/signal_prepare_response.rb +226 -0
  1428. data/lib/plaid/models/signal_return_report_request.rb +302 -0
  1429. data/lib/plaid/models/signal_return_report_response.rb +226 -0
  1430. data/lib/plaid/models/signal_schedule_default_payment_method.rb +40 -0
  1431. data/lib/plaid/models/signal_schedule_recommendation.rb +263 -0
  1432. data/lib/plaid/models/signal_schedule_request.rb +352 -0
  1433. data/lib/plaid/models/signal_schedule_response.rb +271 -0
  1434. data/lib/plaid/models/signal_scores.rb +229 -0
  1435. data/lib/plaid/models/signal_user.rb +253 -0
  1436. data/lib/plaid/models/signal_warning.rb +241 -0
  1437. data/lib/plaid/models/simulated_transfer_sweep.rb +399 -0
  1438. data/lib/plaid/models/single_document_risk_signal.rb +256 -0
  1439. data/lib/plaid/models/sms_verification.rb +336 -0
  1440. data/lib/plaid/models/sms_verification_status.rb +41 -0
  1441. data/lib/plaid/models/source.rb +41 -0
  1442. data/lib/plaid/models/standalone_account_type.rb +296 -0
  1443. data/lib/plaid/models/standalone_currency_code_list.rb +241 -0
  1444. data/lib/plaid/models/standalone_investment_transaction_type.rb +301 -0
  1445. data/lib/plaid/models/statements_account.rb +318 -0
  1446. data/lib/plaid/models/statements_download_request.rb +261 -0
  1447. data/lib/plaid/models/statements_list_request.rb +246 -0
  1448. data/lib/plaid/models/statements_list_response.rb +287 -0
  1449. data/lib/plaid/models/statements_refresh_complete_result.rb +39 -0
  1450. data/lib/plaid/models/statements_refresh_complete_webhook.rb +306 -0
  1451. data/lib/plaid/models/statements_refresh_request.rb +276 -0
  1452. data/lib/plaid/models/statements_refresh_response.rb +226 -0
  1453. data/lib/plaid/models/statements_statement.rb +288 -0
  1454. data/lib/plaid/models/status.rb +233 -0
  1455. data/lib/plaid/models/statuses.rb +225 -0
  1456. data/lib/plaid/models/strategy.rb +41 -0
  1457. data/lib/plaid/models/student_loan.rb +504 -0
  1458. data/lib/plaid/models/student_loan_repayment_model.rb +256 -0
  1459. data/lib/plaid/models/student_loan_status.rb +267 -0
  1460. data/lib/plaid/models/student_repayment_plan.rb +267 -0
  1461. data/lib/plaid/models/sweep_failure.rb +233 -0
  1462. data/lib/plaid/models/sweep_status.rb +44 -0
  1463. data/lib/plaid/models/sweep_trigger.rb +41 -0
  1464. data/lib/plaid/models/sync_updates_available_webhook.rb +322 -0
  1465. data/lib/plaid/models/synthetic_fraud.rb +247 -0
  1466. data/lib/plaid/models/taxform.rb +245 -0
  1467. data/lib/plaid/models/taxpayer_id.rb +270 -0
  1468. data/lib/plaid/models/taxpayer_identifier.rb +254 -0
  1469. data/lib/plaid/models/taxpayer_identifier_type.rb +39 -0
  1470. data/lib/plaid/models/taxpayer_identifiers.rb +225 -0
  1471. data/lib/plaid/models/tch_notification.rb +274 -0
  1472. data/lib/plaid/models/tch_notification_response.rb +261 -0
  1473. data/lib/plaid/models/total.rb +272 -0
  1474. data/lib/plaid/models/total_canonical_description.rb +54 -0
  1475. data/lib/plaid/models/total_inflow_amount.rb +248 -0
  1476. data/lib/plaid/models/total_inflow_amount30d.rb +248 -0
  1477. data/lib/plaid/models/total_inflow_amount60d.rb +248 -0
  1478. data/lib/plaid/models/total_inflow_amount90d.rb +248 -0
  1479. data/lib/plaid/models/total_monthly_income_insights.rb +241 -0
  1480. data/lib/plaid/models/total_outflow_amount.rb +248 -0
  1481. data/lib/plaid/models/total_outflow_amount30d.rb +248 -0
  1482. data/lib/plaid/models/total_outflow_amount60d.rb +248 -0
  1483. data/lib/plaid/models/total_outflow_amount90d.rb +248 -0
  1484. data/lib/plaid/models/total_report_inflow_amount.rb +248 -0
  1485. data/lib/plaid/models/total_report_inflow_amount30d.rb +248 -0
  1486. data/lib/plaid/models/total_report_inflow_amount60d.rb +248 -0
  1487. data/lib/plaid/models/total_report_inflow_amount90d.rb +248 -0
  1488. data/lib/plaid/models/total_report_outflow_amount.rb +248 -0
  1489. data/lib/plaid/models/total_report_outflow_amount30d.rb +248 -0
  1490. data/lib/plaid/models/total_report_outflow_amount60d.rb +248 -0
  1491. data/lib/plaid/models/total_report_outflow_amount90d.rb +248 -0
  1492. data/lib/plaid/models/transaction.rb +627 -0
  1493. data/lib/plaid/models/transaction_all_of.rb +355 -0
  1494. data/lib/plaid/models/transaction_base.rb +481 -0
  1495. data/lib/plaid/models/transaction_code.rb +50 -0
  1496. data/lib/plaid/models/transaction_counterparty.rb +316 -0
  1497. data/lib/plaid/models/transaction_data.rb +286 -0
  1498. data/lib/plaid/models/transaction_override.rb +281 -0
  1499. data/lib/plaid/models/transaction_stream.rb +477 -0
  1500. data/lib/plaid/models/transaction_stream_amount.rb +243 -0
  1501. data/lib/plaid/models/transaction_stream_status.rb +41 -0
  1502. data/lib/plaid/models/transactions_category_rule.rb +260 -0
  1503. data/lib/plaid/models/transactions_enhance_get_request.rb +263 -0
  1504. data/lib/plaid/models/transactions_enhance_get_response.rb +228 -0
  1505. data/lib/plaid/models/transactions_enrich_request.rb +272 -0
  1506. data/lib/plaid/models/transactions_enrich_request_options.rb +223 -0
  1507. data/lib/plaid/models/transactions_enrich_response.rb +238 -0
  1508. data/lib/plaid/models/transactions_get_request.rb +285 -0
  1509. data/lib/plaid/models/transactions_get_request_options.rb +377 -0
  1510. data/lib/plaid/models/transactions_get_response.rb +289 -0
  1511. data/lib/plaid/models/transactions_recurring_create_input.rb +223 -0
  1512. data/lib/plaid/models/transactions_recurring_create_request.rb +263 -0
  1513. data/lib/plaid/models/transactions_recurring_create_response.rb +252 -0
  1514. data/lib/plaid/models/transactions_recurring_get_request.rb +267 -0
  1515. data/lib/plaid/models/transactions_recurring_get_request_options.rb +223 -0
  1516. data/lib/plaid/models/transactions_recurring_get_response.rb +275 -0
  1517. data/lib/plaid/models/transactions_recurring_merge_input.rb +228 -0
  1518. data/lib/plaid/models/transactions_recurring_merge_request.rb +263 -0
  1519. data/lib/plaid/models/transactions_recurring_merge_response.rb +240 -0
  1520. data/lib/plaid/models/transactions_recurring_update_input.rb +243 -0
  1521. data/lib/plaid/models/transactions_recurring_update_request.rb +263 -0
  1522. data/lib/plaid/models/transactions_recurring_update_response.rb +240 -0
  1523. data/lib/plaid/models/transactions_refresh_request.rb +246 -0
  1524. data/lib/plaid/models/transactions_refresh_response.rb +226 -0
  1525. data/lib/plaid/models/transactions_removed_webhook.rb +319 -0
  1526. data/lib/plaid/models/transactions_rule_details.rb +276 -0
  1527. data/lib/plaid/models/transactions_rule_field.rb +39 -0
  1528. data/lib/plaid/models/transactions_rule_type.rb +39 -0
  1529. data/lib/plaid/models/transactions_rules_create_request.rb +275 -0
  1530. data/lib/plaid/models/transactions_rules_create_response.rb +240 -0
  1531. data/lib/plaid/models/transactions_rules_list_request.rb +246 -0
  1532. data/lib/plaid/models/transactions_rules_list_response.rb +243 -0
  1533. data/lib/plaid/models/transactions_rules_remove_request.rb +261 -0
  1534. data/lib/plaid/models/transactions_rules_remove_response.rb +226 -0
  1535. data/lib/plaid/models/transactions_sync_request.rb +303 -0
  1536. data/lib/plaid/models/transactions_sync_request_options.rb +296 -0
  1537. data/lib/plaid/models/transactions_sync_response.rb +360 -0
  1538. data/lib/plaid/models/transactions_update_status.rb +41 -0
  1539. data/lib/plaid/models/transactions_user_insights_get_request.rb +246 -0
  1540. data/lib/plaid/models/transactions_user_insights_get_response.rb +252 -0
  1541. data/lib/plaid/models/transfer.rb +652 -0
  1542. data/lib/plaid/models/transfer_ach_network.rb +39 -0
  1543. data/lib/plaid/models/transfer_authorization.rb +331 -0
  1544. data/lib/plaid/models/transfer_authorization_cancel_request.rb +246 -0
  1545. data/lib/plaid/models/transfer_authorization_cancel_response.rb +226 -0
  1546. data/lib/plaid/models/transfer_authorization_create_request.rb +525 -0
  1547. data/lib/plaid/models/transfer_authorization_create_response.rb +240 -0
  1548. data/lib/plaid/models/transfer_authorization_decision.rb +40 -0
  1549. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +262 -0
  1550. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +46 -0
  1551. data/lib/plaid/models/transfer_authorization_device.rb +231 -0
  1552. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +40 -0
  1553. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +262 -0
  1554. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +42 -0
  1555. data/lib/plaid/models/transfer_authorization_payment_risk.rb +334 -0
  1556. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +397 -0
  1557. data/lib/plaid/models/transfer_authorization_risk_level.rb +42 -0
  1558. data/lib/plaid/models/transfer_authorization_user_in_request.rb +255 -0
  1559. data/lib/plaid/models/transfer_balance.rb +272 -0
  1560. data/lib/plaid/models/transfer_balance_get_request.rb +273 -0
  1561. data/lib/plaid/models/transfer_balance_get_response.rb +240 -0
  1562. data/lib/plaid/models/transfer_balance_type.rb +39 -0
  1563. data/lib/plaid/models/transfer_cancel_request.rb +288 -0
  1564. data/lib/plaid/models/transfer_cancel_response.rb +226 -0
  1565. data/lib/plaid/models/transfer_capabilities_get_request.rb +271 -0
  1566. data/lib/plaid/models/transfer_capabilities_get_response.rb +240 -0
  1567. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +223 -0
  1568. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +223 -0
  1569. data/lib/plaid/models/transfer_configuration_get_request.rb +242 -0
  1570. data/lib/plaid/models/transfer_configuration_get_response.rb +361 -0
  1571. data/lib/plaid/models/transfer_create_request.rb +450 -0
  1572. data/lib/plaid/models/transfer_create_response.rb +240 -0
  1573. data/lib/plaid/models/transfer_credit_funds_source.rb +41 -0
  1574. data/lib/plaid/models/transfer_credit_usage_configuration.rb +309 -0
  1575. data/lib/plaid/models/transfer_debit_usage_configuration.rb +309 -0
  1576. data/lib/plaid/models/transfer_device.rb +241 -0
  1577. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +277 -0
  1578. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +226 -0
  1579. data/lib/plaid/models/transfer_diligence_status.rb +43 -0
  1580. data/lib/plaid/models/transfer_diligence_submit_request.rb +260 -0
  1581. data/lib/plaid/models/transfer_diligence_submit_response.rb +226 -0
  1582. data/lib/plaid/models/transfer_document_purpose.rb +38 -0
  1583. data/lib/plaid/models/transfer_event.rb +451 -0
  1584. data/lib/plaid/models/transfer_event_list_request.rb +431 -0
  1585. data/lib/plaid/models/transfer_event_list_response.rb +257 -0
  1586. data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
  1587. data/lib/plaid/models/transfer_event_sync_request.rb +306 -0
  1588. data/lib/plaid/models/transfer_event_sync_response.rb +257 -0
  1589. data/lib/plaid/models/transfer_event_type.rb +61 -0
  1590. data/lib/plaid/models/transfer_events_update_webhook.rb +277 -0
  1591. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +241 -0
  1592. data/lib/plaid/models/transfer_failure.rb +243 -0
  1593. data/lib/plaid/models/transfer_funding_account.rb +241 -0
  1594. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +259 -0
  1595. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +220 -0
  1596. data/lib/plaid/models/transfer_get_request.rb +262 -0
  1597. data/lib/plaid/models/transfer_get_response.rb +240 -0
  1598. data/lib/plaid/models/transfer_intent_authorization_decision.rb +39 -0
  1599. data/lib/plaid/models/transfer_intent_create.rb +444 -0
  1600. data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
  1601. data/lib/plaid/models/transfer_intent_create_network.rb +40 -0
  1602. data/lib/plaid/models/transfer_intent_create_request.rb +439 -0
  1603. data/lib/plaid/models/transfer_intent_create_response.rb +240 -0
  1604. data/lib/plaid/models/transfer_intent_get.rb +505 -0
  1605. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +241 -0
  1606. data/lib/plaid/models/transfer_intent_get_request.rb +246 -0
  1607. data/lib/plaid/models/transfer_intent_get_response.rb +240 -0
  1608. data/lib/plaid/models/transfer_intent_status.rb +40 -0
  1609. data/lib/plaid/models/transfer_ledger_balance.rb +241 -0
  1610. data/lib/plaid/models/transfer_ledger_deposit_request.rb +379 -0
  1611. data/lib/plaid/models/transfer_ledger_deposit_response.rb +240 -0
  1612. data/lib/plaid/models/transfer_ledger_distribute_request.rb +322 -0
  1613. data/lib/plaid/models/transfer_ledger_distribute_response.rb +226 -0
  1614. data/lib/plaid/models/transfer_ledger_get_request.rb +253 -0
  1615. data/lib/plaid/models/transfer_ledger_get_response.rb +285 -0
  1616. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +41 -0
  1617. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +379 -0
  1618. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +240 -0
  1619. data/lib/plaid/models/transfer_list_request.rb +353 -0
  1620. data/lib/plaid/models/transfer_list_response.rb +242 -0
  1621. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +251 -0
  1622. data/lib/plaid/models/transfer_metrics_get_request.rb +242 -0
  1623. data/lib/plaid/models/transfer_metrics_get_response.rb +336 -0
  1624. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +221 -0
  1625. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +241 -0
  1626. data/lib/plaid/models/transfer_migrate_account_request.rb +286 -0
  1627. data/lib/plaid/models/transfer_migrate_account_response.rb +256 -0
  1628. data/lib/plaid/models/transfer_network.rb +41 -0
  1629. data/lib/plaid/models/transfer_originator_address.rb +286 -0
  1630. data/lib/plaid/models/transfer_originator_create_request.rb +267 -0
  1631. data/lib/plaid/models/transfer_originator_create_response.rb +256 -0
  1632. data/lib/plaid/models/transfer_originator_diligence.rb +370 -0
  1633. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +260 -0
  1634. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +236 -0
  1635. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +260 -0
  1636. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +226 -0
  1637. data/lib/plaid/models/transfer_originator_get_request.rb +246 -0
  1638. data/lib/plaid/models/transfer_originator_get_response.rb +240 -0
  1639. data/lib/plaid/models/transfer_originator_list_request.rb +300 -0
  1640. data/lib/plaid/models/transfer_originator_list_response.rb +242 -0
  1641. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +292 -0
  1642. data/lib/plaid/models/transfer_platform_originator_create_request.rb +285 -0
  1643. data/lib/plaid/models/transfer_platform_originator_create_response.rb +226 -0
  1644. data/lib/plaid/models/transfer_platform_person_address.rb +296 -0
  1645. data/lib/plaid/models/transfer_platform_person_create_request.rb +359 -0
  1646. data/lib/plaid/models/transfer_platform_person_create_response.rb +241 -0
  1647. data/lib/plaid/models/transfer_platform_person_id_number.rb +262 -0
  1648. data/lib/plaid/models/transfer_platform_person_name.rb +241 -0
  1649. data/lib/plaid/models/transfer_platform_requirement.rb +232 -0
  1650. data/lib/plaid/models/transfer_platform_requirement_submission.rb +251 -0
  1651. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +285 -0
  1652. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +226 -0
  1653. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +256 -0
  1654. data/lib/plaid/models/transfer_questionnaire_create_request.rb +261 -0
  1655. data/lib/plaid/models/transfer_questionnaire_create_response.rb +241 -0
  1656. data/lib/plaid/models/transfer_recurring_cancel_request.rb +246 -0
  1657. data/lib/plaid/models/transfer_recurring_cancel_response.rb +226 -0
  1658. data/lib/plaid/models/transfer_recurring_create_request.rb +466 -0
  1659. data/lib/plaid/models/transfer_recurring_create_response.rb +281 -0
  1660. data/lib/plaid/models/transfer_recurring_get_request.rb +246 -0
  1661. data/lib/plaid/models/transfer_recurring_get_response.rb +240 -0
  1662. data/lib/plaid/models/transfer_recurring_list_request.rb +331 -0
  1663. data/lib/plaid/models/transfer_recurring_list_response.rb +242 -0
  1664. data/lib/plaid/models/transfer_recurring_network.rb +40 -0
  1665. data/lib/plaid/models/transfer_recurring_schedule.rb +303 -0
  1666. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  1667. data/lib/plaid/models/transfer_refund.rb +339 -0
  1668. data/lib/plaid/models/transfer_refund_cancel_request.rb +246 -0
  1669. data/lib/plaid/models/transfer_refund_cancel_response.rb +226 -0
  1670. data/lib/plaid/models/transfer_refund_create_request.rb +297 -0
  1671. data/lib/plaid/models/transfer_refund_create_response.rb +240 -0
  1672. data/lib/plaid/models/transfer_refund_failure.rb +243 -0
  1673. data/lib/plaid/models/transfer_refund_get_request.rb +246 -0
  1674. data/lib/plaid/models/transfer_refund_get_response.rb +240 -0
  1675. data/lib/plaid/models/transfer_refund_status.rb +43 -0
  1676. data/lib/plaid/models/transfer_repayment.rb +271 -0
  1677. data/lib/plaid/models/transfer_repayment_list_request.rb +321 -0
  1678. data/lib/plaid/models/transfer_repayment_list_response.rb +242 -0
  1679. data/lib/plaid/models/transfer_repayment_return.rb +292 -0
  1680. data/lib/plaid/models/transfer_repayment_return_list_request.rb +314 -0
  1681. data/lib/plaid/models/transfer_repayment_return_list_response.rb +242 -0
  1682. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  1683. data/lib/plaid/models/transfer_status.rb +44 -0
  1684. data/lib/plaid/models/transfer_sweep.rb +392 -0
  1685. data/lib/plaid/models/transfer_sweep_get_request.rb +246 -0
  1686. data/lib/plaid/models/transfer_sweep_get_response.rb +240 -0
  1687. data/lib/plaid/models/transfer_sweep_list_request.rb +407 -0
  1688. data/lib/plaid/models/transfer_sweep_list_response.rb +242 -0
  1689. data/lib/plaid/models/transfer_sweep_status.rb +42 -0
  1690. data/lib/plaid/models/transfer_test_clock.rb +241 -0
  1691. data/lib/plaid/models/transfer_type.rb +39 -0
  1692. data/lib/plaid/models/transfer_user_address_in_request.rb +261 -0
  1693. data/lib/plaid/models/transfer_user_address_in_response.rb +266 -0
  1694. data/lib/plaid/models/transfer_user_in_request.rb +255 -0
  1695. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +250 -0
  1696. data/lib/plaid/models/transfer_user_in_response.rb +258 -0
  1697. data/lib/plaid/models/transfer_wire_details.rb +233 -0
  1698. data/lib/plaid/models/trust_index.rb +251 -0
  1699. data/lib/plaid/models/trust_index_subscore.rb +226 -0
  1700. data/lib/plaid/models/trust_index_subscores.rb +231 -0
  1701. data/lib/plaid/models/trusted_device_data.rb +229 -0
  1702. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +286 -0
  1703. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +261 -0
  1704. data/lib/plaid/models/user_account_identity.rb +285 -0
  1705. data/lib/plaid/models/user_account_identity_address.rb +277 -0
  1706. data/lib/plaid/models/user_account_identity_name.rb +229 -0
  1707. data/lib/plaid/models/user_account_item.rb +231 -0
  1708. data/lib/plaid/models/user_account_revoked_webhook.rb +307 -0
  1709. data/lib/plaid/models/user_account_session_get_request.rb +246 -0
  1710. data/lib/plaid/models/user_account_session_get_response.rb +252 -0
  1711. data/lib/plaid/models/user_address.rb +281 -0
  1712. data/lib/plaid/models/user_create_request.rb +322 -0
  1713. data/lib/plaid/models/user_create_response.rb +251 -0
  1714. data/lib/plaid/models/user_custom_password.rb +298 -0
  1715. data/lib/plaid/models/user_data_overview.rb +291 -0
  1716. data/lib/plaid/models/user_financial_data_refresh_request.rb +246 -0
  1717. data/lib/plaid/models/user_financial_data_refresh_response.rb +242 -0
  1718. data/lib/plaid/models/user_id_number.rb +262 -0
  1719. data/lib/plaid/models/user_items_get_request.rb +246 -0
  1720. data/lib/plaid/models/user_items_get_response.rb +242 -0
  1721. data/lib/plaid/models/user_permission_revoked_webhook.rb +302 -0
  1722. data/lib/plaid/models/user_remove_request.rb +251 -0
  1723. data/lib/plaid/models/user_remove_response.rb +226 -0
  1724. data/lib/plaid/models/user_stated_income_source_category.rb +48 -0
  1725. data/lib/plaid/models/user_stated_income_source_frequency.rb +42 -0
  1726. data/lib/plaid/models/user_stated_income_source_pay_type.rb +40 -0
  1727. data/lib/plaid/models/user_third_party_token_create_request.rb +272 -0
  1728. data/lib/plaid/models/user_third_party_token_create_response.rb +241 -0
  1729. data/lib/plaid/models/user_third_party_token_remove_request.rb +246 -0
  1730. data/lib/plaid/models/user_third_party_token_remove_response.rb +241 -0
  1731. data/lib/plaid/models/user_transactions_refresh_request.rb +246 -0
  1732. data/lib/plaid/models/user_transactions_refresh_response.rb +242 -0
  1733. data/lib/plaid/models/user_update_request.rb +256 -0
  1734. data/lib/plaid/models/user_update_response.rb +226 -0
  1735. data/lib/plaid/models/validation_source.rb +233 -0
  1736. data/lib/plaid/models/validation_sources.rb +228 -0
  1737. data/lib/plaid/models/verification_expired_webhook.rb +317 -0
  1738. data/lib/plaid/models/verification_of_asset.rb +253 -0
  1739. data/lib/plaid/models/verification_of_asset_response.rb +225 -0
  1740. data/lib/plaid/models/verification_refresh_status.rb +40 -0
  1741. data/lib/plaid/models/verification_status.rb +42 -0
  1742. data/lib/plaid/models/verify_sms_details.rb +264 -0
  1743. data/lib/plaid/models/verify_sms_details_status.rb +39 -0
  1744. data/lib/plaid/models/w2.rb +438 -0
  1745. data/lib/plaid/models/w2_box12.rb +233 -0
  1746. data/lib/plaid/models/w2_box12_override.rb +233 -0
  1747. data/lib/plaid/models/w2_override.rb +438 -0
  1748. data/lib/plaid/models/w2_state_and_local_wages.rb +288 -0
  1749. data/lib/plaid/models/w2_state_and_local_wages_override.rb +288 -0
  1750. data/lib/plaid/models/wallet.rb +300 -0
  1751. data/lib/plaid/models/wallet_balance.rb +256 -0
  1752. data/lib/plaid/models/wallet_create_request.rb +267 -0
  1753. data/lib/plaid/models/wallet_create_response.rb +323 -0
  1754. data/lib/plaid/models/wallet_get_request.rb +267 -0
  1755. data/lib/plaid/models/wallet_get_response.rb +323 -0
  1756. data/lib/plaid/models/wallet_iso_currency_code.rb +39 -0
  1757. data/lib/plaid/models/wallet_list_request.rb +327 -0
  1758. data/lib/plaid/models/wallet_list_response.rb +253 -0
  1759. data/lib/plaid/models/wallet_numbers.rb +231 -0
  1760. data/lib/plaid/models/wallet_payment_scheme.rb +41 -0
  1761. data/lib/plaid/models/wallet_status.rb +40 -0
  1762. data/lib/plaid/models/wallet_transaction.rb +430 -0
  1763. data/lib/plaid/models/wallet_transaction_amount.rb +283 -0
  1764. data/lib/plaid/models/wallet_transaction_counterparty.rb +282 -0
  1765. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +290 -0
  1766. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +247 -0
  1767. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +230 -0
  1768. data/lib/plaid/models/wallet_transaction_execute_request.rb +395 -0
  1769. data/lib/plaid/models/wallet_transaction_execute_response.rb +277 -0
  1770. data/lib/plaid/models/wallet_transaction_failure_reason.rb +42 -0
  1771. data/lib/plaid/models/wallet_transaction_get_request.rb +267 -0
  1772. data/lib/plaid/models/wallet_transaction_get_response.rb +453 -0
  1773. data/lib/plaid/models/wallet_transaction_list_request.rb +342 -0
  1774. data/lib/plaid/models/wallet_transaction_list_request_options.rb +231 -0
  1775. data/lib/plaid/models/wallet_transaction_list_response.rb +253 -0
  1776. data/lib/plaid/models/wallet_transaction_relation.rb +265 -0
  1777. data/lib/plaid/models/wallet_transaction_status.rb +43 -0
  1778. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +366 -0
  1779. data/lib/plaid/models/wallet_transactions_list_request.rb +342 -0
  1780. data/lib/plaid/models/warning.rb +285 -0
  1781. data/lib/plaid/models/watchlist_screening_audit_trail.rb +273 -0
  1782. data/lib/plaid/models/watchlist_screening_document.rb +262 -0
  1783. data/lib/plaid/models/watchlist_screening_document_type.rb +50 -0
  1784. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +255 -0
  1785. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +327 -0
  1786. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +246 -0
  1787. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +327 -0
  1788. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +257 -0
  1789. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +254 -0
  1790. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +257 -0
  1791. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +254 -0
  1792. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +308 -0
  1793. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +254 -0
  1794. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +246 -0
  1795. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +380 -0
  1796. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +242 -0
  1797. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +254 -0
  1798. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +291 -0
  1799. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +300 -0
  1800. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +257 -0
  1801. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +254 -0
  1802. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +320 -0
  1803. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +38 -0
  1804. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +327 -0
  1805. data/lib/plaid/models/watchlist_screening_hit.rb +357 -0
  1806. data/lib/plaid/models/watchlist_screening_hit_locations.rb +241 -0
  1807. data/lib/plaid/models/watchlist_screening_hit_status.rb +40 -0
  1808. data/lib/plaid/models/watchlist_screening_individual.rb +312 -0
  1809. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +255 -0
  1810. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +327 -0
  1811. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +246 -0
  1812. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +327 -0
  1813. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +257 -0
  1814. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +254 -0
  1815. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +257 -0
  1816. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +254 -0
  1817. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +308 -0
  1818. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +254 -0
  1819. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +246 -0
  1820. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +380 -0
  1821. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +242 -0
  1822. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +254 -0
  1823. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +291 -0
  1824. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +300 -0
  1825. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +257 -0
  1826. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +254 -0
  1827. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +320 -0
  1828. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +38 -0
  1829. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +327 -0
  1830. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +271 -0
  1831. data/lib/plaid/models/watchlist_screening_review.rb +285 -0
  1832. data/lib/plaid/models/watchlist_screening_search_terms.rb +289 -0
  1833. data/lib/plaid/models/watchlist_screening_status.rb +40 -0
  1834. data/lib/plaid/models/weak_alias_determination.rb +40 -0
  1835. data/lib/plaid/models/webhook_environment_values.rb +39 -0
  1836. data/lib/plaid/models/webhook_type.rb +44 -0
  1837. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +317 -0
  1838. data/lib/plaid/models/webhook_verification_key_get_request.rb +246 -0
  1839. data/lib/plaid/models/webhook_verification_key_get_response.rb +240 -0
  1840. data/lib/plaid/models/yield_rate.rb +258 -0
  1841. data/lib/plaid/models/yield_rate_type.rb +42 -0
  1842. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +269 -0
  1843. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +269 -0
  1844. data/lib/plaid/version.rb +13 -2
  1845. data/lib/plaid.rb +1862 -61
  1846. data/plaid.gemspec +44 -48
  1847. data/templates/ruby/api_client.mustache +287 -0
  1848. data/templates/ruby/api_client_faraday_partial.mustache +130 -0
  1849. data/templates/ruby/api_error.mustache +50 -0
  1850. data/templates/ruby/configuration.mustache +372 -0
  1851. data/templates/ruby/configuration_tls_faraday_partial.mustache +35 -0
  1852. data/templates/ruby/gemspec.mustache +42 -0
  1853. data/templates/ruby/partial_model_enum_class.mustache +22 -0
  1854. data/templates/ruby/partial_model_generic.mustache +362 -0
  1855. data/test/test_accounts.rb +99 -0
  1856. data/test/test_api_client.rb +50 -0
  1857. data/test/test_asset_report.rb +147 -0
  1858. data/test/test_auth.rb +61 -0
  1859. data/test/test_bank_transfers.rb +219 -0
  1860. data/test/test_categories.rb +10 -0
  1861. data/test/test_configuration.rb +27 -0
  1862. data/test/test_enrich.rb +60 -0
  1863. data/test/test_helper.rb +118 -0
  1864. data/test/test_identity.rb +38 -0
  1865. data/test/test_identity_verification.rb +56 -0
  1866. data/test/test_institutions.rb +159 -0
  1867. data/test/test_investments.rb +208 -0
  1868. data/test/test_item.rb +276 -0
  1869. data/test/test_liabilities.rb +45 -0
  1870. data/test/test_link_token.rb +131 -0
  1871. data/test/test_monitor.rb +55 -0
  1872. data/test/test_payment_initiation.rb +94 -0
  1873. data/test/test_processor.rb +52 -0
  1874. data/test/test_sandbox.rb +31 -0
  1875. data/test/test_statements.rb +77 -0
  1876. data/test/test_transactions.rb +168 -0
  1877. data/test/test_webhooks.rb +22 -0
  1878. metadata +1916 -91
  1879. data/.circleci/config.yml +0 -21
  1880. data/.env.sample +0 -3
  1881. data/.github/workflows/add_to_project.yml +0 -21
  1882. data/.rubocop.yml +0 -18
  1883. data/PUBLISH.md +0 -20
  1884. data/bin/console +0 -14
  1885. data/bin/setup +0 -8
  1886. data/lib/plaid/client.rb +0 -190
  1887. data/lib/plaid/errors.rb +0 -89
  1888. data/lib/plaid/middleware.rb +0 -31
  1889. data/lib/plaid/models.rb +0 -2221
  1890. data/lib/plaid/products/accounts.rb +0 -63
  1891. data/lib/plaid/products/asset_report.rb +0 -199
  1892. data/lib/plaid/products/auth.rb +0 -42
  1893. data/lib/plaid/products/base_product.rb +0 -64
  1894. data/lib/plaid/products/categories.rb +0 -21
  1895. data/lib/plaid/products/credit_details.rb +0 -40
  1896. data/lib/plaid/products/deposit_switch.rb +0 -99
  1897. data/lib/plaid/products/identity.rb +0 -31
  1898. data/lib/plaid/products/income.rb +0 -31
  1899. data/lib/plaid/products/institutions.rb +0 -91
  1900. data/lib/plaid/products/investments.rb +0 -127
  1901. data/lib/plaid/products/item.rb +0 -209
  1902. data/lib/plaid/products/liabilities.rb +0 -39
  1903. data/lib/plaid/products/link_token.rb +0 -74
  1904. data/lib/plaid/products/payment_initiation.rb +0 -251
  1905. data/lib/plaid/products/processor.rb +0 -190
  1906. data/lib/plaid/products/sandbox.rb +0 -148
  1907. data/lib/plaid/products/transactions.rb +0 -81
  1908. data/lib/plaid/products/webhooks.rb +0 -23
data/lib/plaid/models.rb DELETED
@@ -1,2221 +0,0 @@
1
- require 'hashie'
2
-
3
- module Plaid
4
- module Models
5
- # Internal: Base model for all other models.
6
- class BaseModel < Hashie::Dash
7
- include Hashie::Extensions::Dash::IndifferentAccess
8
- include Hashie::Extensions::Dash::Coercion
9
-
10
- @ignored_properties = []
11
-
12
- def self.property_ignored?(property)
13
- if defined? @ignored_properties
14
- @ignored_properties.include?(property)
15
- else
16
- false
17
- end
18
- end
19
-
20
- # Internal: Be strict or forgiving depending on Plaid.relaxed_models
21
- # value.
22
- def assert_property_exists!(property)
23
- super unless Plaid.relaxed_models? ||
24
- self.class.property_ignored?(property)
25
- end
26
- end
27
-
28
- # Internal: Base API response.
29
- class BaseResponse < BaseModel
30
- ##
31
- # :attr_reader:
32
- # Public: The String request ID assigned by the API.
33
- property :request_id
34
- end
35
-
36
- # Internal: Base error.
37
- class BaseError < BaseModel
38
- ##
39
- # :attr_reader:
40
- # Public: The String broad categorization of the error. One of:
41
- # 'INVALID_REQUEST', 'INVALID_INPUT', 'RATE_LIMIT_EXCEEDED', 'API_ERROR',
42
- # or 'ITEM_ERROR'.
43
- property :error_type
44
-
45
- ##
46
- # :attr_reader:
47
- # Public: The particular String error code. Each error_type has a
48
- # specific set of error_codes.
49
- property :error_code
50
-
51
- ##
52
- # :attr_reader:
53
- # Public: A developer-friendly representation of the error message.
54
- property :error_message
55
-
56
- ##
57
- # :attr_reader:
58
- # Public: A user-friendly representation of the error message. nil if the
59
- # error is not related to user action.
60
- property :display_message
61
- end
62
-
63
- # Public: A representation of a cause.
64
- class Cause < BaseError
65
- ##
66
- # :attr_reader:
67
- # Public: The item ID.
68
- property :item_id
69
- end
70
-
71
- # Public: A representation of an error.
72
- class Error < BaseError
73
- ##
74
- # :attr_reader:
75
- # Public: A list of reasons explaining why the error happened.
76
- property :causes, coerce: Array[Cause]
77
- end
78
-
79
- # Public: A representation of a warning.
80
- class Warning < BaseModel
81
- ##
82
- # :attr_reader:
83
- # Public: The type of warning.
84
- property :warning_type
85
-
86
- ##
87
- # :attr_reader:
88
- # Public: The warning code.
89
- property :warning_code
90
-
91
- ##
92
- # :attr_reader:
93
- # Public: The underlying cause.
94
- property :cause, coerce: Cause
95
- end
96
-
97
- # Public: A representation of an item.
98
- class Item < BaseModel
99
- ##
100
- # :attr_reader:
101
- # Public: The Array with String products available for this item
102
- # (e.g. ["balance", "auth"]).
103
- property :available_products
104
-
105
- ##
106
- # :attr_reader:
107
- # Public: The Array with String products billed for this item
108
- # (e.g. ["identity", "transactions"]).
109
- property :billed_products
110
-
111
- ##
112
- # :attr_reader:
113
- # Public: The String error related to
114
- property :error, coerce: Error
115
-
116
- ##
117
- # :attr_reader:
118
- # Public: The String institution ID for this item.
119
- property :institution_id
120
-
121
- ##
122
- # :attr_reader:
123
- # Public: The String item ID.
124
- property :item_id
125
-
126
- ##
127
- # :attr_reader:
128
- # Public: The String update type.
129
- property :update_type
130
-
131
- ##
132
- # :attr_reader:
133
- # Public: The String webhook URL.
134
- property :webhook
135
-
136
- ##
137
- # :attr_reader:
138
- # Public: The String consent expiration timestamp (or nil)
139
- # (e.g. "2019-04-22T00:00:00Z").
140
- property :consent_expiration_time
141
-
142
- ##
143
- # :attr_reader:
144
- # Public: The String update type.
145
- property :update_type
146
- end
147
-
148
- # Public: A representation of Item webhook status
149
- class ItemStatusLastWebhook < BaseModel
150
- ##
151
- # :attr_reader:
152
- # Public: The String last code sent (or nil).
153
- # (e.g. "HISTORICAL_UPDATE").
154
- property :code_sent
155
-
156
- ##
157
- # :attr_reader:
158
- # Public: the String sent at date (or nil).
159
- # (e.g. "2019-04-22T00:00:00Z").
160
- property :sent_at
161
- end
162
-
163
- # Public: A representation of Item transaction update status
164
- class ItemStatusTransactions < BaseModel
165
- ##
166
- # :attr_reader:
167
- # Public: the String last failed update date (or nil).
168
- # (e.g. "2019-04-22T00:00:00Z").
169
- property :last_failed_update
170
-
171
- ##
172
- # :attr_reader:
173
- # Public: the String last successful update date (or nil).
174
- # (e.g. "2019-04-22T00:00:00Z").
175
- property :last_successful_update
176
- end
177
-
178
- # Public: A representation of Item investments update status
179
- class ItemStatusInvestments < BaseModel
180
- ##
181
- # :attr_reader:
182
- # Public: the String last failed update date (or nil).
183
- # (e.g. "2019-04-22T00:00:00Z").
184
- property :last_failed_update
185
-
186
- ##
187
- # :attr_reader:
188
- # Public: the String last successful update date (or nil).
189
- # (e.g. "2019-04-22T00:00:00Z").
190
- property :last_successful_update
191
- end
192
-
193
- # Public: A representation of Item status
194
- class ItemStatus < BaseModel
195
- ##
196
- # :attr_reader:
197
- # Public: The ItemStatusLastWebhook for this ItemStatus.
198
- property :last_webhook, coerce: ItemStatusLastWebhook
199
-
200
- ##
201
- # :attr_reader:
202
- # Public: The ItemStatusTransactions for this ItemStatus.
203
- property :transactions, coerce: ItemStatusTransactions
204
-
205
- ##
206
- # :attr_reader:
207
- # Public: The ItemStatusInvestments for this ItemStatus.
208
- property :investments, coerce: ItemStatusInvestments
209
- end
210
-
211
- # Public: A representation of account balances.
212
- class Balances < BaseModel
213
- ##
214
- # :attr_reader:
215
- # Public: The Numeric available balance (or nil).
216
- property :available
217
-
218
- ##
219
- # :attr_reader:
220
- # Public: The Numeric current balance (or nil).
221
- property :current
222
-
223
- ##
224
- # :attr_reader:
225
- # Public: The Numeric limit (or nil).
226
- property :limit
227
-
228
- ##
229
- # :attr_reader:
230
- # Public: The String ISO currency code for the amount
231
- property :iso_currency_code
232
-
233
- ##
234
- # :attr_reader:
235
- # Public: The String unofficial currency code for the amount
236
- property :unofficial_currency_code
237
- end
238
-
239
- # Public: A representation of an account.
240
- class Account < BaseModel
241
- ##
242
- # :attr_reader:
243
- # Public: The String account ID, e.g.
244
- # "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv".
245
- property :account_id
246
-
247
- ##
248
- # :attr_reader:
249
- # Public: Balances for this account.
250
- property :balances, coerce: Balances
251
-
252
- ##
253
- # :attr_reader:
254
- # Public: The String mask, e.g. "0000".
255
- property :mask
256
-
257
- ##
258
- # :attr_reader:
259
- # Public: The String account name, e.g. "Plaid Checking".
260
- property :name
261
-
262
- ##
263
- # :attr_reader:
264
- # Public: The String official account name, e.g. "Plaid Gold Checking".
265
- property :official_name
266
-
267
- ##
268
- # :attr_reader:
269
- # Public: The String type, e.g. "depository".
270
- property :type
271
-
272
- ##
273
- # :attr_reader:
274
- # Public: The String subtype, e.g. "checking".
275
- property :subtype
276
-
277
- ##
278
- # :attr_reader:
279
- # Public: The String verification status,
280
- # e.g "manually_verified" (optional).
281
- property :verification_status
282
- end
283
-
284
- # Public: A representation of an ACH account number.
285
- class NumberACH < BaseModel
286
- ##
287
- # :attr_reader:
288
- # Public: The String account number. E.g. "1111222233330000".
289
- property :account
290
-
291
- ##
292
- # :attr_reader:
293
- # Public: The String account ID. E.g.
294
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
295
- property :account_id
296
-
297
- ##
298
- # :attr_reader:
299
- # Public: The String routing number. E.g. "011401533".
300
- property :routing
301
-
302
- ##
303
- # :attr_reader:
304
- # Public: The String wire routing number. E.g. "021000021".
305
- property :wire_routing
306
- end
307
-
308
- # Public: A representation of an EFT (Canadian) account number.
309
- class NumberEFT < BaseModel
310
- ##
311
- # :attr_reader:
312
- # Public: The String account number. E.g. "1111222233330000".
313
- property :account
314
-
315
- ##
316
- # :attr_reader:
317
- # Public: The String account ID. E.g.
318
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
319
- property :account_id
320
-
321
- ##
322
- # :attr_reader:
323
- # Public: The String branch number. E.g. "021".
324
- property :branch
325
-
326
- ##
327
- # :attr_reader:
328
- # Public: The String institution number. E.g. "01140".
329
- property :institution
330
- end
331
-
332
- # Public: A representation of an International account number.
333
- class NumberInternational < BaseModel
334
- ##
335
- # :attr_reader:
336
- # Public: The String account ID. E.g.
337
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
338
- property :account_id
339
-
340
- ##
341
- # :attr_reader:
342
- # Public: The String International Bank Account Number (IBAN). E.g.
343
- # "GB33BUKB20201555555555".
344
- property :iban
345
-
346
- ##
347
- # :attr_reader:
348
- # Public: The String Bank Identifier Code (BIC). E.g. "BUKBGB22".
349
- property :bic
350
- end
351
-
352
- # Public: A representation of a BACS (British) account number.
353
- class NumberBACS < BaseModel
354
- ##
355
- # :attr_reader:
356
- # Public: The String account ID. E.g.
357
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
358
- property :account_id
359
-
360
- ##
361
- # :attr_reader:
362
- # Public: The String account number. E.g. "66374958".
363
- property :account
364
-
365
- ##
366
- # :attr_reader:
367
- # Public: The String sort code. E.g. "089999".
368
- property :sort_code
369
- end
370
-
371
- # Public: A representation of a Auth Numbers response
372
- class Numbers < BaseModel
373
- ##
374
- # :attr_reader:
375
- # Public: The Array of NumberACH.
376
- property :ach, coerce: Array[NumberACH]
377
-
378
- ##
379
- # :attr_reader:
380
- # Public: The Array of NumberEFT.
381
- property :eft, coerce: Array[NumberEFT]
382
-
383
- ##
384
- # :attr_reader:
385
- # Public: The Array of NumberInternational.
386
- property :international, coerce: Array[NumberInternational]
387
-
388
- ##
389
- # :attr_reader:
390
- # Public: The Array of NumberBACS.
391
- property :bacs, coerce: Array[NumberBACS]
392
- end
393
-
394
- # Public: A representation of a transaction category.
395
- class Category < BaseModel
396
- ##
397
- # :attr_reader:
398
- # Public: The String category ID. E.g. "10000000".
399
- property :category_id
400
-
401
- ##
402
- # :attr_reader:
403
- # Public: The Array of Strings category hierarchy.
404
- # E.g. ["Recreation", "Arts & Entertainment", "Circuses and Carnivals"].
405
- property :hierarchy
406
-
407
- ##
408
- # :attr_reader:
409
- # Public: The String category group. E.g. "place".
410
- property :group
411
- end
412
-
413
- # Public: A representation of a single Credit Details APR.
414
- class CreditDetailsAPR < BaseModel
415
- ##
416
- # :attr_reader:
417
- # Public: The Numeric APR (e.g. 0.125).
418
- property :apr
419
-
420
- ##
421
- # :attr_reader:
422
- # Public: The Numeric balance subject to APR (e.g. 1200).
423
- property :balance_subject_to_apr
424
-
425
- ##
426
- # :attr_reader:
427
- # Public: The Numeric interest charge amount (e.g. 150).
428
- property :interest_charge_amount
429
- end
430
-
431
- # Public: A representation of Credit Details APRs data.
432
- class CreditDetailsAPRs < BaseModel
433
- ##
434
- # :attr_reader:
435
- # Public: Balance transfers APR
436
- property :balance_transfers, coerce: CreditDetailsAPR
437
-
438
- ##
439
- # :attr_reader:
440
- # Public: Cash advances APR
441
- property :cash_advances, coerce: CreditDetailsAPR
442
-
443
- ##
444
- # :attr_reader:
445
- # Public: Purchases APR
446
- property :purchases, coerce: CreditDetailsAPR
447
- end
448
-
449
- # Public: A representation of Credit Details data.
450
- class CreditDetails < BaseModel
451
- ##
452
- # :attr_reader:
453
- # Public: The String account ID. E.g.
454
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
455
- property :account_id
456
-
457
- ##
458
- # :attr_reader:
459
- # Public: The APRs.
460
- property :aprs, coerce: CreditDetailsAPRs
461
-
462
- ##
463
- # :attr_reader:
464
- # Public: The Numeric last payment amount (e.g. 875).
465
- property :last_payment_amount
466
-
467
- ##
468
- # :attr_reader:
469
- # Public: The String last payment date. E.g. "2016-09-13T00:00:00Z".
470
- property :last_payment_date
471
-
472
- ##
473
- # :attr_reader:
474
- # Public: The Numeric last statement balance (e.g. 3450).
475
- property :last_statement_balance
476
-
477
- ##
478
- # :attr_reader:
479
- # Public: The String last statement date. E.g. "2016-10-01T00:00:00Z".
480
- property :last_statement_date
481
-
482
- ##
483
- # :attr_reader:
484
- # Public: The Numeric minimum payment amount (e.g. 800).
485
- property :minimum_payment_amount
486
-
487
- ##
488
- # :attr_reader:
489
- # Public: The String next bill due date. E.g. "2016-10-15T00:00:00Z".
490
- property :next_bill_due_date
491
- end
492
-
493
- # Public: A representation of Identity address details.
494
- class IdentityAddressData < BaseModel
495
- ##
496
- # :attr_reader:
497
- # Public: The String street name.
498
- property :street
499
-
500
- ##
501
- # :attr_reader:
502
- # Public: The String name.
503
- property :city
504
-
505
- ##
506
- # :attr_reader:
507
- # Public: The String region or state name.
508
- property :region
509
-
510
- ##
511
- # :attr_reader:
512
- # Public: The String postal code.
513
- property :postal_code
514
-
515
- ##
516
- # :attr_reader:
517
- # Public: The String country code.
518
- property :country
519
- end
520
-
521
- # Public: A representation of Identity address data.
522
- class IdentityAddress < BaseModel
523
- ##
524
- # :attr_reader:
525
- # Public: The Boolean primary flag (true if it's the primary address).
526
- property :primary
527
-
528
- ##
529
- # :attr_reader:
530
- # Public: The address data.
531
- property :data, coerce: IdentityAddressData
532
- end
533
-
534
- # Public: A representation of Identity email data.
535
- class IdentityEmail < BaseModel
536
- ##
537
- # :attr_reader:
538
- # Public: The String data, i.e. the address itself. E.g.
539
- # "accountholder0@example.com".
540
- property :data
541
-
542
- ##
543
- # :attr_reader:
544
- # Public: The Boolean primary flag.
545
- property :primary
546
-
547
- ##
548
- # :attr_reader:
549
- # Public: The String type. E.g. "primary", or "secondary", or "other".
550
- property :type
551
- end
552
-
553
- # Public: A representation of Identity phone number data.
554
- class IdentityPhoneNumber < BaseModel
555
- ##
556
- # :attr_reader:
557
- # Public: The String data, i.e. the number itself. E.g.
558
- # "4673956022".
559
- property :data
560
-
561
- ##
562
- # :attr_reader:
563
- # Public: The Boolean primary flag.
564
- property :primary
565
-
566
- ##
567
- # :attr_reader:
568
- # Public: The String type. E.g. "home", or "work", or "mobile1".
569
- property :type
570
- end
571
-
572
- # Public: A representation of Identity data.
573
- class Identity < BaseModel
574
- ##
575
- # :attr_reader:
576
- # Public: Addresses: Array of IdentityAddress.
577
- property :addresses, coerce: Array[IdentityAddress]
578
-
579
- ##
580
- # :attr_reader:
581
- # Public: Emails: Array of IdentityEmail.
582
- property :emails, coerce: Array[IdentityEmail]
583
-
584
- ##
585
- # :attr_reader:
586
- # Public: The Array of String names. E.g. ["John Doe", "Ronald McDonald"].
587
- property :names
588
-
589
- ##
590
- # :attr_reader:
591
- # Public: Phone numbers: Array of IdentityPhoneNumber.
592
- property :phone_numbers, coerce: Array[IdentityPhoneNumber]
593
- end
594
-
595
- # Public: A representation of Income Stream data.
596
- class IncomeStream < BaseModel
597
- ##
598
- # :attr_reader:
599
- # Public: The Numeric monthly income associated with the income stream.
600
- property :monthly_income
601
-
602
- ##
603
- # :attr_reader:
604
- # Public: The Numeric representation of our confidence in the income data
605
- # associated with this particular income stream, with 0 being the lowest
606
- # confidence and 1 being the highest.
607
- property :confidence
608
-
609
- ##
610
- # :attr_reader:
611
- # Public: The Numeric extent of data found for this income stream.
612
- property :days
613
-
614
- ##
615
- # :attr_reader:
616
- # Public: The String name of the entity associated with this income
617
- # stream.
618
- property :name
619
- end
620
-
621
- # Public: A representation of an account with owners
622
- class AccountWithOwners < Account
623
- ##
624
- # :attr_reader:
625
- # Public: The Array of owners.
626
- property :owners, coerce: Array[Identity]
627
- end
628
-
629
- # Public: A representation of Income data.
630
- class Income < BaseModel
631
- ##
632
- # :attr_reader:
633
- # Public: An Array of IncomeStream with detailed information.
634
- property :income_streams, coerce: Array[IncomeStream]
635
-
636
- ##
637
- # :attr_reader:
638
- # Public: The Numeric last year income, i.e. the sum of the Item's
639
- # income over the past 365 days. If Plaid has less than 365 days of data
640
- # this will be less than a full year's income.
641
- property :last_year_income
642
-
643
- ##
644
- # :attr_reader:
645
- # Public: The Numeric last_year_income interpolated to value before
646
- # taxes. This is the minimum pre-tax salary that assumes a filing status
647
- # of single with zero dependents.
648
- property :last_year_income_before_tax
649
-
650
- ##
651
- # :attr_reader:
652
- # Public: The Numeric income extrapolated over a year based on current,
653
- # active income streams. Income streams become inactive if they have not
654
- # recurred for more than two cycles. For example, if a weekly paycheck
655
- # hasn't been seen for the past two weeks, it is no longer active.
656
- property :projected_yearly_income
657
-
658
- ##
659
- # :attr_reader:
660
- # Public: The Numeric projected_yearly_income interpolated to value
661
- # before taxes. This is the minimum pre-tax salary that assumes a filing
662
- # status of single with zero dependents.
663
- property :projected_yearly_income_before_tax
664
-
665
- ##
666
- # :attr_reader:
667
- # Public: The Numeric max number of income streams present at the same
668
- # time over the past 365 days.
669
- property :max_number_of_overlapping_income_streams
670
-
671
- ##
672
- # :attr_reader:
673
- # Public: The Numeric total number of distinct income streams received
674
- # over the past 365 days.
675
- property :number_of_income_streams
676
- end
677
-
678
- # Public: A representation of an institution login credential.
679
- class InstitutionCredential < BaseModel
680
- @ignored_properties = ['flexible_input_spec']
681
-
682
- ##
683
- # :attr_reader:
684
- # Public: The String label. E.g. "User ID".
685
- property :label
686
-
687
- ##
688
- # :attr_reader:
689
- # Public: The String name. E.g. "username".
690
- property :name
691
-
692
- ##
693
- # :attr_reader:
694
- # Public: The String type. E.g. "text", or "password".
695
- property :type
696
- end
697
-
698
- # Public: A representation of Institution status breakdown.
699
- class InstitutionStatusBreakdown < BaseModel
700
- ##
701
- # :attr_reader:
702
- # Public: The Numeric success percentage.
703
- # (e.g. 0.970)
704
- property :success
705
-
706
- ##
707
- # :attr_reader:
708
- # Public: The Numeric Plaid error percentage.
709
- # (e.g. 0.010)
710
- property :error_plaid
711
-
712
- ##
713
- # :attr_reader:
714
- # Public: The Numeric Institution error percentage.
715
- # (e.g. 0.020)
716
- property :error_institution
717
- end
718
-
719
- # Public: A representation of Institution item logins status.
720
- class InstitutionStatusItemLogins < BaseModel
721
- ##
722
- # :attr_reader:
723
- # Public: The String last status change date.
724
- # (e.g. "2019-04-22T20:52:00Z")
725
- property :last_status_change
726
-
727
- ##
728
- # :attr_reader:
729
- # Public: The String status.
730
- # (e.g. one of "HEALTHY"|"DEGRADED"|"DOWN")
731
- property :status
732
-
733
- ##
734
- # :attr_reader:
735
- # Public: The breakdown for this Institution status.
736
- property :breakdown, coerce: InstitutionStatusBreakdown
737
- end
738
-
739
- # Public: A representation of Institution status.
740
- class InstitutionStatus < BaseModel
741
- ##
742
- # :attr_reader:
743
- # Public: The Item logins status for this InstitutionStatus.
744
- property :item_logins, coerce: InstitutionStatusItemLogins
745
- end
746
-
747
- # Public: A representation of standing order metadata for an institution.
748
- class StandingOrderMetadata < BaseModel
749
- ##
750
- # :attr_reader:
751
- # Public: The Boolean flag indicating if the institution supports
752
- # end date for standing orders.
753
- property :supports_standing_order_end_date
754
-
755
- ##
756
- # :attr_reader:
757
- # Public: The Boolean flag indicating if the institution supports
758
- # negative execution days for standing orders.
759
- property :supports_standing_order_negative_execution_days
760
-
761
- ##
762
- # :attr_reader:
763
- # Public: The Array of valid standing order intervals for
764
- # this institution.
765
- # E.g. ["WEEKLY", "MONTHLY"].
766
- property :valid_standing_order_intervals
767
- end
768
-
769
- # Public: A representation of an institution's payment initiation metadata.
770
- class InstitutionPaymentInitiationMetadata < BaseModel
771
- ##
772
- # :attr_reader:
773
- # Public: The map of maximum payment amount per currency for this
774
- # institution.
775
- # E.g. {"GBP"=>"1000000"}.
776
- property :maximum_payment_amount
777
-
778
- ##
779
- # :attr_reader:
780
- # Public: The standing order metadata for this institution.
781
- property :standing_order_metadata, coerce: StandingOrderMetadata
782
-
783
- ##
784
- # :attr_reader:
785
- # Public: The Boolean flag indicating if the institution supports
786
- # international payments.
787
- property :supports_international_payments
788
-
789
- ##
790
- # :attr_reader:
791
- # Public: The Boolean flag indicating if the institution supports
792
- # refund details.
793
- property :supports_refund_details
794
- end
795
-
796
- # Public: A representation of Institution.
797
- class Institution < BaseModel
798
- @ignored_properties = ['input_spec']
799
-
800
- ##
801
- # :attr_reader:
802
- # Public: The Array of InstitutionCredential, presenting information on
803
- # login credentials used for the institution.
804
- property :credentials, coerce: Array[InstitutionCredential]
805
-
806
- ##
807
- # :attr_reader:
808
- # Public: The Boolean flag indicating if the institution uses MFA.
809
- property :has_mfa
810
-
811
- ##
812
- # :attr_reader:
813
- # Public: The String reflecting the MFA code type ("numeric" /
814
- # "alphanumeric")
815
- property :mfa_code_type
816
-
817
- ##
818
- # :attr_reader:
819
- # Public: The String institution ID (e.g. "ins_109512").
820
- property :institution_id
821
-
822
- ##
823
- # :attr_reader:
824
- # Public: The String institution name (e.g. "Houndstooth Bank").
825
- property :name
826
-
827
- ##
828
- # :attr_reader:
829
- # Public: The Array of String MFA types.
830
- # E.g. ["code", "list", "questions", "selections"].
831
- property :mfa
832
-
833
- ##
834
- # :attr_reader:
835
- # Public: The Array of String product names supported by this institution.
836
- # E.g. ["auth", "balance", "identity", "transactions"].
837
- property :products
838
-
839
- ##
840
- # :attr_reader:
841
- # Public: The Array of String country codes supported by this institution.
842
- # E.g. ["US", "GB"].
843
- property :country_codes
844
-
845
- ##
846
- # :attr_reader:
847
- # Public: The String primary color for this institution (e.g. "#095aa6").
848
- property :primary_color
849
-
850
- ##
851
- # :attr_reader:
852
- # Public: The String base 64 encoded logo for this institution.
853
- property :logo
854
-
855
- ##
856
- # :attr_reader:
857
- # Public: The String base 64 encoded url for this institution
858
- # E.g. "https://www.plaid.com").
859
- property :url
860
-
861
- ##
862
- # :attr_reader:
863
- # Public: The Status for this Institution (or nil).
864
- property :status, coerce: InstitutionStatus
865
-
866
- ##
867
- # :attr_reader:
868
- # Public: The Array of String country codes supported by this institution.
869
- property :country_codes
870
-
871
- ##
872
- # :attr_reader:
873
- # Public: The array of routing numbers associated with this institution.
874
- property :routing_numbers
875
-
876
- ##
877
- # :attr_reader:
878
- # Public: Indicates that the institution has an OAuth login flow.
879
- property :oauth
880
-
881
- ##
882
- # :attr_reader:
883
- # Public: Specifies metadata related to the payment_initiation product
884
- # (or nil).
885
- property :payment_initiation_metadata,
886
- coerce: InstitutionPaymentInitiationMetadata
887
- end
888
-
889
- module MFA
890
- # Public: A representation of an MFA device.
891
- class Device < BaseModel
892
- ##
893
- # :attr_reader:
894
- # Public: The String message related to sending code to the device.
895
- property :display_message
896
- end
897
-
898
- # Public: A representation of a single element in a device list.
899
- class DeviceListElement < BaseModel
900
- ##
901
- # :attr_reader:
902
- # Public: The String device ID.
903
- property :device_id
904
-
905
- ##
906
- # :attr_reader:
907
- # Public: The String device mask.
908
- property :mask
909
-
910
- ##
911
- # :attr_reader:
912
- # Public: The String device type.
913
- property :type
914
- end
915
-
916
- # Public: A representation of MFA selection.
917
- class Selection < BaseModel
918
- ##
919
- # :attr_reader:
920
- # Public: The String question.
921
- property :question
922
-
923
- ##
924
- # :attr_reader:
925
- # Public: The Array of String answers.
926
- property :answers
927
- end
928
- end
929
-
930
- # Public: A representation of Transaction location.
931
- class TransactionLocation < BaseModel
932
- ##
933
- # :attr_reader:
934
- # Public: The String address (or nil).
935
- property :address
936
-
937
- ##
938
- # :attr_reader:
939
- # Public: The String city name (or nil).
940
- property :city
941
-
942
- ##
943
- # :attr_reader:
944
- # Public: The Numeric latitude of the place (or nil).
945
- property :lat
946
-
947
- ##
948
- # :attr_reader:
949
- # Public: The Numeric longitude of the place (or nil).
950
- property :lon
951
-
952
- ##
953
- # :attr_reader:
954
- # Public: The String region or state name (or nil).
955
- property :region
956
-
957
- ##
958
- # :attr_reader:
959
- # Public: The String store number (or nil).
960
- property :store_number
961
-
962
- ##
963
- # :attr_reader:
964
- # Public: The String postal code (or nil).
965
- property :postal_code
966
-
967
- ##
968
- # :attr_reader:
969
- # Public: The country code (or nil).
970
- property :country
971
- end
972
-
973
- # Public: A representation of Transaction Payment meta information.
974
- class TransactionPaymentMeta < BaseModel
975
- ##
976
- # :attr_reader:
977
- property :by_order_of
978
- ##
979
- # :attr_reader:
980
- property :ppd_id
981
- ##
982
- # :attr_reader:
983
- property :payee
984
- ##
985
- # :attr_reader:
986
- property :payer
987
- ##
988
- # :attr_reader:
989
- property :payment_method
990
- ##
991
- # :attr_reader:
992
- property :payment_processor
993
- ##
994
- # :attr_reader:
995
- property :reason
996
- ##
997
- # :attr_reader:
998
- property :reference_number
999
- end
1000
-
1001
- # Public: A representation of Transaction.
1002
- class Transaction < BaseModel
1003
- ##
1004
- # :attr_reader:
1005
- # Public: The String transaction ID.
1006
- property :transaction_id
1007
-
1008
- ##
1009
- # :attr_reader:
1010
- # Public: The String account ID.
1011
- property :account_id
1012
-
1013
- ##
1014
- # :attr_reader:
1015
- # Public: The String account owner (or nil).
1016
- property :account_owner
1017
-
1018
- ##
1019
- # :attr_reader:
1020
- # Public: The Numeric amount (or nil).
1021
- property :amount
1022
-
1023
- ##
1024
- # :attr_reader:
1025
- # Public: The Array of String category (or nil).
1026
- # E.g. ["Payment", "Credit Card"].
1027
- property :category
1028
-
1029
- ##
1030
- # :attr_reader:
1031
- # Public: The String category_id (or nil).
1032
- # E.g. "16001000".
1033
- property :category_id
1034
-
1035
- ##
1036
- # :attr_reader:
1037
- # Public: The String transaction date. E.g. "2017-01-01".
1038
- property :date
1039
-
1040
- ##
1041
- # :attr_reader:
1042
- # Public: The location where transaction occurred (TransactionLocation).
1043
- property :location, coerce: TransactionLocation
1044
-
1045
- ##
1046
- # :attr_reader:
1047
- # Public: The String merchant name (or nil).
1048
- # E.g. "Burger King".
1049
- property :merchant_name
1050
-
1051
- ##
1052
- # :attr_reader:
1053
- # Public: The String transaction name (or nil).
1054
- # E.g. "CREDIT CARD 3333 PAYMENT *//".
1055
- property :name
1056
-
1057
- ##
1058
- # :attr_reader:
1059
- # Public: The String original description (or nil).
1060
- property :original_description
1061
-
1062
- ##
1063
- # :attr_reader:
1064
- # Public: The payment meta information (TransactionPaymentMeta).
1065
- property :payment_meta, coerce: TransactionPaymentMeta
1066
-
1067
- ##
1068
- # :attr_reader:
1069
- # Public: The Boolean pending flag (or nil).
1070
- property :pending
1071
-
1072
- ##
1073
- # :attr_reader:
1074
- # Public: The String pending transaction ID (or nil).
1075
- property :pending_transaction_id
1076
-
1077
- ##
1078
- # :attr_reader:
1079
- # Public: The String transaction type (or nil). E.g. "special", or
1080
- # "place".
1081
- property :transaction_type
1082
-
1083
- ##
1084
- # :attr_reader:
1085
- # Public: The String ISO currency code for the amount
1086
- property :iso_currency_code
1087
-
1088
- ##
1089
- # :attr_reader:
1090
- # Public: The String unofficial currency code for the amount
1091
- property :unofficial_currency_code
1092
-
1093
- ##
1094
- # :attr_reader:
1095
- # Public: The String channel used to make a payment, e.g.
1096
- # "online", "in store", or "other".
1097
- property :payment_channel
1098
-
1099
- ##
1100
- # :attr_reader:
1101
- # Public: The String date that the transaction was authorized,
1102
- # e.g. "2017-01-01".
1103
- property :authorized_date
1104
-
1105
- ##
1106
- # :attr_reader:
1107
- # Public: The String transaction code, e.g. "direct debit".
1108
- property :transaction_code
1109
- end
1110
-
1111
- # Public: A representation of an InvestmentTransaction in an investment
1112
- # account.
1113
- class InvestmentTransaction < BaseModel
1114
- ##
1115
- # :attr_reader:
1116
- # Public: The String investment transaction ID.
1117
- property :investment_transaction_id
1118
-
1119
- ##
1120
- # :attr_reader:
1121
- # Public: The String account ID.
1122
- property :account_id
1123
-
1124
- ##
1125
- # :attr_reader:
1126
- # Public: The String security ID.
1127
- property :security_id
1128
-
1129
- ##
1130
- # :attr_reader:
1131
- # Public: The String transaction date. E.g. "2017-01-01".
1132
- property :date
1133
-
1134
- ##
1135
- # :attr_reader:
1136
- # Public: The String transaction name (or nil).
1137
- # E.g. "CREDIT CARD 3333 PAYMENT *//".
1138
- property :name
1139
-
1140
- ##
1141
- # :attr_reader:
1142
- # Public: The Numeric quantity of the security involved (if applicable).
1143
- property :quantity
1144
-
1145
- ##
1146
- # :attr_reader:
1147
- # Public: The Numeric amount (or nil).
1148
- property :amount
1149
-
1150
- ##
1151
- # :attr_reader:
1152
- # Public: The Numeric price of the security that was used for the trade
1153
- # (if applicable).
1154
- property :price
1155
-
1156
- ##
1157
- # :attr_reader:
1158
- # Public: The Numeric fee amount.
1159
- property :fees
1160
-
1161
- ##
1162
- # :attr_reader:
1163
- # Public: The String transaction type (or nil). E.g. "buy" or "sell".
1164
- property :type
1165
-
1166
- ##
1167
- # :attr_reader:
1168
- # Public: The String transaction type (or nil). E.g. "buy" or "sell".
1169
- property :subtype
1170
-
1171
- ##
1172
- # :attr_reader:
1173
- # Public: The ISO currency code of the transaction, either USD or CAD.
1174
- # Always nil if unofficial_currency_code is non-nil.
1175
- property :iso_currency_code
1176
-
1177
- ##
1178
- # :attr_reader:
1179
- # Public: The unofficial currency code associated with the transaction.
1180
- # Always nil if iso_currency_code is non-nil.
1181
- property :unofficial_currency_code
1182
-
1183
- ##
1184
- # :attr_reader:
1185
- # Public: Present if the transaction class is cancel, and indicates the
1186
- # ID of the transaction which was cancelled.
1187
- property :cancel_transaction_id
1188
- end
1189
-
1190
- # Public: A representation of a Holding in an investment account.
1191
- class Holding < BaseModel
1192
- ##
1193
- # :attr_reader:
1194
- # Public: The String account ID.
1195
- property :account_id
1196
-
1197
- ##
1198
- # :attr_reader:
1199
- # Public: The String security ID.
1200
- property :security_id
1201
-
1202
- ##
1203
- # :attr_reader:
1204
- # Public: The Numeric value of the holding (price * quantity) as reported
1205
- # by the institution.
1206
- property :institution_value
1207
-
1208
- ##
1209
- # :attr_reader:
1210
- # Public: The Numeric price of the holding as reported by the institution.
1211
- property :institution_price
1212
-
1213
- ##
1214
- # :attr_reader:
1215
- # Public: The Numeric quantity.
1216
- property :quantity
1217
-
1218
- ##
1219
- # :attr_reader:
1220
- # Public: The String date when the price reported by the institution was
1221
- # current. E.g. "2017-01-01".
1222
- property :institution_price_as_of
1223
-
1224
- ##
1225
- # :attr_reader:
1226
- # Public: The Numeric cost basis.
1227
- property :cost_basis
1228
-
1229
- ##
1230
- # :attr_reader:
1231
- # Public: The ISO currency code of the holding, either USD or CAD.
1232
- # Always nil if unofficial_currency_code is non-nil.
1233
- property :iso_currency_code
1234
-
1235
- ##
1236
- # :attr_reader:
1237
- # Public: The unofficial currency code associated with the holding.
1238
- # Always nil if iso_currency_code is non-nil.
1239
- property :unofficial_currency_code
1240
- end
1241
-
1242
- # Public: A representation of a Security.
1243
- class Security < BaseModel
1244
- ##
1245
- # :attr_reader:
1246
- # Public: The String security ID.
1247
- property :security_id
1248
-
1249
- ##
1250
- # :attr_reader:
1251
- # Public: The String CUSIP identitfier of this security.
1252
- property :cusip
1253
-
1254
- ##
1255
- # :attr_reader:
1256
- # Public: The String SEDOL identifier of this security.
1257
- property :sedol
1258
-
1259
- ##
1260
- # :attr_reader:
1261
- # Public: The String ISIN identifier of this security.
1262
- property :isin
1263
-
1264
- ##
1265
- # :attr_reader:
1266
- # Public: The String ID of this security as reported by the institution.
1267
- property :institution_security_id
1268
-
1269
- ##
1270
- # :attr_reader:
1271
- # Public: The String institution ID (if institution_security_id is set).
1272
- property :institution_id
1273
-
1274
- ##
1275
- # :attr_reader:
1276
- # Public: The String security ID of the proxied security.
1277
- property :proxy_security_id
1278
-
1279
- ##
1280
- # :attr_reader:
1281
- # Public: The String security name.
1282
- property :name
1283
-
1284
- ##
1285
- # :attr_reader:
1286
- # Public: The String ticker symbol.
1287
- property :ticker_symbol
1288
-
1289
- ##
1290
- # :attr_reader:
1291
- # Public: The Boolean flag indicating whether this security is
1292
- # cash-equivalent.
1293
- property :is_cash_equivalent
1294
-
1295
- ##
1296
- # :attr_reader:
1297
- # Public: The String Type.
1298
- property :type
1299
-
1300
- ##
1301
- # :attr_reader:
1302
- # Public: The Numeric close price.
1303
- property :close_price
1304
-
1305
- ##
1306
- # :attr_reader:
1307
- # Public: The String date when the close price was current.
1308
- property :close_price_as_of
1309
-
1310
- ##
1311
- # :attr_reader:
1312
- # Public: The ISO currency code of the security, either USD or CAD.
1313
- # Always nil if unofficial_currency_code is non-nil.
1314
- property :iso_currency_code
1315
-
1316
- ##
1317
- # :attr_reader:
1318
- # Public: The unofficial currency code associated with the security.
1319
- # Always nil if iso_currency_code is non-nil.
1320
- property :unofficial_currency_code
1321
- end
1322
-
1323
- # Public: A representation of an asset report owner.
1324
- class AssetReportOwner < BaseModel
1325
- ##
1326
- # :attr_reader:
1327
- # Public: A list of names associated with the account by the financial
1328
- # institution.
1329
- property :names, coerce: Array[String]
1330
-
1331
- ##
1332
- # :attr_reader:
1333
- # Public: A list of phone numbers associated with the account by the
1334
- # financial institution; see IdentityPhoneNumber number object for
1335
- # fields.
1336
- property :phone_numbers, coerce: Array[IdentityPhoneNumber]
1337
-
1338
- ##
1339
- # :attr_reader:
1340
- # Public: A list of emails associated with the account by the financial
1341
- # institution; see IdentityEmail object for fields.
1342
- property :emails, coerce: Array[IdentityEmail]
1343
-
1344
- ##
1345
- # :attr_reader:
1346
- # Public: Data about the various addresses associated with the account
1347
- # by the financial institution; see IdentityAddress object for fields.
1348
- property :addresses, coerce: Array[IdentityAddress]
1349
- end
1350
-
1351
- # Public: A representation of an asset report balance.
1352
- class AssetReportBalance < BaseModel
1353
- ##
1354
- # :attr_reader:
1355
- # Public: The available balance as reported by the financial institution.
1356
- # This is usually, but not always, the current balance less any
1357
- # outstanding holds or debits that have not yet posted to the account.
1358
- property :available
1359
-
1360
- ##
1361
- # :attr_reader:
1362
- # Public: The total amount of funds in the account.
1363
- property :current
1364
-
1365
- ##
1366
- # :attr_reader:
1367
- # Public: The ISO currency code of the transaction, either USD or CAD.
1368
- # Always nil if unofficial_currency_code is non-nil.
1369
- property :iso_currency_code
1370
-
1371
- ##
1372
- # :attr_reader:
1373
- # Public: The unofficial currency code associated with the transaction.
1374
- # Always nil if iso_currency_code is non-nil.
1375
- property :unofficial_currency_code
1376
- end
1377
-
1378
- # Public: A representation of an asset report historical balance.
1379
- class AssetReportHistoricalBalance < BaseModel
1380
- ##
1381
- # :attr_reader:
1382
- # Public: The date of the calculated historical balance.
1383
- property :date
1384
-
1385
- ##
1386
- # :attr_reader:
1387
- # Public: The total amount of funds in the account, calculated from the
1388
- # current balance in the balance object by subtracting inflows and adding
1389
- # back outflows according to the posted date of each.
1390
- property :current
1391
-
1392
- ##
1393
- # :attr_reader:
1394
- # Public: The ISO currency code of the transaction, either USD or CAD.
1395
- # Always nil if unofficial_currency_code is non-nil.
1396
- property :iso_currency_code
1397
-
1398
- ##
1399
- # :attr_reader:
1400
- # Public: The unofficial currency code associated with the transaction.
1401
- # Always nil if iso_currency_code is non-nil.
1402
- property :unofficial_currency_code
1403
- end
1404
-
1405
- # Public: A representation of an asset report transaction.
1406
- class AssetReportTransaction < BaseModel
1407
- ##
1408
- # :attr_reader:
1409
- # Public: Plaid's unique identifier for the account.
1410
- property :account_id
1411
-
1412
- ##
1413
- # :attr_reader:
1414
- # Public: Plaid's unique identifier for the transaction.
1415
- property :transaction_id
1416
-
1417
- ##
1418
- # :attr_reader:
1419
- # Public: For pending transactions, Plaid returns the date the
1420
- # transaction occurred; for posted transactions, Plaid returns the date
1421
- # the transaction posts; both dates are returned in an ISO 8601 format
1422
- # (YYYY-MM-DD).
1423
- property :date
1424
-
1425
- ##
1426
- # :attr_reader:
1427
- # Public: The string returned by the financial institution to describe
1428
- # the transaction.
1429
- property :original_description
1430
-
1431
- ##
1432
- # :attr_reader:
1433
- # Public: When true, identifies the transaction as pending or unsettled;
1434
- # pending transaction details (description, amount) may change before
1435
- # they are settled.
1436
- property :pending
1437
-
1438
- ##
1439
- # :attr_reader:
1440
- # Public: The settled dollar value; positive values when money moves out
1441
- # of the account, negative values when money moves in.
1442
- property :amount
1443
-
1444
- ##
1445
- # :attr_reader:
1446
- # Public: The ISO currency code of the transaction, either USD or CAD.
1447
- # Always nil if unofficial_currency_code is non-nil.
1448
- property :iso_currency_code
1449
-
1450
- ##
1451
- # :attr_reader:
1452
- # Public: The unofficial currency code associated with the transaction.
1453
- # Always nil if iso_currency_code is non-nil.
1454
- property :unofficial_currency_code
1455
-
1456
- ##
1457
- # :attr_reader: Public: The String account owner (or nil). This field
1458
- # only appears in an Asset Report with Insights.
1459
- property :account_owner
1460
-
1461
- ##
1462
- # :attr_reader: Public: The Array of String category (or nil). This field
1463
- # only appears in an Asset Report with Insights. E.g. ["Payment", "Credit
1464
- # Card"].
1465
- property :category
1466
-
1467
- ##
1468
- # :attr_reader: Public: The String category_id (or nil). This field only
1469
- # appears in an Asset Report with Insights. E.g. "16001000".
1470
- property :category_id
1471
-
1472
- ##
1473
- # :attr_reader: Public: The String date of the transaction (or nil). This
1474
- # field only appears in an Asset Report with Insights.
1475
- property :date_transacted
1476
-
1477
- ##
1478
- # :attr_reader: Public: The location where transaction occurred
1479
- # (TransactionLocation). This field only appears in an Asset Report with
1480
- # Insights.
1481
- property :location, coerce: TransactionLocation
1482
-
1483
- ##
1484
- # :attr_reader: Public: The String transaction name (or nil). This field
1485
- # only appears in an Asset Report with Insights. E.g. "CREDIT CARD 3333
1486
- # PAYMENT *//".
1487
- property :name
1488
-
1489
- ##
1490
- # :attr_reader: Public: The payment meta information
1491
- # (TransactionPaymentMeta). This field only appears in an Asset Report
1492
- # with Insights.
1493
- property :payment_meta, coerce: TransactionPaymentMeta
1494
-
1495
- ##
1496
- # :attr_reader: Public: The String pending transaction ID (or nil). This
1497
- # field only appears in an Asset Report with Insights.
1498
- property :pending_transaction_id
1499
-
1500
- ##
1501
- # :attr_reader: Public: The String transaction type (or nil). E.g.
1502
- # "special", or "place". This field only appears in an Asset Report with
1503
- # Insights.
1504
- property :transaction_type
1505
- end
1506
-
1507
- # Public: A representation of an asset report account.
1508
- class AssetReportAccount < BaseModel
1509
- ##
1510
- # :attr_reader:
1511
- # Public: Plaid's unique identifier for the account.
1512
- property :account_id
1513
-
1514
- ##
1515
- # :attr_reader:
1516
- # Public: The last 2-5 digits of the account's number.
1517
- property :mask
1518
-
1519
- ##
1520
- # :attr_reader:
1521
- # Public: The name of the account, either assigned by the user or by the
1522
- # financial institution itself.
1523
- property :name
1524
-
1525
- ##
1526
- # :attr_reader:
1527
- # Public: The official name of the account as given by the financial
1528
- # institution.
1529
- property :official_name
1530
-
1531
- ##
1532
- # :attr_reader:
1533
- # Public: The primary type of the account (e.g., "depository").
1534
- property :type
1535
-
1536
- ##
1537
- # :attr_reader:
1538
- # Public: The secondary type of the account (e.g., "checking").
1539
- property :subtype
1540
-
1541
- ##
1542
- # :attr_reader:
1543
- # Public: Data returned by the financial institution about the account
1544
- # owner or owners; see AssetReportOwner object for fields.
1545
- property :owners, coerce: Array[AssetReportOwner]
1546
-
1547
- ##
1548
- # :attr_reader:
1549
- # Public: Data about the various balances on the account; see
1550
- # AssetReportBalance object for fields.
1551
- property :balances, coerce: AssetReportBalance
1552
-
1553
- ##
1554
- # :attr_reader:
1555
- # Public: Calculated data about the historical balances on the account;
1556
- # see AssetReportHistoricalBalance object for fields.
1557
- property :historical_balances, coerce: Array[AssetReportHistoricalBalance]
1558
-
1559
- ##
1560
- # :attr_reader:
1561
- # Public: Data about the transactions.
1562
- property :transactions, coerce: Array[AssetReportTransaction]
1563
-
1564
- ##
1565
- # :attr_reader:
1566
- # Public: The duration of transaction history available for this Item,
1567
- # typically defined as the time since the date of the earliest
1568
- # transaction in that account.
1569
- property :days_available
1570
- end
1571
-
1572
- # Public: A representation of an asset report item.
1573
- class AssetReportItem < BaseModel
1574
- ##
1575
- # :attr_reader:
1576
- # Public: Plaid's unique identifier for the Item.
1577
- property :item_id
1578
-
1579
- ##
1580
- # :attr_reader:
1581
- # Public: The full financial institution name associated with the Item.
1582
- property :institution_name
1583
-
1584
- ##
1585
- # :attr_reader:
1586
- # Public: The financial institution associated with the Item.
1587
- property :institution_id
1588
-
1589
- ##
1590
- # :attr_reader:
1591
- # Public: The date and time when this Item's data was retrieved from the
1592
- # financial institution.
1593
- property :date_last_updated
1594
-
1595
- ##
1596
- # :attr_reader:
1597
- # Public: Data about each of the accounts open on the Item; see Account
1598
- # object for fields.
1599
- property :accounts, coerce: Array[AssetReportAccount]
1600
- end
1601
-
1602
- # Public: A representation of an asset report user.
1603
- class AssetReportUser < BaseModel
1604
- ##
1605
- # :attr_reader:
1606
- # Public: An identifier you determine and submit for the user.
1607
- property :client_user_id
1608
-
1609
- ##
1610
- # :attr_reader:
1611
- # Public: The user's first name.
1612
- property :first_name
1613
-
1614
- ##
1615
- # :attr_reader:
1616
- # Public: The user's middle name.
1617
- property :middle_name
1618
-
1619
- ##
1620
- # :attr_reader:
1621
- # Public: The user's last name.
1622
- property :last_name
1623
-
1624
- ##
1625
- # :attr_reader:
1626
- # Public: The user's social security number. Format:
1627
- # "\d\d\d-\d\d-\d\d\d\d".
1628
- property :ssn
1629
-
1630
- ##
1631
- # :attr_reader:
1632
- # Public: The user's phone number Format:
1633
- # "+{country_code}{area code and subscriber number}", e.g.
1634
- # "+14155555555" (known as E.164 format)
1635
- property :phone_number
1636
-
1637
- ##
1638
- # :attr_reader:
1639
- # Public: The user's email address.
1640
- property :email
1641
- end
1642
-
1643
- # Public: A representation of an asset report.
1644
- class AssetReport < BaseModel
1645
- ##
1646
- # :attr_reader:
1647
- # Public: Plaid's unique identifier for this asset report.
1648
- property :asset_report_id
1649
-
1650
- ##
1651
- # :attr_reader:
1652
- # Public: An identifier you determine and submit for the Asset Report.
1653
- property :client_report_id
1654
-
1655
- ##
1656
- # :attr_reader:
1657
- # Public: The date and time when the Asset Report was created.
1658
- property :date_generated
1659
-
1660
- ##
1661
- # :attr_reader:
1662
- # Public: The duration of transaction history you requested.
1663
- property :days_requested
1664
-
1665
- ##
1666
- # :attr_reader:
1667
- # Public: Data submitted by you about the user whose Asset Report is
1668
- # being compiled; see AssetReportUser object for fields.
1669
- property :user, coerce: AssetReportUser
1670
-
1671
- ##
1672
- # :attr_reader:
1673
- # Public: Data returned by Plaid about each of the Items included in the
1674
- # Asset Report; see AssetReportItem object for fields.
1675
- property :items, coerce: Array[AssetReportItem]
1676
- end
1677
-
1678
- # Public: A representation of an eligibility for the Public Service Loan
1679
- # Forgiveness program.
1680
- class PSLFStatus < BaseModel
1681
- ##
1682
- # :attr_reader:
1683
- # Public: The estimated date borrower will have completed 120 qualifying
1684
- # monthly payments.
1685
- property :estimated_eligibility_date
1686
-
1687
- ##
1688
- # :attr_reader:
1689
- # Public: The number of qualifying payments that have been made.
1690
- property :payments_made
1691
-
1692
- ##
1693
- # :attr_reader:
1694
- # Public: The number of qualifying payments that are remaining.
1695
- property :payments_remaining
1696
- end
1697
-
1698
- # Public: A representation of the status of a student loan.
1699
- class StudentLoanStatus < BaseModel
1700
- ##
1701
- # :attr_reader:
1702
- # Public: The status of the loan, e.g. "repayment", "deferment",
1703
- # "forbearance".
1704
- property :type
1705
-
1706
- ##
1707
- # :attr_reader:
1708
- # Public: The date the status expires.
1709
- property :end_date
1710
- end
1711
-
1712
- # Public: A representation of a student loan repayment plan.
1713
- class StudentLoanRepaymentPlan < BaseModel
1714
- ##
1715
- # :attr_reader:
1716
- # Public: The type of repayment plan, e.g., "standard", "income".
1717
- property :type
1718
-
1719
- ##
1720
- # :attr_reader:
1721
- # Public: The full name of the repayment plan, e.g. "Standard Repayment".
1722
- property :description
1723
- end
1724
-
1725
- # Public: A representation of a student loan servicer address.
1726
- class StudentLoanServicerAddress < BaseModel
1727
- ##
1728
- # :attr_reader:
1729
- # Public: The full city name
1730
- property :city
1731
-
1732
- ##
1733
- # :attr_reader:
1734
- # Public: The ISO 3166-1 alpha-2 country code
1735
- property :country
1736
-
1737
- ##
1738
- # :attr_reader:
1739
- # Public: The postal code.
1740
- property :postal_code
1741
-
1742
- ##
1743
- # :attr_reader:
1744
- # Public: The region or state.
1745
- property :region
1746
-
1747
- ##
1748
- # :attr_reader:
1749
- # Public: The full street address.
1750
- property :street
1751
- end
1752
-
1753
- # Public: A representation of a student loan liability.
1754
- class StudentLoanLiability < BaseModel
1755
- ##
1756
- # :attr_reader:
1757
- # Public: The String account ID. E.g.
1758
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
1759
- property :account_id
1760
-
1761
- ##
1762
- # :attr_reader:
1763
- # Public: The account number of the loan.
1764
- property :account_number
1765
-
1766
- ##
1767
- # :attr_reader:
1768
- # Public: The dates on which loaned funds were disbursed or will be
1769
- # disbursed. These are often in the past.
1770
- property :disbursement_dates
1771
-
1772
- ##
1773
- # :attr_reader:
1774
- # Public: The date when the student loan is expected to be paid off.
1775
- property :expected_payoff_date
1776
-
1777
- ##
1778
- # :attr_reader:
1779
- # Public: The guarantor of the student loan.
1780
- property :guarantor
1781
-
1782
- ##
1783
- # :attr_reader:
1784
- # Public: The interest rate on loans shown as a percentage.
1785
- property :interest_rate_percentage
1786
-
1787
- ##
1788
- # :attr_reader:
1789
- # Public: True if a payment is currently overdue.
1790
- property :is_overdue
1791
-
1792
- ##
1793
- # :attr_reader:
1794
- # Public: The amount of the last payment.
1795
- property :last_payment_amount
1796
-
1797
- ##
1798
- # :attr_reader:
1799
- # Public: The date of the last payment.
1800
- property :last_payment_date
1801
-
1802
- ##
1803
- # :attr_reader:
1804
- # Public: The outstanding balance on the last statement.
1805
- property :last_statement_balance
1806
-
1807
- ##
1808
- # :attr_reader:
1809
- # Public: The date the last statement was issued.
1810
- property :last_statement_issue_date
1811
-
1812
- ##
1813
- # :attr_reader:
1814
- # Public: The status of the loan, e.g. "Repayment", "Deferment",
1815
- # "Forbearance".
1816
- property :loan_status, coerce: StudentLoanStatus
1817
-
1818
- ##
1819
- # :attr_reader:
1820
- # Public: The type of loan, e.g., "Consolidation Loans".
1821
- property :loan_name
1822
-
1823
- ##
1824
- # :attr_reader:
1825
- # Public: The minimum payment due for the next billing cycle.
1826
- property :minimum_payment_amount
1827
-
1828
- ##
1829
- # :attr_reader:
1830
- # Public: The due date for the next payment.
1831
- property :next_payment_due_date
1832
-
1833
- ##
1834
- # :attr_reader:
1835
- # Public: The date on which the loan was initially lent.
1836
- property :origination_date
1837
-
1838
- ##
1839
- # :attr_reader:
1840
- # Public: The original principal balance of the loan.
1841
- property :origination_principal_amount
1842
-
1843
- ##
1844
- # :attr_reader:
1845
- # Public: The dollar amount of the accrued interest balance.
1846
- property :outstanding_interest_amount
1847
-
1848
- ##
1849
- # :attr_reader:
1850
- # Public: The relevant account number that should be used to reference
1851
- # this loan for payments. This is sometimes different from
1852
- # account_number.
1853
- property :payment_reference_number
1854
-
1855
- ##
1856
- # :attr_reader:
1857
- # Public: Information about the student's eligibility in the Public
1858
- # Service Loan Forgiveness program.
1859
- property :pslf_status, coerce: PSLFStatus
1860
-
1861
- ##
1862
- # :attr_reader:
1863
- # Public: Information about the repayment plan.
1864
- property :repayment_plan, coerce: StudentLoanRepaymentPlan
1865
-
1866
- ##
1867
- # :attr_reader:
1868
- # Public: The sequence number of the student loan.
1869
- property :sequence_number
1870
-
1871
- ##
1872
- # :attr_reader:
1873
- # Public: The servicer address for which payments should be sent.
1874
- property :servicer_address, coerce: StudentLoanServicerAddress
1875
-
1876
- ##
1877
- # :attr_reader:
1878
- # Public: The year to date (YTD) interest paid.
1879
- property :ytd_interest_paid
1880
-
1881
- ##
1882
- # :attr_reader:
1883
- # Public: The year to date (YTD) principal paid.
1884
- property :ytd_principal_paid
1885
- end
1886
-
1887
- # Public: A representation of a credit card liability APR
1888
- class CreditCardLiabilityAPRs < BaseModel
1889
- ##
1890
- # :attr_reader:
1891
- # Public: Annual Percentage Rate applied.
1892
- property :apr_percentage
1893
-
1894
- ##
1895
- # :attr_reader:
1896
- # Public: Enumerated response from the following options:
1897
- # "balance_transfer_apr", "cash_apr", "purchase_apr", or
1898
- # "special".
1899
- property :apr_type
1900
-
1901
- ##
1902
- # :attr_reader:
1903
- # Public: Amount of money that is subjected to the APR if a
1904
- # balance was carried beyond payment due date. How it is
1905
- # calculated can vary by card issuer. It is often calculated as
1906
- # an average daily balance.
1907
- property :balance_subject_to_apr
1908
-
1909
- ##
1910
- # :attr_reader:
1911
- # Public: Amount of money charged due to interest from last
1912
- # statement.
1913
- property :interest_charge_amount
1914
- end
1915
-
1916
- # Public: A representation of a credit card liability
1917
- class CreditCardLiability < BaseModel
1918
- ##
1919
- # :attr_reader:
1920
- # Public: The ID of the account that this liability belongs to.
1921
- property :account_id
1922
-
1923
- ##
1924
- # :attr_reader:
1925
- # Public: See the APR object schema
1926
- property :aprs, coerce: Array[CreditCardLiabilityAPRs]
1927
-
1928
- ##
1929
- # :attr_reader:
1930
- # Public: true if a payment is currently overdue.
1931
- property :is_overdue
1932
-
1933
- ##
1934
- # :attr_reader:
1935
- # Public: The amount of the last payment.
1936
- property :last_payment_amount
1937
-
1938
- ##
1939
- # :attr_reader:
1940
- # Public: The date of the last payment.
1941
- property :last_payment_date
1942
-
1943
- ##
1944
- # :attr_reader:
1945
- # Public: The outstanding balance on the last statement.
1946
- property :last_statement_balance
1947
-
1948
- ##
1949
- # :attr_reader:
1950
- # Public: The date of the last statement.
1951
- property :last_statement_issue_date
1952
-
1953
- ##
1954
- # :attr_reader:
1955
- # Public: The minimum payment due for the next billing cycle.
1956
- property :minimum_payment_amount
1957
-
1958
- ##
1959
- # :attr_reader:
1960
- # Public: The due date for the next payment. The due date is null
1961
- # if a payment is not expected.
1962
- property :next_payment_due_date
1963
- end
1964
-
1965
- # Public: A representation of someone's liabilities of all types.
1966
- class Liabilities < BaseModel
1967
- include Hashie::Extensions::IgnoreUndeclared
1968
-
1969
- ##
1970
- # :attr_reader:
1971
- # Public: Student loan liabilities associated with the item.
1972
- property :student, coerce: Array[StudentLoanLiability]
1973
-
1974
- ##
1975
- # :attr_reader:
1976
- # Public: Credit card liabilities associated with the item.
1977
- property :credit, coerce: Array[CreditCardLiability]
1978
- end
1979
-
1980
- # Public: A representation of a payment amount.
1981
- class PaymentAmount < BaseModel
1982
- ##
1983
- # :attr_reader:
1984
- # Public: Currency for the payment amount.
1985
- property :currency
1986
-
1987
- ##
1988
- # :attr_reader:
1989
- # Public: Value of the payment amount.
1990
- property :value
1991
- end
1992
-
1993
- # Public: A representation of a payment amount.
1994
- class PaymentSchedule < BaseModel
1995
- ##
1996
- # :attr_reader:
1997
- # Public: Interval for the standing order.
1998
- property :interval
1999
-
2000
- ##
2001
- # :attr_reader:
2002
- # Public: Day or the week or day of the month to execute
2003
- # the standing order.
2004
- property :interval_execution_day
2005
-
2006
- ##
2007
- # :attr_reader:
2008
- # Public: Start date for the standing order.
2009
- property :start_date
2010
- end
2011
-
2012
- # Public: A representation of a payment amount.
2013
- class PaymentRecipientAddress < BaseModel
2014
- ##
2015
- # :attr_reader:
2016
- # Public: Street name.
2017
- property :street
2018
-
2019
- ##
2020
- # :attr_reader:
2021
- # Public: City.
2022
- property :city
2023
-
2024
- ##
2025
- # :attr_reader:
2026
- # Public: Postal code.
2027
- property :postal_code
2028
-
2029
- ##
2030
- # :attr_reader:
2031
- # Public: Country.
2032
- property :country
2033
- end
2034
-
2035
- # Public: A representation of a payment recipient BACS number.
2036
- class PaymentRecipientBACS < BaseModel
2037
- ##
2038
- # :attr_reader:
2039
- # Public: The String account number. E.g. "66374958".
2040
- property :account
2041
-
2042
- ##
2043
- # :attr_reader:
2044
- # Public: The String sort code. E.g. "089999".
2045
- property :sort_code
2046
- end
2047
-
2048
- # Public: A representation of a payment recipient.
2049
- class PaymentRecipient < BaseModel
2050
- ##
2051
- # :attr_reader:
2052
- # Public: The recipient ID.
2053
- property :recipient_id
2054
-
2055
- ##
2056
- # :attr_reader:
2057
- # Public: The recipient name.
2058
- property :name
2059
-
2060
- ##
2061
- # :attr_reader:
2062
- # Public: The recipient IBAN.
2063
- property :iban
2064
-
2065
- ##
2066
- # :attr_reader:
2067
- # Public: The recipient BACS number .
2068
- property :bacs, coerce: PaymentRecipientBACS
2069
-
2070
- ##
2071
- # :attr_reader:
2072
- # Public: The recipient address.
2073
- property :address, coerce: PaymentRecipientAddress
2074
- end
2075
-
2076
- # Public: A representation of a payment.
2077
- class Payment < BaseModel
2078
- ##
2079
- # :attr_reader:
2080
- # Public: The payment ID.
2081
- property :payment_id
2082
-
2083
- ##
2084
- # :attr_reader:
2085
- # Public: The payment token.
2086
- property :payment_token
2087
-
2088
- ##
2089
- # :attr_reader:
2090
- # Public: The payment reference.
2091
- property :reference
2092
-
2093
- ##
2094
- # :attr_reader:
2095
- # Public: The payment amount.
2096
- property :amount, coerce: PaymentAmount
2097
-
2098
- ##
2099
- # :attr_reader:
2100
- # Public: The payment schedule.
2101
- property :schedule, coerce: PaymentSchedule
2102
-
2103
- ##
2104
- # :attr_reader:
2105
- # Public: The payment's status.
2106
- property :status
2107
-
2108
- ##
2109
- # :attr_reader:
2110
- # Public: The last status update time for payment.
2111
- property :last_status_update
2112
-
2113
- ##
2114
- # :attr_reader:
2115
- # Public: The payment token's expiration time.
2116
- property :payment_token_expiration_time
2117
-
2118
- ##
2119
- # :attr_reader:
2120
- # Public: The recipient ID for payment.
2121
- property :recipient_id
2122
-
2123
- ##
2124
- # :attr_reader:
2125
- # Public: An object containing a BACS account number and sort code
2126
- # for the payer's account.
2127
- property :bacs
2128
-
2129
- ##
2130
- # :attr_reader:
2131
- # Public: A string containing the IBAN for the payer's account.
2132
- property :iban
2133
- end
2134
-
2135
- # Public: Metadata associated with a link token.
2136
- class LinkTokenMetadata < BaseModel
2137
- ##
2138
- # :attr_reader:
2139
- # Public: List of products associated with the link token.
2140
- property :initial_products
2141
-
2142
- ##
2143
- # :attr_reader:
2144
- # Public: The webhook associated with the link token.
2145
- property :webhook
2146
-
2147
- ##
2148
- # :attr_reader:
2149
- # Public: The country codes associated with the link token.
2150
- property :country_codes
2151
-
2152
- ##
2153
- # :attr_reader:
2154
- # Public: The language associated with the link token.
2155
- property :language
2156
-
2157
- ##
2158
- # :attr_reader:
2159
- # Public: The account filters associated with the link token.
2160
- property :account_filters
2161
-
2162
- ##
2163
- # :attr_reader:
2164
- # Public: The redirect URI associated with the link token.
2165
- property :redirect_uri
2166
-
2167
- ##
2168
- # :attr_reader:
2169
- # Public: The client name associated with the link token.
2170
- property :client_name
2171
- end
2172
-
2173
- # Public: A representation of a payment amount.
2174
- class WebhookVerificationKey < BaseModel
2175
- ##
2176
- # :attr_reader:
2177
- # Public: alg.
2178
- property :alg
2179
-
2180
- ##
2181
- # :attr_reader:
2182
- # Public: created_at.
2183
- property :created_at
2184
-
2185
- ##
2186
- # :attr_reader:
2187
- # Public: crv.
2188
- property :crv
2189
-
2190
- ##
2191
- # :attr_reader:
2192
- # Public: expired_at.
2193
- property :expired_at
2194
-
2195
- ##
2196
- # :attr_reader:
2197
- # Public: kid.
2198
- property :kid
2199
-
2200
- ##
2201
- # :attr_reader:
2202
- # Public: kty.
2203
- property :kty
2204
-
2205
- ##
2206
- # :attr_reader:
2207
- # Public: use.
2208
- property :use
2209
-
2210
- ##
2211
- # :attr_reader:
2212
- # Public: x.
2213
- property :x
2214
-
2215
- ##
2216
- # :attr_reader:
2217
- # Public: y.
2218
- property :y
2219
- end
2220
- end
2221
- end