plaid 13.2.0 → 17.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1087) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1374 -1
  3. data/CONTRIBUTING.md +12 -60
  4. data/Dockerfile +14 -0
  5. data/Gemfile.lock +51 -44
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +11 -0
  8. data/README.md +174 -101
  9. data/Rakefile +8 -79
  10. data/UPGRADING.md +4 -0
  11. data/lib/plaid/api/plaid_api.rb +12307 -0
  12. data/lib/plaid/api_client.rb +393 -0
  13. data/lib/plaid/api_error.rb +57 -0
  14. data/lib/plaid/configuration.rb +298 -0
  15. data/lib/plaid/models/account_access.rb +248 -0
  16. data/lib/plaid/models/account_assets.rb +428 -0
  17. data/lib/plaid/models/account_assets_all_of.rb +265 -0
  18. data/lib/plaid/models/account_balance.rb +276 -0
  19. data/lib/plaid/models/account_base.rb +344 -0
  20. data/lib/plaid/models/account_filter.rb +258 -0
  21. data/lib/plaid/models/account_filters_response.rb +246 -0
  22. data/lib/plaid/models/account_identity.rb +369 -0
  23. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  24. data/lib/plaid/models/account_identity_match_score.rb +392 -0
  25. data/lib/plaid/models/account_identity_match_score_all_of.rb +249 -0
  26. data/lib/plaid/models/account_product_access.rb +249 -0
  27. data/lib/plaid/models/account_product_access_nullable.rb +256 -0
  28. data/lib/plaid/models/account_selection_cardinality.rb +40 -0
  29. data/lib/plaid/models/account_subtype.rb +111 -0
  30. data/lib/plaid/models/account_type.rb +43 -0
  31. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  32. data/lib/plaid/models/accounts_balance_get_request_options.rb +232 -0
  33. data/lib/plaid/models/accounts_get_request.rb +254 -0
  34. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  35. data/lib/plaid/models/accounts_get_response.rb +256 -0
  36. data/lib/plaid/models/ach_class.rb +41 -0
  37. data/lib/plaid/models/address.rb +234 -0
  38. data/lib/plaid/models/address_data.rb +273 -0
  39. data/lib/plaid/models/address_data_nullable.rb +280 -0
  40. data/lib/plaid/models/address_match_score.rb +232 -0
  41. data/lib/plaid/models/address_nullable.rb +241 -0
  42. data/lib/plaid/models/address_purpose_label.rb +40 -0
  43. data/lib/plaid/models/application.rb +365 -0
  44. data/lib/plaid/models/application_get_request.rb +255 -0
  45. data/lib/plaid/models/application_get_response.rb +239 -0
  46. data/lib/plaid/models/apr.rb +296 -0
  47. data/lib/plaid/models/asset.rb +280 -0
  48. data/lib/plaid/models/asset_detail.rb +347 -0
  49. data/lib/plaid/models/asset_holder.rb +224 -0
  50. data/lib/plaid/models/asset_holder_name.rb +225 -0
  51. data/lib/plaid/models/asset_owner.rb +221 -0
  52. data/lib/plaid/models/asset_owners.rb +227 -0
  53. data/lib/plaid/models/asset_report.rb +297 -0
  54. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +255 -0
  55. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  56. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  57. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  58. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  59. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  60. data/lib/plaid/models/asset_report_create_request_options.rb +264 -0
  61. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  62. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  63. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  64. data/lib/plaid/models/asset_report_freddie.rb +252 -0
  65. data/lib/plaid/models/asset_report_freddie_get_request.rb +245 -0
  66. data/lib/plaid/models/asset_report_freddie_get_response.rb +254 -0
  67. data/lib/plaid/models/asset_report_get_request.rb +278 -0
  68. data/lib/plaid/models/asset_report_get_request_options.rb +247 -0
  69. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  70. data/lib/plaid/models/asset_report_item.rb +287 -0
  71. data/lib/plaid/models/asset_report_pdf_get_request.rb +254 -0
  72. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +247 -0
  73. data/lib/plaid/models/asset_report_refresh_request.rb +291 -0
  74. data/lib/plaid/models/asset_report_refresh_request_options.rb +241 -0
  75. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  76. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  77. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  78. data/lib/plaid/models/asset_report_transaction.rb +487 -0
  79. data/lib/plaid/models/asset_report_transaction_all_of.rb +230 -0
  80. data/lib/plaid/models/asset_report_user.rb +287 -0
  81. data/lib/plaid/models/asset_transaction.rb +241 -0
  82. data/lib/plaid/models/asset_transaction_category_type.rb +144 -0
  83. data/lib/plaid/models/asset_transaction_description.rb +225 -0
  84. data/lib/plaid/models/asset_transaction_detail.rb +327 -0
  85. data/lib/plaid/models/asset_transaction_type.rb +39 -0
  86. data/lib/plaid/models/asset_transactions.rb +226 -0
  87. data/lib/plaid/models/asset_type.rb +42 -0
  88. data/lib/plaid/models/assets.rb +227 -0
  89. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  90. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  91. data/lib/plaid/models/auth_get_numbers.rb +278 -0
  92. data/lib/plaid/models/auth_get_request.rb +254 -0
  93. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  94. data/lib/plaid/models/auth_get_response.rb +270 -0
  95. data/lib/plaid/models/auth_metadata.rb +220 -0
  96. data/lib/plaid/models/auth_supported_methods.rb +255 -0
  97. data/lib/plaid/models/automatically_verified_webhook.rb +284 -0
  98. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  99. data/lib/plaid/models/bank_transfer.rb +453 -0
  100. data/lib/plaid/models/bank_transfer_balance.rb +240 -0
  101. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  102. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  103. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  104. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  105. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  106. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  107. data/lib/plaid/models/bank_transfer_direction.rb +40 -0
  108. data/lib/plaid/models/bank_transfer_event.rb +380 -0
  109. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
  110. data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
  111. data/lib/plaid/models/bank_transfer_event_list_request.rb +386 -0
  112. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  113. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  114. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  115. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  116. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  117. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  118. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  119. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  120. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  121. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +285 -0
  122. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  123. data/lib/plaid/models/bank_transfer_network.rb +40 -0
  124. data/lib/plaid/models/bank_transfer_status.rb +42 -0
  125. data/lib/plaid/models/bank_transfer_sweep.rb +270 -0
  126. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +245 -0
  127. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
  128. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +302 -0
  129. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
  130. data/lib/plaid/models/bank_transfer_type.rb +39 -0
  131. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  132. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +254 -0
  133. data/lib/plaid/models/categories_get_response.rb +242 -0
  134. data/lib/plaid/models/category.rb +257 -0
  135. data/lib/plaid/models/cause.rb +342 -0
  136. data/lib/plaid/models/cause_all_of.rb +219 -0
  137. data/lib/plaid/models/client_provided_enhanced_transaction.rb +284 -0
  138. data/lib/plaid/models/client_provided_enriched_transaction.rb +293 -0
  139. data/lib/plaid/models/client_provided_raw_transaction.rb +270 -0
  140. data/lib/plaid/models/client_provided_transaction.rb +279 -0
  141. data/lib/plaid/models/connected_application.rb +309 -0
  142. data/lib/plaid/models/counterparty.rb +239 -0
  143. data/lib/plaid/models/counterparty_type.rb +41 -0
  144. data/lib/plaid/models/country_code.rb +53 -0
  145. data/lib/plaid/models/credit1099.rb +772 -0
  146. data/lib/plaid/models/credit1099_filer.rb +252 -0
  147. data/lib/plaid/models/credit1099_payer.rb +252 -0
  148. data/lib/plaid/models/credit1099_recipient.rb +274 -0
  149. data/lib/plaid/models/credit_account_subtype.rb +40 -0
  150. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +247 -0
  151. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +240 -0
  152. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +245 -0
  153. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +240 -0
  154. data/lib/plaid/models/credit_bank_income.rb +273 -0
  155. data/lib/plaid/models/credit_bank_income_account.rb +281 -0
  156. data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
  157. data/lib/plaid/models/credit_bank_income_category.rb +51 -0
  158. data/lib/plaid/models/credit_bank_income_cause.rb +259 -0
  159. data/lib/plaid/models/credit_bank_income_error_type.rb +53 -0
  160. data/lib/plaid/models/credit_bank_income_get_request.rb +249 -0
  161. data/lib/plaid/models/credit_bank_income_get_request_options.rb +222 -0
  162. data/lib/plaid/models/credit_bank_income_get_response.rb +236 -0
  163. data/lib/plaid/models/credit_bank_income_historical_summary.rb +273 -0
  164. data/lib/plaid/models/credit_bank_income_item.rb +274 -0
  165. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +42 -0
  166. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +245 -0
  167. data/lib/plaid/models/credit_bank_income_refresh_request.rb +254 -0
  168. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +230 -0
  169. data/lib/plaid/models/credit_bank_income_refresh_response.rb +225 -0
  170. data/lib/plaid/models/credit_bank_income_source.rb +309 -0
  171. data/lib/plaid/models/credit_bank_income_summary.rb +303 -0
  172. data/lib/plaid/models/credit_bank_income_transaction.rb +304 -0
  173. data/lib/plaid/models/credit_bank_income_warning.rb +237 -0
  174. data/lib/plaid/models/credit_bank_income_warning_code.rb +41 -0
  175. data/lib/plaid/models/credit_bank_income_warning_type.rb +38 -0
  176. data/lib/plaid/models/credit_card_liability.rb +315 -0
  177. data/lib/plaid/models/credit_category.rb +240 -0
  178. data/lib/plaid/models/credit_document_metadata.rb +258 -0
  179. data/lib/plaid/models/credit_employer_verification.rb +221 -0
  180. data/lib/plaid/models/credit_employment_get_request.rb +245 -0
  181. data/lib/plaid/models/credit_employment_get_response.rb +242 -0
  182. data/lib/plaid/models/credit_employment_item.rb +251 -0
  183. data/lib/plaid/models/credit_employment_verification.rb +315 -0
  184. data/lib/plaid/models/credit_filter.rb +227 -0
  185. data/lib/plaid/models/credit_pay_stub.rb +319 -0
  186. data/lib/plaid/models/credit_pay_stub_address.rb +265 -0
  187. data/lib/plaid/models/credit_pay_stub_deductions.rb +240 -0
  188. data/lib/plaid/models/credit_pay_stub_earnings.rb +240 -0
  189. data/lib/plaid/models/credit_pay_stub_employee.rb +260 -0
  190. data/lib/plaid/models/credit_pay_stub_employer.rb +235 -0
  191. data/lib/plaid/models/credit_pay_stub_net_pay.rb +265 -0
  192. data/lib/plaid/models/credit_payroll_income_get_request.rb +240 -0
  193. data/lib/plaid/models/credit_payroll_income_get_response.rb +252 -0
  194. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +282 -0
  195. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +239 -0
  196. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +240 -0
  197. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +240 -0
  198. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +240 -0
  199. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +252 -0
  200. data/lib/plaid/models/credit_platform_ids.rb +243 -0
  201. data/lib/plaid/models/credit_relay_create_request.rb +273 -0
  202. data/lib/plaid/models/credit_relay_create_response.rb +240 -0
  203. data/lib/plaid/models/credit_relay_get_request.rb +259 -0
  204. data/lib/plaid/models/credit_relay_refresh_request.rb +270 -0
  205. data/lib/plaid/models/credit_relay_refresh_response.rb +249 -0
  206. data/lib/plaid/models/credit_relay_remove_request.rb +245 -0
  207. data/lib/plaid/models/credit_relay_remove_response.rb +240 -0
  208. data/lib/plaid/models/credit_session.rb +251 -0
  209. data/lib/plaid/models/credit_session_bank_income_result.rb +239 -0
  210. data/lib/plaid/models/credit_session_bank_income_status.rb +40 -0
  211. data/lib/plaid/models/credit_session_document_income_result.rb +240 -0
  212. data/lib/plaid/models/credit_session_error.rb +251 -0
  213. data/lib/plaid/models/credit_session_item_add_result.rb +240 -0
  214. data/lib/plaid/models/credit_session_payroll_income_result.rb +250 -0
  215. data/lib/plaid/models/credit_session_results.rb +256 -0
  216. data/lib/plaid/models/credit_sessions_get_request.rb +245 -0
  217. data/lib/plaid/models/credit_sessions_get_response.rb +237 -0
  218. data/lib/plaid/models/credit_w2.rb +486 -0
  219. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  220. data/lib/plaid/models/dashboard_user.rb +269 -0
  221. data/lib/plaid/models/dashboard_user_get_request.rb +245 -0
  222. data/lib/plaid/models/dashboard_user_get_response.rb +284 -0
  223. data/lib/plaid/models/dashboard_user_list_request.rb +241 -0
  224. data/lib/plaid/models/dashboard_user_list_response.rb +253 -0
  225. data/lib/plaid/models/dashboard_user_status.rb +40 -0
  226. data/lib/plaid/models/date_range.rb +240 -0
  227. data/lib/plaid/models/deductions.rb +262 -0
  228. data/lib/plaid/models/deductions_breakdown.rb +265 -0
  229. data/lib/plaid/models/deductions_total.rb +254 -0
  230. data/lib/plaid/models/default_update_webhook.rb +294 -0
  231. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  232. data/lib/plaid/models/deposit_switch_alt_create_request.rb +312 -0
  233. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  234. data/lib/plaid/models/deposit_switch_create_request.rb +314 -0
  235. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  236. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  237. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  238. data/lib/plaid/models/deposit_switch_get_response.rb +448 -0
  239. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +259 -0
  240. data/lib/plaid/models/deposit_switch_target_account.rb +304 -0
  241. data/lib/plaid/models/deposit_switch_target_user.rb +289 -0
  242. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  243. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  244. data/lib/plaid/models/depository_account_subtype.rb +47 -0
  245. data/lib/plaid/models/depository_filter.rb +227 -0
  246. data/lib/plaid/models/disbursement_limits.rb +255 -0
  247. data/lib/plaid/models/distribution_breakdown.rb +296 -0
  248. data/lib/plaid/models/doc_type.rb +49 -0
  249. data/lib/plaid/models/document_analysis.rb +248 -0
  250. data/lib/plaid/models/document_authenticity_match_code.rb +41 -0
  251. data/lib/plaid/models/document_date_of_birth_match_code.rb +40 -0
  252. data/lib/plaid/models/document_metadata.rb +249 -0
  253. data/lib/plaid/models/document_name_match_code.rb +40 -0
  254. data/lib/plaid/models/document_risk_signal.rb +297 -0
  255. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +225 -0
  256. data/lib/plaid/models/document_risk_signals_object.rb +255 -0
  257. data/lib/plaid/models/document_risk_summary.rb +221 -0
  258. data/lib/plaid/models/document_status.rb +40 -0
  259. data/lib/plaid/models/documentary_verification.rb +242 -0
  260. data/lib/plaid/models/documentary_verification_document.rb +277 -0
  261. data/lib/plaid/models/earnings.rb +252 -0
  262. data/lib/plaid/models/earnings_breakdown.rb +297 -0
  263. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +47 -0
  264. data/lib/plaid/models/earnings_total.rb +283 -0
  265. data/lib/plaid/models/email.rb +289 -0
  266. data/lib/plaid/models/email_address_match_score.rb +221 -0
  267. data/lib/plaid/models/employee.rb +255 -0
  268. data/lib/plaid/models/employee_income_summary_field_string.rb +246 -0
  269. data/lib/plaid/models/employer.rb +265 -0
  270. data/lib/plaid/models/employer_income_summary_field_string.rb +246 -0
  271. data/lib/plaid/models/employer_verification.rb +221 -0
  272. data/lib/plaid/models/employers_search_request.rb +262 -0
  273. data/lib/plaid/models/employers_search_response.rb +242 -0
  274. data/lib/plaid/models/employment_details.rb +230 -0
  275. data/lib/plaid/models/employment_verification.rb +271 -0
  276. data/lib/plaid/models/employment_verification_get_request.rb +245 -0
  277. data/lib/plaid/models/employment_verification_get_response.rb +242 -0
  278. data/lib/plaid/models/employment_verification_status.rb +40 -0
  279. data/lib/plaid/models/enhancements.rb +342 -0
  280. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  281. data/lib/plaid/models/enrichments.rb +342 -0
  282. data/lib/plaid/models/entity_document.rb +260 -0
  283. data/lib/plaid/models/entity_document_type.rb +43 -0
  284. data/lib/plaid/models/entity_screening_hit_analysis.rb +279 -0
  285. data/lib/plaid/models/entity_screening_hit_data.rb +282 -0
  286. data/lib/plaid/models/entity_screening_hit_documents_items.rb +228 -0
  287. data/lib/plaid/models/entity_screening_hit_emails.rb +225 -0
  288. data/lib/plaid/models/entity_screening_hit_emails_items.rb +228 -0
  289. data/lib/plaid/models/entity_screening_hit_names.rb +254 -0
  290. data/lib/plaid/models/entity_screening_hit_names_items.rb +228 -0
  291. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +239 -0
  292. data/lib/plaid/models/entity_screening_hit_urls.rb +225 -0
  293. data/lib/plaid/models/entity_screening_hit_urls_items.rb +228 -0
  294. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +228 -0
  295. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +265 -0
  296. data/lib/plaid/models/entity_watchlist_code.rb +50 -0
  297. data/lib/plaid/models/entity_watchlist_program.rb +363 -0
  298. data/lib/plaid/models/entity_watchlist_screening.rb +306 -0
  299. data/lib/plaid/models/entity_watchlist_screening_hit.rb +351 -0
  300. data/lib/plaid/models/entity_watchlist_screening_review.rb +301 -0
  301. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +365 -0
  302. data/lib/plaid/models/entity_watchlist_search_terms.rb +350 -0
  303. data/lib/plaid/models/expiration_date.rb +40 -0
  304. data/lib/plaid/models/external_payment_initiation_consent_options.rb +296 -0
  305. data/lib/plaid/models/external_payment_options.rb +306 -0
  306. data/lib/plaid/models/external_payment_refund_details.rb +246 -0
  307. data/lib/plaid/models/external_payment_schedule_base.rb +261 -0
  308. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  309. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  310. data/lib/plaid/models/fdx_content_types.rb +43 -0
  311. data/lib/plaid/models/fdx_hateoas_link.rb +256 -0
  312. data/lib/plaid/models/fdx_hateoas_link_action.rb +42 -0
  313. data/lib/plaid/models/fdx_notification.rb +332 -0
  314. data/lib/plaid/models/fdx_notification_category.rb +42 -0
  315. data/lib/plaid/models/fdx_notification_payload.rb +238 -0
  316. data/lib/plaid/models/fdx_notification_payload_id_type.rb +42 -0
  317. data/lib/plaid/models/fdx_notification_priority.rb +40 -0
  318. data/lib/plaid/models/fdx_notification_severity.rb +42 -0
  319. data/lib/plaid/models/fdx_notification_type.rb +43 -0
  320. data/lib/plaid/models/fdx_party.rb +288 -0
  321. data/lib/plaid/models/fdx_party_registry.rb +41 -0
  322. data/lib/plaid/models/fdx_party_type.rb +43 -0
  323. data/lib/plaid/models/fdxfi_attribute.rb +230 -0
  324. data/lib/plaid/models/form1099_type.rb +40 -0
  325. data/lib/plaid/models/generic_screening_hit_location_items.rb +228 -0
  326. data/lib/plaid/models/health_incident.rb +268 -0
  327. data/lib/plaid/models/historical_balance.rb +262 -0
  328. data/lib/plaid/models/historical_update_webhook.rb +294 -0
  329. data/lib/plaid/models/holding.rb +340 -0
  330. data/lib/plaid/models/holdings_default_update_webhook.rb +309 -0
  331. data/lib/plaid/models/holdings_override.rb +289 -0
  332. data/lib/plaid/models/id_number_type.rb +72 -0
  333. data/lib/plaid/models/identity_default_update_webhook.rb +296 -0
  334. data/lib/plaid/models/identity_get_request.rb +254 -0
  335. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  336. data/lib/plaid/models/identity_get_response.rb +256 -0
  337. data/lib/plaid/models/identity_match_request.rb +263 -0
  338. data/lib/plaid/models/identity_match_request_options.rb +222 -0
  339. data/lib/plaid/models/identity_match_response.rb +256 -0
  340. data/lib/plaid/models/identity_match_user.rb +253 -0
  341. data/lib/plaid/models/identity_update_types.rb +41 -0
  342. data/lib/plaid/models/identity_verification.rb +396 -0
  343. data/lib/plaid/models/identity_verification_create_request.rb +302 -0
  344. data/lib/plaid/models/identity_verification_create_response.rb +411 -0
  345. data/lib/plaid/models/identity_verification_get_request.rb +245 -0
  346. data/lib/plaid/models/identity_verification_get_response.rb +411 -0
  347. data/lib/plaid/models/identity_verification_list_request.rb +292 -0
  348. data/lib/plaid/models/identity_verification_list_response.rb +253 -0
  349. data/lib/plaid/models/identity_verification_request_user.rb +307 -0
  350. data/lib/plaid/models/identity_verification_retried_webhook.rb +265 -0
  351. data/lib/plaid/models/identity_verification_retry_request.rb +305 -0
  352. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +270 -0
  353. data/lib/plaid/models/identity_verification_retry_response.rb +411 -0
  354. data/lib/plaid/models/identity_verification_status.rb +43 -0
  355. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +265 -0
  356. data/lib/plaid/models/identity_verification_step_status.rb +48 -0
  357. data/lib/plaid/models/identity_verification_step_summary.rb +308 -0
  358. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +265 -0
  359. data/lib/plaid/models/identity_verification_template_reference.rb +240 -0
  360. data/lib/plaid/models/identity_verification_user_address.rb +301 -0
  361. data/lib/plaid/models/identity_verification_user_data.rb +284 -0
  362. data/lib/plaid/models/image_quality.rb +40 -0
  363. data/lib/plaid/models/incident_update.rb +274 -0
  364. data/lib/plaid/models/income_breakdown.rb +253 -0
  365. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  366. data/lib/plaid/models/income_override.rb +222 -0
  367. data/lib/plaid/models/income_summary.rb +300 -0
  368. data/lib/plaid/models/income_summary_field_number.rb +239 -0
  369. data/lib/plaid/models/income_summary_field_string.rb +239 -0
  370. data/lib/plaid/models/income_verification_create_request.rb +264 -0
  371. data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
  372. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  373. data/lib/plaid/models/income_verification_documents_download_request.rb +263 -0
  374. data/lib/plaid/models/income_verification_payroll_flow_type.rb +39 -0
  375. data/lib/plaid/models/income_verification_paystubs_get_request.rb +252 -0
  376. data/lib/plaid/models/income_verification_paystubs_get_response.rb +263 -0
  377. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  378. data/lib/plaid/models/income_verification_precheck_employer.rb +253 -0
  379. data/lib/plaid/models/income_verification_precheck_employer_address.rb +267 -0
  380. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +260 -0
  381. data/lib/plaid/models/income_verification_precheck_military_info.rb +232 -0
  382. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +221 -0
  383. data/lib/plaid/models/income_verification_precheck_request.rb +291 -0
  384. data/lib/plaid/models/income_verification_precheck_response.rb +254 -0
  385. data/lib/plaid/models/income_verification_precheck_user.rb +253 -0
  386. data/lib/plaid/models/income_verification_source_type.rb +39 -0
  387. data/lib/plaid/models/income_verification_status_webhook.rb +294 -0
  388. data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
  389. data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
  390. data/lib/plaid/models/income_verification_webhook_status.rb +224 -0
  391. data/lib/plaid/models/individual_name.rb +240 -0
  392. data/lib/plaid/models/individual_screening_hit_names.rb +254 -0
  393. data/lib/plaid/models/individual_watchlist_code.rb +59 -0
  394. data/lib/plaid/models/individual_watchlist_program.rb +363 -0
  395. data/lib/plaid/models/inflow_model.rb +285 -0
  396. data/lib/plaid/models/initial_update_webhook.rb +295 -0
  397. data/lib/plaid/models/institution.rb +369 -0
  398. data/lib/plaid/models/institution_status.rb +303 -0
  399. data/lib/plaid/models/institutions_get_by_id_request.rb +292 -0
  400. data/lib/plaid/models/institutions_get_by_id_request_options.rb +258 -0
  401. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  402. data/lib/plaid/models/institutions_get_request.rb +358 -0
  403. data/lib/plaid/models/institutions_get_request_options.rb +298 -0
  404. data/lib/plaid/models/institutions_get_response.rb +257 -0
  405. data/lib/plaid/models/institutions_search_account_filter.rb +254 -0
  406. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +232 -0
  407. data/lib/plaid/models/institutions_search_request.rb +322 -0
  408. data/lib/plaid/models/institutions_search_request_options.rb +267 -0
  409. data/lib/plaid/models/institutions_search_response.rb +242 -0
  410. data/lib/plaid/models/investment_account_subtype.rb +87 -0
  411. data/lib/plaid/models/investment_filter.rb +227 -0
  412. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  413. data/lib/plaid/models/investment_transaction.rb +398 -0
  414. data/lib/plaid/models/investment_transaction_subtype.rb +85 -0
  415. data/lib/plaid/models/investment_transaction_type.rb +43 -0
  416. data/lib/plaid/models/investments_default_update_webhook.rb +309 -0
  417. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  418. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  419. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  420. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  421. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  422. data/lib/plaid/models/investments_transactions_override.rb +319 -0
  423. data/lib/plaid/models/issuing_country.rb +39 -0
  424. data/lib/plaid/models/item.rb +375 -0
  425. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  426. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  427. data/lib/plaid/models/item_application_list_request.rb +241 -0
  428. data/lib/plaid/models/item_application_list_response.rb +237 -0
  429. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  430. data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
  431. data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
  432. data/lib/plaid/models/item_error_webhook.rb +279 -0
  433. data/lib/plaid/models/item_get_request.rb +245 -0
  434. data/lib/plaid/models/item_get_response.rb +249 -0
  435. data/lib/plaid/models/item_import_request.rb +291 -0
  436. data/lib/plaid/models/item_import_request_options.rb +220 -0
  437. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  438. data/lib/plaid/models/item_import_response.rb +240 -0
  439. data/lib/plaid/models/item_product_ready_webhook.rb +279 -0
  440. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  441. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  442. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  443. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  444. data/lib/plaid/models/item_remove_request.rb +245 -0
  445. data/lib/plaid/models/item_remove_response.rb +225 -0
  446. data/lib/plaid/models/item_status.rb +240 -0
  447. data/lib/plaid/models/item_status_investments.rb +232 -0
  448. data/lib/plaid/models/item_status_last_webhook.rb +232 -0
  449. data/lib/plaid/models/item_status_nullable.rb +247 -0
  450. data/lib/plaid/models/item_status_transactions.rb +232 -0
  451. data/lib/plaid/models/item_webhook_update_request.rb +256 -0
  452. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  453. data/lib/plaid/models/jwk_public_key.rb +341 -0
  454. data/lib/plaid/models/jwt_header.rb +224 -0
  455. data/lib/plaid/models/kyc_check_address_summary.rb +252 -0
  456. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +224 -0
  457. data/lib/plaid/models/kyc_check_details.rb +295 -0
  458. data/lib/plaid/models/kyc_check_id_number_summary.rb +224 -0
  459. data/lib/plaid/models/kyc_check_name_summary.rb +224 -0
  460. data/lib/plaid/models/kyc_check_phone_summary.rb +224 -0
  461. data/lib/plaid/models/liabilities_default_update_webhook.rb +313 -0
  462. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  463. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  464. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  465. data/lib/plaid/models/liabilities_object.rb +249 -0
  466. data/lib/plaid/models/liability_override.rb +566 -0
  467. data/lib/plaid/models/link_delivery_create_request.rb +274 -0
  468. data/lib/plaid/models/link_delivery_create_response.rb +255 -0
  469. data/lib/plaid/models/link_delivery_delivery_method.rb +39 -0
  470. data/lib/plaid/models/link_delivery_get_request.rb +245 -0
  471. data/lib/plaid/models/link_delivery_get_response.rb +277 -0
  472. data/lib/plaid/models/link_delivery_session_status.rb +41 -0
  473. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +245 -0
  474. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +240 -0
  475. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  476. data/lib/plaid/models/link_token_create_credit_filter.rb +222 -0
  477. data/lib/plaid/models/link_token_create_depository_filter.rb +222 -0
  478. data/lib/plaid/models/link_token_create_institution_data.rb +220 -0
  479. data/lib/plaid/models/link_token_create_investment_filter.rb +222 -0
  480. data/lib/plaid/models/link_token_create_loan_filter.rb +222 -0
  481. data/lib/plaid/models/link_token_create_request.rb +505 -0
  482. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +246 -0
  483. data/lib/plaid/models/link_token_create_request_auth.rb +296 -0
  484. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  485. data/lib/plaid/models/link_token_create_request_identity_verification.rb +246 -0
  486. data/lib/plaid/models/link_token_create_request_income_verification.rb +294 -0
  487. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +233 -0
  488. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +233 -0
  489. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +264 -0
  490. data/lib/plaid/models/link_token_create_request_transfer.rb +230 -0
  491. data/lib/plaid/models/link_token_create_request_update.rb +222 -0
  492. data/lib/plaid/models/link_token_create_request_user.rb +324 -0
  493. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +267 -0
  494. data/lib/plaid/models/link_token_create_response.rb +255 -0
  495. data/lib/plaid/models/link_token_eu_config.rb +220 -0
  496. data/lib/plaid/models/link_token_get_metadata_response.rb +306 -0
  497. data/lib/plaid/models/link_token_get_request.rb +245 -0
  498. data/lib/plaid/models/link_token_get_response.rb +276 -0
  499. data/lib/plaid/models/link_token_investments.rb +220 -0
  500. data/lib/plaid/models/loan.rb +224 -0
  501. data/lib/plaid/models/loan_account_subtype.rb +49 -0
  502. data/lib/plaid/models/loan_filter.rb +227 -0
  503. data/lib/plaid/models/loan_identifier.rb +231 -0
  504. data/lib/plaid/models/loan_identifier_type.rb +39 -0
  505. data/lib/plaid/models/loan_identifiers.rb +224 -0
  506. data/lib/plaid/models/loans.rb +224 -0
  507. data/lib/plaid/models/location.rb +298 -0
  508. data/lib/plaid/models/match_summary.rb +224 -0
  509. data/lib/plaid/models/match_summary_code.rb +42 -0
  510. data/lib/plaid/models/meta.rb +311 -0
  511. data/lib/plaid/models/mfa.rb +285 -0
  512. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  513. data/lib/plaid/models/mortgage_liability.rb +444 -0
  514. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  515. data/lib/plaid/models/multi_document_risk_signal.rb +244 -0
  516. data/lib/plaid/models/name_match_score.rb +254 -0
  517. data/lib/plaid/models/net_pay.rb +274 -0
  518. data/lib/plaid/models/new_accounts_available_webhook.rb +259 -0
  519. data/lib/plaid/models/numbers.rb +290 -0
  520. data/lib/plaid/models/numbers_ach.rb +288 -0
  521. data/lib/plaid/models/numbers_ach_nullable.rb +295 -0
  522. data/lib/plaid/models/numbers_bacs.rb +255 -0
  523. data/lib/plaid/models/numbers_bacs_nullable.rb +262 -0
  524. data/lib/plaid/models/numbers_eft.rb +270 -0
  525. data/lib/plaid/models/numbers_eft_nullable.rb +277 -0
  526. data/lib/plaid/models/numbers_iban_nullable.rb +210 -0
  527. data/lib/plaid/models/numbers_international.rb +255 -0
  528. data/lib/plaid/models/numbers_international_iban.rb +300 -0
  529. data/lib/plaid/models/numbers_international_nullable.rb +262 -0
  530. data/lib/plaid/models/originator.rb +239 -0
  531. data/lib/plaid/models/override_account_type.rb +43 -0
  532. data/lib/plaid/models/override_accounts.rb +393 -0
  533. data/lib/plaid/models/owner.rb +278 -0
  534. data/lib/plaid/models/owner_override.rb +278 -0
  535. data/lib/plaid/models/ownership_type.rb +42 -0
  536. data/lib/plaid/models/parties.rb +226 -0
  537. data/lib/plaid/models/partner_customer_create_request.rb +398 -0
  538. data/lib/plaid/models/partner_customer_create_response.rb +229 -0
  539. data/lib/plaid/models/partner_customer_enable_request.rb +244 -0
  540. data/lib/plaid/models/partner_customer_enable_response.rb +230 -0
  541. data/lib/plaid/models/partner_customer_get_request.rb +244 -0
  542. data/lib/plaid/models/partner_customer_get_response.rb +229 -0
  543. data/lib/plaid/models/partner_customer_remove_request.rb +244 -0
  544. data/lib/plaid/models/partner_customer_remove_response.rb +220 -0
  545. data/lib/plaid/models/partner_end_customer.rb +237 -0
  546. data/lib/plaid/models/partner_end_customer_address.rb +256 -0
  547. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +238 -0
  548. data/lib/plaid/models/partner_end_customer_billing_contact.rb +237 -0
  549. data/lib/plaid/models/partner_end_customer_secrets.rb +230 -0
  550. data/lib/plaid/models/partner_end_customer_status.rb +41 -0
  551. data/lib/plaid/models/partner_end_customer_technical_contact.rb +237 -0
  552. data/lib/plaid/models/partner_end_customer_with_secrets.rb +254 -0
  553. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +218 -0
  554. data/lib/plaid/models/party.rb +252 -0
  555. data/lib/plaid/models/party_individual.rb +224 -0
  556. data/lib/plaid/models/party_role_type.rb +38 -0
  557. data/lib/plaid/models/pay.rb +232 -0
  558. data/lib/plaid/models/pay_frequency.rb +238 -0
  559. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  560. data/lib/plaid/models/pay_period_details.rb +332 -0
  561. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +265 -0
  562. data/lib/plaid/models/pay_stub_deductions_total.rb +254 -0
  563. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +287 -0
  564. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +298 -0
  565. data/lib/plaid/models/pay_stub_earnings_total.rb +265 -0
  566. data/lib/plaid/models/pay_stub_pay_period_details.rb +314 -0
  567. data/lib/plaid/models/pay_stub_taxpayer_id.rb +232 -0
  568. data/lib/plaid/models/payment_amount.rb +239 -0
  569. data/lib/plaid/models/payment_amount_currency.rb +45 -0
  570. data/lib/plaid/models/payment_amount_nullable.rb +239 -0
  571. data/lib/plaid/models/payment_amount_refunded.rb +246 -0
  572. data/lib/plaid/models/payment_amount_to_refund.rb +246 -0
  573. data/lib/plaid/models/payment_channel.rb +40 -0
  574. data/lib/plaid/models/payment_consent_max_payment_amount.rb +246 -0
  575. data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
  576. data/lib/plaid/models/payment_consent_periodic_amount.rb +252 -0
  577. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +246 -0
  578. data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
  579. data/lib/plaid/models/payment_consent_valid_date_time.rb +232 -0
  580. data/lib/plaid/models/payment_initiation_address.rb +383 -0
  581. data/lib/plaid/models/payment_initiation_consent.rb +357 -0
  582. data/lib/plaid/models/payment_initiation_consent_constraints.rb +272 -0
  583. data/lib/plaid/models/payment_initiation_consent_create_request.rb +373 -0
  584. data/lib/plaid/models/payment_initiation_consent_create_response.rb +254 -0
  585. data/lib/plaid/models/payment_initiation_consent_get_request.rb +266 -0
  586. data/lib/plaid/models/payment_initiation_consent_get_response.rb +380 -0
  587. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +325 -0
  588. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +254 -0
  589. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +266 -0
  590. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +220 -0
  591. data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
  592. data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
  593. data/lib/plaid/models/payment_initiation_metadata.rb +282 -0
  594. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +289 -0
  595. data/lib/plaid/models/payment_initiation_payment.rb +425 -0
  596. data/lib/plaid/models/payment_initiation_payment_create_request.rb +344 -0
  597. data/lib/plaid/models/payment_initiation_payment_create_response.rb +254 -0
  598. data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
  599. data/lib/plaid/models/payment_initiation_payment_get_request.rb +266 -0
  600. data/lib/plaid/models/payment_initiation_payment_get_response.rb +448 -0
  601. data/lib/plaid/models/payment_initiation_payment_list_request.rb +308 -0
  602. data/lib/plaid/models/payment_initiation_payment_list_response.rb +253 -0
  603. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +365 -0
  604. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +254 -0
  605. data/lib/plaid/models/payment_initiation_payment_status.rb +51 -0
  606. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +266 -0
  607. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  608. data/lib/plaid/models/payment_initiation_recipient.rb +271 -0
  609. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +323 -0
  610. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  611. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +266 -0
  612. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +294 -0
  613. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  614. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  615. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  616. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
  617. data/lib/plaid/models/payment_limits.rb +255 -0
  618. data/lib/plaid/models/payment_meta.rb +298 -0
  619. data/lib/plaid/models/payment_profile_create_request.rb +230 -0
  620. data/lib/plaid/models/payment_profile_create_response.rb +240 -0
  621. data/lib/plaid/models/payment_profile_get_request.rb +245 -0
  622. data/lib/plaid/models/payment_profile_get_response.rb +280 -0
  623. data/lib/plaid/models/payment_profile_remove_request.rb +245 -0
  624. data/lib/plaid/models/payment_profile_remove_response.rb +225 -0
  625. data/lib/plaid/models/payment_profile_status.rb +40 -0
  626. data/lib/plaid/models/payment_schedule_interval.rb +39 -0
  627. data/lib/plaid/models/payment_scheme.rb +41 -0
  628. data/lib/plaid/models/payment_status_update_webhook.rb +366 -0
  629. data/lib/plaid/models/payroll_income_account_data.rb +246 -0
  630. data/lib/plaid/models/payroll_income_object.rb +272 -0
  631. data/lib/plaid/models/payroll_income_rate_of_pay.rb +232 -0
  632. data/lib/plaid/models/payroll_item.rb +308 -0
  633. data/lib/plaid/models/payroll_item_status.rb +221 -0
  634. data/lib/plaid/models/payroll_risk_signals_item.rb +242 -0
  635. data/lib/plaid/models/paystub.rb +347 -0
  636. data/lib/plaid/models/paystub_address.rb +298 -0
  637. data/lib/plaid/models/paystub_deduction.rb +243 -0
  638. data/lib/plaid/models/paystub_details.rb +264 -0
  639. data/lib/plaid/models/paystub_employer.rb +230 -0
  640. data/lib/plaid/models/paystub_override.rb +248 -0
  641. data/lib/plaid/models/paystub_override_employee.rb +229 -0
  642. data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
  643. data/lib/plaid/models/paystub_override_employer.rb +220 -0
  644. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  645. data/lib/plaid/models/paystub_ytd_details.rb +232 -0
  646. data/lib/plaid/models/pending_expiration_webhook.rb +284 -0
  647. data/lib/plaid/models/personal_finance_category.rb +240 -0
  648. data/lib/plaid/models/phone_number.rb +289 -0
  649. data/lib/plaid/models/phone_number_match_score.rb +221 -0
  650. data/lib/plaid/models/phone_type.rb +39 -0
  651. data/lib/plaid/models/physical_document_category.rb +42 -0
  652. data/lib/plaid/models/physical_document_extracted_data.rb +293 -0
  653. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +266 -0
  654. data/lib/plaid/models/physical_document_images.rb +269 -0
  655. data/lib/plaid/models/plaid_error.rb +319 -0
  656. data/lib/plaid/models/plaid_error_type.rb +51 -0
  657. data/lib/plaid/models/platform_ids.rb +243 -0
  658. data/lib/plaid/models/po_box_status.rb +40 -0
  659. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  660. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  661. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  662. data/lib/plaid/models/processor_balance_get_request.rb +254 -0
  663. data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
  664. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  665. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  666. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  667. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  668. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  669. data/lib/plaid/models/processor_number.rb +250 -0
  670. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  671. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  672. data/lib/plaid/models/processor_token_create_request.rb +309 -0
  673. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  674. data/lib/plaid/models/product_access.rb +327 -0
  675. data/lib/plaid/models/product_status.rb +288 -0
  676. data/lib/plaid/models/product_status_breakdown.rb +299 -0
  677. data/lib/plaid/models/products.rb +54 -0
  678. data/lib/plaid/models/program_name_sensitivity.rb +41 -0
  679. data/lib/plaid/models/projected_income_summary_field_number.rb +246 -0
  680. data/lib/plaid/models/pslf_status.rb +243 -0
  681. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  682. data/lib/plaid/models/recipient_bacs.rb +282 -0
  683. data/lib/plaid/models/recipient_bacs_nullable.rb +289 -0
  684. data/lib/plaid/models/recurring_transaction_frequency.rb +42 -0
  685. data/lib/plaid/models/recurring_transactions_update_webhook.rb +286 -0
  686. data/lib/plaid/models/recurring_transfer.rb +431 -0
  687. data/lib/plaid/models/removed_transaction.rb +220 -0
  688. data/lib/plaid/models/report_type.rb +39 -0
  689. data/lib/plaid/models/reporting_information.rb +225 -0
  690. data/lib/plaid/models/risk_signal_document_reference.rb +231 -0
  691. data/lib/plaid/models/role.rb +224 -0
  692. data/lib/plaid/models/role_detail.rb +224 -0
  693. data/lib/plaid/models/roles.rb +224 -0
  694. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  695. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  696. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  697. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  698. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +319 -0
  699. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
  700. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +303 -0
  701. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  702. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  703. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  704. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  705. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  706. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  707. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +245 -0
  708. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +240 -0
  709. data/lib/plaid/models/sandbox_processor_token_create_request.rb +254 -0
  710. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  711. data/lib/plaid/models/sandbox_processor_token_create_response.rb +240 -0
  712. data/lib/plaid/models/sandbox_public_token_create_request.rb +302 -0
  713. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +220 -0
  714. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +264 -0
  715. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +231 -0
  716. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  717. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  718. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +245 -0
  719. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +225 -0
  720. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +230 -0
  721. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +225 -0
  722. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
  723. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
  724. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +230 -0
  725. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +234 -0
  726. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +266 -0
  727. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +225 -0
  728. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +255 -0
  729. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +239 -0
  730. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +251 -0
  731. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +239 -0
  732. data/lib/plaid/models/scopes.rb +243 -0
  733. data/lib/plaid/models/scopes_context.rb +39 -0
  734. data/lib/plaid/models/scopes_nullable.rb +250 -0
  735. data/lib/plaid/models/screening_hit_analysis.rb +261 -0
  736. data/lib/plaid/models/screening_hit_data.rb +258 -0
  737. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +228 -0
  738. data/lib/plaid/models/screening_hit_documents_items.rb +228 -0
  739. data/lib/plaid/models/screening_hit_names_items.rb +228 -0
  740. data/lib/plaid/models/screening_status_updated_webhook.rb +265 -0
  741. data/lib/plaid/models/security.rb +390 -0
  742. data/lib/plaid/models/security_override.rb +270 -0
  743. data/lib/plaid/models/sender_bacs_nullable.rb +289 -0
  744. data/lib/plaid/models/service.rb +238 -0
  745. data/lib/plaid/models/service_product_fulfillment.rb +224 -0
  746. data/lib/plaid/models/service_product_fulfillment_detail.rb +235 -0
  747. data/lib/plaid/models/service_product_fulfillment_identifier.rb +38 -0
  748. data/lib/plaid/models/servicer_address_data.rb +265 -0
  749. data/lib/plaid/models/services.rb +224 -0
  750. data/lib/plaid/models/signal_address_data.rb +263 -0
  751. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  752. data/lib/plaid/models/signal_decision_report_request.rb +349 -0
  753. data/lib/plaid/models/signal_decision_report_response.rb +225 -0
  754. data/lib/plaid/models/signal_device.rb +232 -0
  755. data/lib/plaid/models/signal_evaluate_core_attributes.rb +925 -0
  756. data/lib/plaid/models/signal_evaluate_request.rb +398 -0
  757. data/lib/plaid/models/signal_evaluate_response.rb +248 -0
  758. data/lib/plaid/models/signal_payment_method.rb +43 -0
  759. data/lib/plaid/models/signal_person_name.rb +265 -0
  760. data/lib/plaid/models/signal_prepare_request.rb +245 -0
  761. data/lib/plaid/models/signal_prepare_response.rb +225 -0
  762. data/lib/plaid/models/signal_return_report_request.rb +301 -0
  763. data/lib/plaid/models/signal_return_report_response.rb +225 -0
  764. data/lib/plaid/models/signal_scores.rb +228 -0
  765. data/lib/plaid/models/signal_user.rb +252 -0
  766. data/lib/plaid/models/simulated_transfer_sweep.rb +288 -0
  767. data/lib/plaid/models/single_document_risk_signal.rb +255 -0
  768. data/lib/plaid/models/source.rb +41 -0
  769. data/lib/plaid/models/standalone_account_type.rb +285 -0
  770. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  771. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  772. data/lib/plaid/models/status.rb +232 -0
  773. data/lib/plaid/models/statuses.rb +224 -0
  774. data/lib/plaid/models/strategy.rb +41 -0
  775. data/lib/plaid/models/student_loan.rb +492 -0
  776. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  777. data/lib/plaid/models/student_loan_status.rb +266 -0
  778. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  779. data/lib/plaid/models/sync_updates_available_webhook.rb +299 -0
  780. data/lib/plaid/models/taxform.rb +244 -0
  781. data/lib/plaid/models/taxpayer_id.rb +269 -0
  782. data/lib/plaid/models/taxpayer_identifier.rb +231 -0
  783. data/lib/plaid/models/taxpayer_identifier_type.rb +39 -0
  784. data/lib/plaid/models/taxpayer_identifiers.rb +224 -0
  785. data/lib/plaid/models/total.rb +249 -0
  786. data/lib/plaid/models/total_canonical_description.rb +54 -0
  787. data/lib/plaid/models/transaction.rb +561 -0
  788. data/lib/plaid/models/transaction_all_of.rb +311 -0
  789. data/lib/plaid/models/transaction_base.rb +458 -0
  790. data/lib/plaid/models/transaction_code.rb +50 -0
  791. data/lib/plaid/models/transaction_data.rb +285 -0
  792. data/lib/plaid/models/transaction_frequency.rb +41 -0
  793. data/lib/plaid/models/transaction_override.rb +280 -0
  794. data/lib/plaid/models/transaction_stream.rb +426 -0
  795. data/lib/plaid/models/transaction_stream_amount.rb +242 -0
  796. data/lib/plaid/models/transaction_stream_status.rb +41 -0
  797. data/lib/plaid/models/transactions_category_rule.rb +259 -0
  798. data/lib/plaid/models/transactions_enhance_get_request.rb +262 -0
  799. data/lib/plaid/models/transactions_enhance_get_response.rb +227 -0
  800. data/lib/plaid/models/transactions_enrich_get_request.rb +274 -0
  801. data/lib/plaid/models/transactions_enrich_get_response.rb +237 -0
  802. data/lib/plaid/models/transactions_get_request.rb +284 -0
  803. data/lib/plaid/models/transactions_get_request_options.rb +326 -0
  804. data/lib/plaid/models/transactions_get_response.rb +288 -0
  805. data/lib/plaid/models/transactions_recurring_get_request.rb +271 -0
  806. data/lib/plaid/models/transactions_recurring_get_request_options.rb +222 -0
  807. data/lib/plaid/models/transactions_recurring_get_response.rb +274 -0
  808. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  809. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  810. data/lib/plaid/models/transactions_removed_webhook.rb +296 -0
  811. data/lib/plaid/models/transactions_rule_details.rb +253 -0
  812. data/lib/plaid/models/transactions_rule_field.rb +39 -0
  813. data/lib/plaid/models/transactions_rule_type.rb +39 -0
  814. data/lib/plaid/models/transactions_rules_create_request.rb +274 -0
  815. data/lib/plaid/models/transactions_rules_create_response.rb +239 -0
  816. data/lib/plaid/models/transactions_rules_list_request.rb +245 -0
  817. data/lib/plaid/models/transactions_rules_list_response.rb +242 -0
  818. data/lib/plaid/models/transactions_rules_remove_request.rb +260 -0
  819. data/lib/plaid/models/transactions_rules_remove_response.rb +225 -0
  820. data/lib/plaid/models/transactions_sync_request.rb +302 -0
  821. data/lib/plaid/models/transactions_sync_request_options.rb +235 -0
  822. data/lib/plaid/models/transactions_sync_response.rb +306 -0
  823. data/lib/plaid/models/transfer.rb +502 -0
  824. data/lib/plaid/models/transfer_authorization.rb +298 -0
  825. data/lib/plaid/models/transfer_authorization_create_request.rb +429 -0
  826. data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
  827. data/lib/plaid/models/transfer_authorization_decision.rb +39 -0
  828. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +239 -0
  829. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +45 -0
  830. data/lib/plaid/models/transfer_authorization_device.rb +230 -0
  831. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +40 -0
  832. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +239 -0
  833. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +42 -0
  834. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +328 -0
  835. data/lib/plaid/models/transfer_authorization_user_in_request.rb +254 -0
  836. data/lib/plaid/models/transfer_cancel_request.rb +245 -0
  837. data/lib/plaid/models/transfer_cancel_response.rb +225 -0
  838. data/lib/plaid/models/transfer_create_request.rb +428 -0
  839. data/lib/plaid/models/transfer_create_response.rb +239 -0
  840. data/lib/plaid/models/transfer_device.rb +240 -0
  841. data/lib/plaid/models/transfer_diligence_status.rb +40 -0
  842. data/lib/plaid/models/transfer_event.rb +399 -0
  843. data/lib/plaid/models/transfer_event_list_request.rb +397 -0
  844. data/lib/plaid/models/transfer_event_list_response.rb +241 -0
  845. data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
  846. data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
  847. data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
  848. data/lib/plaid/models/transfer_event_type.rb +46 -0
  849. data/lib/plaid/models/transfer_events_update_webhook.rb +254 -0
  850. data/lib/plaid/models/transfer_failure.rb +231 -0
  851. data/lib/plaid/models/transfer_get_request.rb +245 -0
  852. data/lib/plaid/models/transfer_get_response.rb +239 -0
  853. data/lib/plaid/models/transfer_intent_authorization_decision.rb +39 -0
  854. data/lib/plaid/models/transfer_intent_create.rb +395 -0
  855. data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
  856. data/lib/plaid/models/transfer_intent_create_request.rb +394 -0
  857. data/lib/plaid/models/transfer_intent_create_response.rb +239 -0
  858. data/lib/plaid/models/transfer_intent_get.rb +456 -0
  859. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +240 -0
  860. data/lib/plaid/models/transfer_intent_get_request.rb +245 -0
  861. data/lib/plaid/models/transfer_intent_get_response.rb +239 -0
  862. data/lib/plaid/models/transfer_intent_status.rb +40 -0
  863. data/lib/plaid/models/transfer_list_request.rb +341 -0
  864. data/lib/plaid/models/transfer_list_response.rb +241 -0
  865. data/lib/plaid/models/transfer_migrate_account_request.rb +285 -0
  866. data/lib/plaid/models/transfer_migrate_account_response.rb +255 -0
  867. data/lib/plaid/models/transfer_network.rb +40 -0
  868. data/lib/plaid/models/transfer_originator_create_request.rb +245 -0
  869. data/lib/plaid/models/transfer_originator_create_response.rb +255 -0
  870. data/lib/plaid/models/transfer_originator_get_request.rb +245 -0
  871. data/lib/plaid/models/transfer_originator_get_response.rb +239 -0
  872. data/lib/plaid/models/transfer_originator_list_request.rb +297 -0
  873. data/lib/plaid/models/transfer_originator_list_response.rb +241 -0
  874. data/lib/plaid/models/transfer_questionnaire_create_request.rb +302 -0
  875. data/lib/plaid/models/transfer_questionnaire_create_response.rb +240 -0
  876. data/lib/plaid/models/transfer_recurring_cancel_request.rb +255 -0
  877. data/lib/plaid/models/transfer_recurring_cancel_response.rb +225 -0
  878. data/lib/plaid/models/transfer_recurring_create_request.rb +424 -0
  879. data/lib/plaid/models/transfer_recurring_create_response.rb +239 -0
  880. data/lib/plaid/models/transfer_recurring_get_request.rb +255 -0
  881. data/lib/plaid/models/transfer_recurring_get_response.rb +239 -0
  882. data/lib/plaid/models/transfer_recurring_list_request.rb +329 -0
  883. data/lib/plaid/models/transfer_recurring_list_response.rb +241 -0
  884. data/lib/plaid/models/transfer_recurring_schedule.rb +260 -0
  885. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  886. data/lib/plaid/models/transfer_refund.rb +284 -0
  887. data/lib/plaid/models/transfer_refund_cancel_request.rb +245 -0
  888. data/lib/plaid/models/transfer_refund_cancel_response.rb +225 -0
  889. data/lib/plaid/models/transfer_refund_create_request.rb +296 -0
  890. data/lib/plaid/models/transfer_refund_create_response.rb +239 -0
  891. data/lib/plaid/models/transfer_refund_get_request.rb +245 -0
  892. data/lib/plaid/models/transfer_refund_get_response.rb +239 -0
  893. data/lib/plaid/models/transfer_refund_status.rb +41 -0
  894. data/lib/plaid/models/transfer_repayment.rb +270 -0
  895. data/lib/plaid/models/transfer_repayment_list_request.rb +320 -0
  896. data/lib/plaid/models/transfer_repayment_list_response.rb +241 -0
  897. data/lib/plaid/models/transfer_repayment_return.rb +291 -0
  898. data/lib/plaid/models/transfer_repayment_return_list_request.rb +313 -0
  899. data/lib/plaid/models/transfer_repayment_return_list_response.rb +241 -0
  900. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  901. data/lib/plaid/models/transfer_status.rb +43 -0
  902. data/lib/plaid/models/transfer_sweep.rb +281 -0
  903. data/lib/plaid/models/transfer_sweep_get_request.rb +245 -0
  904. data/lib/plaid/models/transfer_sweep_get_response.rb +239 -0
  905. data/lib/plaid/models/transfer_sweep_list_request.rb +331 -0
  906. data/lib/plaid/models/transfer_sweep_list_response.rb +241 -0
  907. data/lib/plaid/models/transfer_sweep_status.rb +42 -0
  908. data/lib/plaid/models/transfer_test_clock.rb +236 -0
  909. data/lib/plaid/models/transfer_type.rb +39 -0
  910. data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
  911. data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
  912. data/lib/plaid/models/transfer_user_in_request.rb +254 -0
  913. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +249 -0
  914. data/lib/plaid/models/transfer_user_in_response.rb +257 -0
  915. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +366 -0
  916. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +311 -0
  917. data/lib/plaid/models/user_address.rb +317 -0
  918. data/lib/plaid/models/user_create_request.rb +275 -0
  919. data/lib/plaid/models/user_create_response.rb +255 -0
  920. data/lib/plaid/models/user_custom_password.rb +297 -0
  921. data/lib/plaid/models/user_id_number.rb +239 -0
  922. data/lib/plaid/models/user_name.rb +240 -0
  923. data/lib/plaid/models/user_permission_revoked_webhook.rb +279 -0
  924. data/lib/plaid/models/user_stated_income_source_category.rb +48 -0
  925. data/lib/plaid/models/user_stated_income_source_frequency.rb +42 -0
  926. data/lib/plaid/models/user_stated_income_source_pay_type.rb +40 -0
  927. data/lib/plaid/models/validation_source.rb +232 -0
  928. data/lib/plaid/models/validation_sources.rb +227 -0
  929. data/lib/plaid/models/verification_expired_webhook.rb +284 -0
  930. data/lib/plaid/models/verification_of_asset.rb +252 -0
  931. data/lib/plaid/models/verification_of_asset_response.rb +224 -0
  932. data/lib/plaid/models/verification_refresh_status.rb +40 -0
  933. data/lib/plaid/models/verification_status.rb +42 -0
  934. data/lib/plaid/models/w2.rb +437 -0
  935. data/lib/plaid/models/w2_box12.rb +232 -0
  936. data/lib/plaid/models/w2_state_and_local_wages.rb +287 -0
  937. data/lib/plaid/models/wallet.rb +263 -0
  938. data/lib/plaid/models/wallet_balance.rb +240 -0
  939. data/lib/plaid/models/wallet_create_request.rb +244 -0
  940. data/lib/plaid/models/wallet_create_response.rb +286 -0
  941. data/lib/plaid/models/wallet_get_request.rb +266 -0
  942. data/lib/plaid/models/wallet_get_response.rb +286 -0
  943. data/lib/plaid/models/wallet_iso_currency_code.rb +39 -0
  944. data/lib/plaid/models/wallet_list_request.rb +304 -0
  945. data/lib/plaid/models/wallet_list_response.rb +252 -0
  946. data/lib/plaid/models/wallet_numbers.rb +230 -0
  947. data/lib/plaid/models/wallet_transaction.rb +372 -0
  948. data/lib/plaid/models/wallet_transaction_amount.rb +260 -0
  949. data/lib/plaid/models/wallet_transaction_counterparty.rb +260 -0
  950. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +289 -0
  951. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +246 -0
  952. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +229 -0
  953. data/lib/plaid/models/wallet_transaction_execute_request.rb +384 -0
  954. data/lib/plaid/models/wallet_transaction_execute_response.rb +254 -0
  955. data/lib/plaid/models/wallet_transaction_get_request.rb +266 -0
  956. data/lib/plaid/models/wallet_transaction_get_response.rb +395 -0
  957. data/lib/plaid/models/wallet_transaction_list_request.rb +341 -0
  958. data/lib/plaid/models/wallet_transaction_list_request_options.rb +230 -0
  959. data/lib/plaid/models/wallet_transaction_list_response.rb +252 -0
  960. data/lib/plaid/models/wallet_transaction_status.rb +43 -0
  961. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +312 -0
  962. data/lib/plaid/models/wallet_transactions_list_request.rb +341 -0
  963. data/lib/plaid/models/warning.rb +288 -0
  964. data/lib/plaid/models/watchlist_screening_audit_trail.rb +250 -0
  965. data/lib/plaid/models/watchlist_screening_document.rb +260 -0
  966. data/lib/plaid/models/watchlist_screening_document_type.rb +50 -0
  967. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +271 -0
  968. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +321 -0
  969. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +245 -0
  970. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +321 -0
  971. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +256 -0
  972. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +253 -0
  973. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +256 -0
  974. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +253 -0
  975. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +302 -0
  976. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +253 -0
  977. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +245 -0
  978. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +378 -0
  979. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +241 -0
  980. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +253 -0
  981. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +307 -0
  982. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +316 -0
  983. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +256 -0
  984. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +253 -0
  985. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +314 -0
  986. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +38 -0
  987. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +321 -0
  988. data/lib/plaid/models/watchlist_screening_hit.rb +351 -0
  989. data/lib/plaid/models/watchlist_screening_hit_locations.rb +261 -0
  990. data/lib/plaid/models/watchlist_screening_hit_status.rb +40 -0
  991. data/lib/plaid/models/watchlist_screening_individual.rb +306 -0
  992. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +271 -0
  993. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +321 -0
  994. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +245 -0
  995. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +321 -0
  996. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +256 -0
  997. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +253 -0
  998. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +256 -0
  999. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +253 -0
  1000. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +302 -0
  1001. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +253 -0
  1002. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +245 -0
  1003. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +378 -0
  1004. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +241 -0
  1005. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +253 -0
  1006. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +307 -0
  1007. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +316 -0
  1008. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +256 -0
  1009. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +253 -0
  1010. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +314 -0
  1011. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +38 -0
  1012. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +321 -0
  1013. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +325 -0
  1014. data/lib/plaid/models/watchlist_screening_review.rb +301 -0
  1015. data/lib/plaid/models/watchlist_screening_search_terms.rb +343 -0
  1016. data/lib/plaid/models/watchlist_screening_status.rb +40 -0
  1017. data/lib/plaid/models/weak_alias_determination.rb +40 -0
  1018. data/lib/plaid/models/webhook_environment_values.rb +40 -0
  1019. data/lib/plaid/models/webhook_type.rb +43 -0
  1020. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +294 -0
  1021. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  1022. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  1023. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +246 -0
  1024. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +246 -0
  1025. data/lib/plaid/version.rb +13 -2
  1026. data/lib/plaid.rb +1043 -61
  1027. data/plaid.gemspec +44 -48
  1028. data/templates/ruby/api_client.mustache +278 -0
  1029. data/templates/ruby/api_client_faraday_partial.mustache +118 -0
  1030. data/templates/ruby/api_error.mustache +49 -0
  1031. data/templates/ruby/configuration.mustache +355 -0
  1032. data/templates/ruby/gemspec.mustache +42 -0
  1033. data/templates/ruby/partial_model_enum_class.mustache +22 -0
  1034. data/templates/ruby/partial_model_generic.mustache +362 -0
  1035. data/test/test_accounts.rb +99 -0
  1036. data/test/test_api_client.rb +23 -0
  1037. data/test/test_asset_report.rb +147 -0
  1038. data/test/test_auth.rb +61 -0
  1039. data/test/test_bank_transfers.rb +219 -0
  1040. data/test/test_categories.rb +10 -0
  1041. data/test/test_configuration.rb +26 -0
  1042. data/test/test_deposit_switch.rb +73 -0
  1043. data/test/test_helper.rb +109 -0
  1044. data/test/test_identity.rb +38 -0
  1045. data/test/test_identity_verification.rb +51 -0
  1046. data/test/test_institutions.rb +159 -0
  1047. data/test/test_investments.rb +208 -0
  1048. data/test/test_item.rb +275 -0
  1049. data/test/test_liabilities.rb +45 -0
  1050. data/test/test_link_token.rb +131 -0
  1051. data/test/test_monitor.rb +55 -0
  1052. data/test/test_payment_initiation.rb +94 -0
  1053. data/test/test_processor.rb +52 -0
  1054. data/test/test_sandbox.rb +31 -0
  1055. data/test/test_transactions.rb +168 -0
  1056. data/test/test_webhooks.rb +22 -0
  1057. metadata +1092 -88
  1058. data/.circleci/config.yml +0 -21
  1059. data/.env.sample +0 -3
  1060. data/.github/workflows/add_to_project.yml +0 -21
  1061. data/.rubocop.yml +0 -18
  1062. data/PUBLISH.md +0 -20
  1063. data/bin/console +0 -14
  1064. data/bin/setup +0 -8
  1065. data/lib/plaid/client.rb +0 -190
  1066. data/lib/plaid/errors.rb +0 -89
  1067. data/lib/plaid/middleware.rb +0 -31
  1068. data/lib/plaid/models.rb +0 -2221
  1069. data/lib/plaid/products/accounts.rb +0 -63
  1070. data/lib/plaid/products/asset_report.rb +0 -199
  1071. data/lib/plaid/products/auth.rb +0 -42
  1072. data/lib/plaid/products/base_product.rb +0 -64
  1073. data/lib/plaid/products/categories.rb +0 -21
  1074. data/lib/plaid/products/credit_details.rb +0 -40
  1075. data/lib/plaid/products/deposit_switch.rb +0 -99
  1076. data/lib/plaid/products/identity.rb +0 -31
  1077. data/lib/plaid/products/income.rb +0 -31
  1078. data/lib/plaid/products/institutions.rb +0 -91
  1079. data/lib/plaid/products/investments.rb +0 -127
  1080. data/lib/plaid/products/item.rb +0 -209
  1081. data/lib/plaid/products/liabilities.rb +0 -39
  1082. data/lib/plaid/products/link_token.rb +0 -74
  1083. data/lib/plaid/products/payment_initiation.rb +0 -251
  1084. data/lib/plaid/products/processor.rb +0 -190
  1085. data/lib/plaid/products/sandbox.rb +0 -148
  1086. data/lib/plaid/products/transactions.rb +0 -81
  1087. data/lib/plaid/products/webhooks.rb +0 -23
data/CHANGELOG.md CHANGED
@@ -1,4 +1,1377 @@
1
- ## 13.2.0
1
+ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2
+
3
+ # 17.1.0
4
+ - Updating to OAS 2020-09-14_1.205.3
5
+
6
+ ## OpenAPI Schema Changes
7
+ ### 2020-09-14_1.205.3
8
+ - Update description for `/signal/evaluate` endpoint
9
+
10
+ ### 2020-09-14_1.205.2
11
+ - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint
12
+
13
+ ### 2020-09-14_1.205.1
14
+ - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements
15
+
16
+ ### 2020-09-14_1.205.0
17
+ - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`.
18
+
19
+ ### 2020-09-14_1.204.0
20
+ - Remove `/income/verification/refresh` endpoint
21
+
22
+ ### 2020-09-14_1.203.0
23
+ - Add 7 brand new recurring transfer APIs
24
+ - Add `/transfer/recurring/create`
25
+ - Add `/transfer/recurring/list`
26
+ - Add `/transfer/recurring/get`
27
+ - Add `/transfer/recurring/cancel`
28
+ - Add `/sandbox/transfer/test_clock/create`
29
+ - Add `/sandbox/transfer/test_clock/advance`
30
+ - Add `/sandbox/transfer/test_clock/get`
31
+
32
+ ### 2020-09-14_1.202.6
33
+ - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores`
34
+
35
+ ### 2020-09-14_1.202.5
36
+ - Add `/partner/customer/remove` endpoint
37
+
38
+ ### 2020-09-14_1.202.4
39
+ - Internal changes
40
+
41
+ ### 2020-09-14_1.202.3
42
+ - New Transfer API routes for hosted onboarding of TPS end-customers
43
+
44
+ ### 2020-09-14_1.202.0
45
+ - Add `refunds` field to `Transfer` object
46
+ - Add `refund_id` field to `TransferEvent` object
47
+ - Fix typo for `transfer/get` and `transfer/refund/get`
48
+
49
+ ### 2020-09-14_1.201.0
50
+ - Add support for partial refunds
51
+ - Add `amount` field to `/payment_initiation/payment/reverse` request
52
+ - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
53
+
54
+ ### 2020-09-14_1.200.0
55
+ - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get`
56
+
57
+ ### 2020-09-14_1.199.0
58
+ - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint
59
+
60
+ ### 2020-09-14_1.198.8
61
+ - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response.
62
+
63
+ ### 2020-09-14_1.198.7
64
+ - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook`
65
+
66
+ ### 2020-09-14_1.198.6
67
+ - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior.
68
+ - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook.
69
+
70
+ ### 2020-09-14_1.198.5
71
+ - Internal changes
72
+
73
+ ### 2020-09-14_1.198.4
74
+ - Add `deleted_at` to `/payment_profile/get` response.
75
+
76
+ ### 2020-09-14_1.198.3
77
+ - Change `start_date` to `start_time` for `/wallet/transaction/list` response.
78
+
79
+ ### 2020-09-14_1.198.2
80
+ - Update list of available products for `/partner/customer/create`.
81
+
82
+ ### 2020-09-14_1.198.1
83
+ - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response.
84
+
85
+ ### 2020-09-14_1.198.0
86
+ - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint.
87
+ - Add `last_status_update` and `payment_id` field to `WalletTransaction`.
88
+ - Add `transaction_id` field to `PaymentInitiationPayment`
89
+
90
+ ### 2020-09-14_1.197.6
91
+ - Add `originator_client_id` to Transfer API endpoints
92
+
93
+ ### 2020-09-14_1.197.5
94
+ - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint.
95
+
96
+ ### 2020-09-14_1.197.4
97
+ - Add `asset_under_management` field to `PartnerCustomerCreateRequest`.
98
+
99
+ # 17.0.0
100
+ - Updating to OAS 2020-09-14_1.197.3
101
+
102
+ ## Breaking changes
103
+ - Move from Ruby 2.4.0 to Ruby 3, incorporating [#440](https://github.com/plaid/plaid-ruby/pull/440)
104
+ - Consolidate usages of `Error` into `PlaidError`
105
+ - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
106
+ - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API.
107
+
108
+ ## OpenAPI Schema Changes
109
+ ### 2020-09-14_1.197.3
110
+ - Update supported `CountryCode`'s in `link/token/create` docs.
111
+
112
+ ### 2020-09-14_1.197.2
113
+ - ach_class optional
114
+ - add rtp network option
115
+
116
+ ### 2020-09-14_1.197.1
117
+ - Add newly supported languages for Link
118
+
119
+ ### 2020-09-14_1.197.0
120
+ - Add `PAYMENT_PROFILE_LOGIN_REQUIRED` to transfer authorization `decision_rationale.code`.
121
+
122
+ ### 2020-09-14_1.196.3
123
+ - Add `institution_name` field to `payroll_income_result` of `/credit/sessions/get`
124
+
125
+ ### 2020-09-14_1.196.2
126
+ - Add requirements for `logo` in `PartnerCustomerCreateRequest`.
127
+
128
+ ### 2020-09-14_1.196.2
129
+ - Deprecate webhook status `VERIFICATION_STATUS_PENDING_APPROVAL` in `income_verification` apis.
130
+
131
+ ### 2020-09-14_1.196.1
132
+ - Add a note in the description of `/transfer/authorization/create`
133
+
134
+ ### 2020-09-14_1.196.0
135
+ - Added endpoint `/sandbox/payment_profile/reset_login`
136
+
137
+ ### 2020-09-14_1.195.0
138
+ - Consolidate usages of `Error` into `PlaidError`
139
+ - Add a `PlaidErrorType` enum
140
+
141
+ ### 2020-09-14_1.194.2
142
+ - Fix typo for `income_verification` in `/sandbox/public_token/create` options
143
+
144
+ ### 2020-09-14_1.194.1
145
+ - Update field descriptions in `/partner/customer/*` responses.
146
+ - Make `PartnerEndCustomerWithSecrets` extend `PartnerEndCustomer`.
147
+ - Fix documentation links in `/partner/customer/*` endpoints.
148
+
149
+ ### 2020-09-14_1.194.0
150
+ - Add `/partner/customer/enable` endpoint
151
+
152
+ ### 2020-09-14_1.193.0
153
+ - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
154
+
155
+ ### 2020-09-14_1.192.3
156
+ - Add `/fdx/notifications` endpoint.
157
+
158
+ ### 2020-09-14_1.192.2
159
+ - Add `USER_REPORTED_NO_INCOME` to CreditSessionBankIncomeStatus
160
+
161
+ ### 2020-09-14_1.192.1
162
+ - Update description for `payment_profile_token` field
163
+
164
+ ### 2020-09-14_1.192.0
165
+ - Add `income_verfication` field to `/sandbox/public_token/create`
166
+
167
+ ### 2020-09-14_1.191.1
168
+ - Add `document_income_result` field to `credit/sessions/get`
169
+
170
+ ### 2020-09-14_1.191.0
171
+ - Remove `payment_profile_id` from `/payment_profile/*`, `/transfer/authorization/create`, and `/transfer/create` endpoints and replace with `payment_profile_token`
172
+
173
+ ### 2020-09-14_1.190.0
174
+ - Removed auditor_id from /credit/audit_copy/token/create
175
+
176
+ ### 2020-09-14_1.189.0
177
+ - Add length boundary for the `client_user_id` field in `user/create`
178
+
179
+ ### 2020-09-14_1.188.0
180
+ - Add `SchemaVersion` field to Freddie Mac Verification of Assets Schema
181
+
182
+ ### 2020-09-14_1.187.0
183
+ - Add `non-custodial wallet` to account subtypes supported for investments
184
+ - Add `trade` investment transaction subtype as a subtype of `transfer` investment transaction type
185
+
186
+ ### 2020-09-14_1.186.2
187
+ - Add `errors` field to `credit/sessions/get`
188
+
189
+ ### 2020-09-14_1.186.1
190
+ - Add `payroll_income_result` field to `credit/sessions/get`
191
+
192
+ ### 2020-09-14_1.186.0
193
+
194
+ - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API.
195
+
196
+ ### 2020-09-14_1.185.0
197
+
198
+ - Add support for `USER_INPUT_TIMEOUT` as a value for `force_error` in the sandbox custom user schema.
199
+
200
+ ### 2020-09-14_1.184.0
201
+
202
+ - Make `payment_id` not required in `/link/token/create` under the `payment_initiation` field.
203
+
204
+ ### 2020-09-14_1.183.0
205
+
206
+ - Add `beacon_session_id` field in req of /transfer/authorization/create endpoint.
207
+
208
+ ### 2020-09-14_1.182.0
209
+ - Add `/link/oauth/correlation_id/exchange` endpoint.
210
+
211
+ # 16.0.0
212
+ - Updating to OAS 2020-09-14_1.181.1
213
+
214
+ ## OpenAPI Schema Changes
215
+ ### 2020-09-14_1.181.1
216
+ - Update `report_tokens` in `/credit/relay/create` endpoint request to be a list of strings instead a list of objects
217
+
218
+ ### 2020-09-14_1.181.0
219
+
220
+ - Add `credit/sessions/get` endpoint
221
+
222
+ ### 2020-09-14_1.180.0
223
+
224
+ - Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable`
225
+ instead.
226
+
227
+ ### 2020-09-14_1.179.0
228
+
229
+ - Remove `idempotency_key` field from resp of /transfer/authorization/create endpoint.
230
+
231
+ ### 2020-09-14_1.178.2
232
+
233
+ - Change `institution_price_as_of` field on the Holdings object to nullable
234
+
235
+ ### 2020-09-14_1.178.1
236
+
237
+ - Add `AUTHORISING` wallet transaction status
238
+
239
+ ### 2020-09-14_1.178.0
240
+
241
+ - Add `/partner/customer/get` endpoint.
242
+ - Add `status` to the response for `/partner/customer/create`.
243
+
244
+ ### 2020-09-14_1.177.4
245
+
246
+ - Add `settled` as a valid event type for `/sandbox/transfer/simulate`
247
+
248
+ ### 2020-09-14_1.177.3
249
+ - Replace `ASSET_TRANSACTION_DESCRIPTION` with `ASSET_TRANSACTION_DESCRIPTON` in Freddie Mac
250
+ Asset Report
251
+
252
+ ### 2020-09-14_1.177.2
253
+ - Add `ownership_type` to Asset Report account object, to reflect actual API behavior.
254
+ - Update and clarify docs, including update to reflect new Transfers cutoff times.
255
+
256
+ ### 2020-09-14_1.177.1
257
+ - Add `settled` as a possible Transfer status and `swept_settled` as a possible Transfer sweep status
258
+ - Add `settled` and `swept_settled` as new Transfer event types
259
+ - Add `settled` field to Transfer sweep object
260
+ - Add `standard_return_window` and `unauthorized_return_window` fields to Transfer object
261
+
262
+ ### 2020-09-14_1.177.0
263
+
264
+ - Add `options` and `days_to_included` to `AssetReportGetRequest`
265
+
266
+ ### 2020-09-14_1.176.2
267
+ - Add `recipient_id` field examples to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses
268
+
269
+ ### 2020-09-14_1.176.1
270
+ - Set `employment_report_token` field in the `/credit/employment/get` endpoint to be not required
271
+
272
+ ### 2020-09-14_1.176.0
273
+
274
+ - Add `mask` to the `meta` field of overridden accounts in the sandbox custom user configuration object schema.
275
+
276
+ ### 2020-09-14_1.175.0
277
+
278
+ - Remove `MiddleName` and add `VALIDATION_SOURCES` to Freddie Mac Asset Report
279
+
280
+ ### 2020-09-14_1.174.1
281
+
282
+ - Add `adyen` as processor partner
283
+
284
+ ### 2020-09-14_1.174.0
285
+
286
+ - Add `environment` as an attribute to all webhook payloads
287
+
288
+ ### 2020-09-14_1.173.0
289
+
290
+ - Add `idempotency_key` field in req/resp of /transfer/authorization/create endpoint.
291
+
292
+ ### 2020-09-14_1.172.1
293
+
294
+ - Removed `/asset_report/relay/` endpoints
295
+
296
+ ### 2020-09-14_1.172.0
297
+
298
+ - Add payroll institution to /credit/income/precheck endpoint.
299
+
300
+ ### 2020-09-14_1.171.0
301
+
302
+ - Add `recipient_id` to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses
303
+
304
+ ### 2020-09-14_1.170.1
305
+
306
+ - Fix that `client_id` and `secret` were erroneously marked as `required` for the request bodies of some endpoints. (These fields can be sent in the header and thus are not required in bodies).
307
+
308
+ ### 2020-09-14_1.170.0
309
+
310
+ - Add `with_guarantee` field in request of `/transfer/authorization/create`
311
+
312
+ ### 2020-09-14_1.169.0
313
+
314
+ - Add `issuing_region` as a field in the extracted data to documentary verification documents `/identity_verification/create`, `/identity_verification/get`, `/identity_verification/list` and `/identity_verification/retry` responses.
315
+
316
+ ### 2020-09-14_1.168.2
317
+
318
+ - Add `bacs`/`iban` recommendation for `/payment_initiation/recipient/create`
319
+
320
+ ### 2020-09-14_1.168.1
321
+
322
+ - Update descriptions for `/payment_profile/create`, `/payment_profile/get` and `/payment_profile/remove`
323
+
324
+ ### 2020-09-14_1.168.0
325
+
326
+ -- Add `counterparties` to `/beta/transactions/v1/enhance` response
327
+
328
+ ### 2020-09-14_1.167.1
329
+
330
+ - Added `MICRODEPOSIT_ERROR` which was returned by the API but missing from the error type enum.
331
+ - Various fixes to typos and descriptions
332
+
333
+ ### 2020-09-14_1.167.0
334
+
335
+ - Add authorization code `MIGRATED_ACCOUNT_ITEM` for Items created via `/transfer/migrate_account` endpoint
336
+
337
+ ### 2020-09-14_1.166.0
338
+
339
+ - Add `updated_at` field to Payroll Item entries in `/credit/payroll_income/get`
340
+
341
+ ### 2020-09-14_1.165.3
342
+
343
+ - removed LoanRoleType, ReportIdentifierType, and ReportDateTime fields from `/credit/asset_report/freddie_mac/get`
344
+
345
+ ### 2020-09-14_1.165.2
346
+
347
+ - Remove deprecated reverse_swept enum value from documentation
348
+
349
+ ### 2020-09-14_1.165.1
350
+
351
+ - Update example response for the `wallet/list` endpoint
352
+
353
+ ### 2020-09-14_1.165.0
354
+
355
+ - Add details for `IdentityMatchResponse` for `/identity/match` endpoint
356
+
357
+ ### 2020-09-14_1.164.10
358
+
359
+ - Update descriptions for `HOLDINGS: DEFAULT_UPDATE` and `INVESTMENT_TRANSACTIONS: DEFAULT_UPDATE` webhooks
360
+
361
+ ### 2020-09-14_1.164.9
362
+
363
+ - Removed report_type from the request to `/credit/asset_report/freddie_mae/get`
364
+
365
+ ### 2020-09-14_1.164.8
366
+
367
+ - Add documentation for credit categories in the `/asset_report/get` endpoint
368
+
369
+ ### 2020-09-14_1.164.7
370
+
371
+ - Remove redundant parameters from the `/transfer/create` endpoint from docs and mark them as deprecated
372
+
373
+ ### 2020-09-14_1.164.6
374
+
375
+ - Add the following new currencies for the `/payment_initiation` API route group: PLN, SEK, DKK, NOK, CHF, CZK
376
+
377
+ ### 2020-09-14_1.164.5
378
+
379
+ - Update description for `/payment_initiation/payment/reverse` to indicate that this endpoint only works with virtual accounts
380
+ - Update description for `/wallet/transaction/execute` to indicate that settlement will take seconds to days
381
+
382
+ ### 2020-09-14_1.164.4
383
+
384
+ - Remove verification fields from `/credit/payroll_income/get` and `/income/verification/paystubs/get`
385
+
386
+ ### 2020-09-14_1.164.3
387
+
388
+ - Remove pull_id field from `/credit/payroll_income/get`
389
+
390
+ ### 2020-09-14_1.164.2
391
+
392
+ - Update external documentation links for the `/wallet/` API route group
393
+ - Update `/payment_initiation/payment/reverse` description to cover which payments are eligible for refunds
394
+ - Update `/payment_initiation/payment/create` reference field description to indicate that references should be unique and will be adjusted automatically
395
+ - Update `PaymentInitiationPaymentStatus` description to indicate that payments may take seconds to days to settle depending on the payment rail used
396
+ - Update `WalletTransactionStatus` description to indicate that transactions may take seconds to days to settle depending on the payment rail used
397
+
398
+ ### 2020-09-14_1.164.1
399
+
400
+ - Make `is_savings_or_money_market_account` field in `SignalEvaluateCoreAttributes` nullable
401
+
402
+ ### 2020-09-14_1.164.0
403
+
404
+ - Add new endpoint `/credit/asset_report/freddie_mac`
405
+
406
+ ### 2020-09-14_1.163.0
407
+
408
+ - Add `/link_delivery/create` endpoint
409
+ - Add `/link_delivery/get` endpoint
410
+
411
+ ### 2020-09-14_1.162.2
412
+
413
+ - Fix minimum and maximum values in `/signal/evaluate` scores
414
+
415
+ ### 2020-09-14_1.162.1
416
+
417
+ - Make holdings `institution_price_as_of` non-nullable
418
+
419
+ ### 2020-09-14_1.162.0
420
+
421
+ - Add `WalletTransactionStatusUpdateWebhook` object
422
+ - Update `WalletTransactionStatus` to include an additional `SETTLED` enum
423
+ - Update `PaymentInitiationPaymentStatus` to include an additional `PAYMENT_STATUS_SETTLED` enum
424
+
425
+ # 15.11.0
426
+ - Updating to OAS 2020-09-14_1.161.5
427
+
428
+ ## OpenAPI Schema Changes
429
+ ### 2020-09-14_1.161.5
430
+
431
+ - Reverts the changes made in 2020-09-14_1.157.0
432
+
433
+ ### 2020-09-14_1.161.4
434
+
435
+ - Update description for webhook `USER_PERMISSION_REVOKED`
436
+
437
+ ### 2020-09-14_1.161.3
438
+
439
+ - Bug fix: Put quotes around the '529' account type to prevent generated client libraries from treating it as an integer.
440
+ - Add `RECURRING_TRANSACTIONS_UPDATE` to description of sandbox webhook testing endpoint
441
+
442
+ ### 2020-09-14_1.161.2
443
+
444
+ - Change the Item schema to refer to `PlaidError` rather than `Error` to avoid namespace conflicts in client libraries.
445
+
446
+ ### 2020-09-14_1.161.1
447
+
448
+ - Add required fields back to AssetReport schema
449
+
450
+ ### 2020-09-14_1.161.0
451
+ - Remove `access_token` request parameter from `/beta/partner/v1/customers/create`
452
+
453
+ ### 2020-09-14_1.160.0
454
+
455
+ - Add `user` fields to the `/link/token/create` `user` object.
456
+
457
+ ### 2020-09-14_1.159.0
458
+
459
+ - Add `RECURRING_TRANSACTIONS_UPDATE` webhook specification
460
+ - Fix typo in `/sandbox/item/fire_webhook` description
461
+
462
+ ### 2020-09-14_1.158.1
463
+
464
+ - Add x-plaid-validation for Credit Relay Tokens
465
+
466
+ ### 2020-09-14_1.158.0
467
+
468
+ - Add `address` and `id_number` fields to the `/link/token/create` `user` object.
469
+
470
+ ### 2020-09-14_1.157.0
471
+
472
+ - Update and add schemas referred by `AssetReportGetResponse`
473
+
474
+ ### 2020-09-14_1.156.0
475
+
476
+ - Add `payment_profile_id` to `/transfer/authorization/create` and `/transfer/create`
477
+ - Make `access_token` and `account_id` optional in `/transfer/authorization/create` and `/transfer/create`
478
+
479
+ ### 2020-09-14_1.155.0
480
+
481
+ - Add `payment_profile_id` as a field under `transfer` for `/link/token/create`
482
+
483
+ ### 2020-09-14_1.154.0
484
+
485
+ - Create `/credit/bank_income/pdf/get` to allow customers to retrieve the bank income product as a PDF
486
+
487
+ ### 2020-09-14_1.153.1
488
+ -- Add `personal_finance_category_icon_url` to `/beta/transactions/v1/enhance` response
489
+
490
+ ### 2020-09-14_1.153.0
491
+ -- Add new endpoint `/beta/partner/v1/customers/create`
492
+
493
+ ### 2020-09-14_1.152.0
494
+ - Add `form1099s` as part of the `credit/payroll_income/get` response.
495
+ - Add `Credit1099` object and corresponding subtypes.
496
+
497
+ ### 2020-09-14_1.151.1
498
+ - Update required fields list for guaranteed ACH customers
499
+
500
+ ### 2020-09-14_1.151.0
501
+ - Mark `verification` field under `paystubs` object in `/credit/payroll_income/get` as deprecated
502
+
503
+ ### 2020-09-14_1.150.0
504
+ - Make `user_present` under `/transfer/authorization/create` nullable
505
+
506
+ ### 2020-09-14_1.149.1
507
+ - Update fields description for guaranteed ACH customers
508
+
509
+ ### 2020-09-14_1.149.0
510
+
511
+ - Add `gave_consent` as a field under `identity_verification` for `/link/token/create`
512
+ - Remove `identity_verification.consent`, which is deprecated, from documentation for `/link/token/create`
513
+
514
+ ### 2020-09-14_1.148.0
515
+
516
+ - Add `user_present` a an optional field under `/transfer/authorization/create`, update fields description for guaranteed ACH customers
517
+
518
+ ### 2020-09-14_1.147.1
519
+
520
+ - Remove deprecated `reversed` status from Transfer schema
521
+ - Remove deprecated `reverse_swept` status from Transfer Event schema
522
+
523
+ ### 2020-09-14_1.147.0
524
+
525
+ - Add new endpoints `/credit/relay/get`, `/credit/relay/refresh` and `/credit/relay/remove`
526
+
527
+ # 15.10.0
528
+ - Updating to OAS 2020-09-14_1.146.0
529
+
530
+ ## OpenAPI Schema Changes
531
+ ### 2020-09-14_1.146.0
532
+
533
+ - make item_logins field not required
534
+
535
+ ### 2020-09-14_1.145.0
536
+
537
+ - Make changes to IdentityMatchRequest to support options data
538
+
539
+ ### 2020-09-14_1.144.0
540
+
541
+ - Remove unsupported error_code (`PRODUCTS_NOT_SUPPORTED`) for the `force_error` config in Sandbox
542
+
543
+ ### 2020-09-14_1.143.0
544
+
545
+ - Make changes to support crypto in Investments product
546
+
547
+ ### 2020-09-14_1.142.0
548
+
549
+ - Add new endpoints `/payment_profile/get` and `/payment_profile/remove`
550
+
551
+ ### 2020-09-14_1.141.1
552
+
553
+ - Bug fix: add `identity_verification` to `Products` array
554
+
555
+ ### 2020-09-14_1.141.0
556
+
557
+ - Add a new endpoint `/payment_profile/create`
558
+
559
+ ### 2020-09-14_1.140.1
560
+
561
+ - Add `stated_income_sources` as a field under `income_verification` for `/link/token/create`
562
+
563
+ ### 2020-09-14_1.140.0
564
+
565
+ - Add `bin` as a field under `institution_metadata` for `/link/token/create`
566
+
567
+ ### 2020-09-14_1.139.0
568
+
569
+ - Add `international` IBAN numbers to `WalletNumbers` field in `/wallet/get` and `/wallet/list` responses.
570
+ - Wrap the `iban` field in the `WalletTransactionCounterpartyNumbers` under new field `international`.
571
+
572
+ ### 2020-09-14_1.138.0
573
+
574
+ - Add new `identity/match` endpoint, and `IdentityMatchRequest` and `IdentityMatchResponse`
575
+
576
+ ### 2020-09-14_1.137.1
577
+
578
+ - Update comment for the `recipient.name` field with recommendation to avoid long strings and special characters.
579
+
580
+ ### 2020-09-14_1.137.0
581
+
582
+ - Reverts the changes made in 2020-09-14_1.135.0. ProductAccess and AccountProductAccess once again have all fields explicitly defined.
583
+
584
+ ### 2020-09-14_1.136.0
585
+
586
+ - Add `products` in `asset_report/create` endpoint.
587
+
588
+ ### 2020-09-14_1.135.0
589
+
590
+ - Convert ProductAccess and AccountProductAccess to optional.Map
591
+
592
+ ### 2020-09-14_1.134.0
593
+
594
+ - Rename `merchant_website` and `merchant_logo_url` in `/beta/transactions/v1/enhance` to `website` and `logo_url`
595
+
596
+ ### 2020-09-14_1.133.0
597
+
598
+ - Update `/credit/payroll_income/get` response to have a `pull_id` instead of an `income_report_token` and add `pull_id` to `/credit/employment/get` response
599
+
600
+ ### 2020-09-14_1.132.1
601
+
602
+ - Made several fields nullable for `/signal/evaluate`
603
+
604
+ ### 2020-09-14_1.132.0
605
+
606
+ - Add `/credit/audit_copy_token/remove` to invalidate Audit Copy tokens
607
+
608
+ # 15.9.0
609
+ - Updating to OAS 2020-09-14_1.131.3
610
+
611
+ ## OpenAPI Schema Changes
612
+ ### 2020-09-14_1.131.3
613
+ - Update external URL for `/transfer/migrate_account` endpoint
614
+
615
+ ### 2020-09-14_1.131.2
616
+ - Add `TRANSFER_LIMIT_REACHED` to enum `TransferAuthorizationDecisionRationaleCode`
617
+
618
+ ### 2020-09-14_1.131.1
619
+ - Update `/payment_initiation/consent/*` external docs URLs
620
+
621
+ ### 2020-09-14_1.131.0
622
+ - Add `iban` to `counterparty`'s `numbers` field in `/wallet/transaction/execute`
623
+
624
+ ### 2020-09-14_1.130.0
625
+ - Update description of `/user/create` to make it more clear what would happen when a client calls the user creation endpoint with the same client_user_id multiple times.
626
+
627
+ ### 2020-09-14_1.129.0
628
+ - Add `signal_description` for each risk signal in `/beta/credit/payroll_income/risk_signals/get`
629
+ - Change `DocumentRiskSignalInstitutionMetadata` to be nullable
630
+
631
+ ### 2020-09-14_1.128.6
632
+ - Fix category rules formatting
633
+
634
+ ### 2020-09-14_1.128.5
635
+ - Change description in `UserCustomPassword` to reflect that only top level fields are optional not all fields
636
+
637
+ ### 2020-09-14_1.128.4
638
+ - Move Category Rules description to `include_personal_finance_category` flag
639
+
640
+ # 15.8.0
641
+ - Updating to OAS 2020-09-14_1.128.4
642
+
643
+ ## OpenAPI Schema Changes
644
+ ### 2020-09-14_1.128.4
645
+ - Add `identity_verification` as a new optional parameter for `/link/token/create`
646
+
647
+ ### 2020-09-14_1.128.3
648
+ - Add category rules beta to `personal_finance_category` field description
649
+ in `/transactions/get`
650
+
651
+ # 15.7.0
652
+ - Updating to OAS 2020-09-14_1.128.2
653
+
654
+ ## OpenAPI Schema Changes
655
+ ### 2020-09-14_1.128.2
656
+ - Update description of `/investments/transactions/get` endpoint
657
+ - Update description of `cost_basis` field
658
+
659
+ ### 2020-09-14_1.128.1
660
+ - Add `merchant_website` and `merchant_logo_url` to `/beta/transactions/v1/enhance` response
661
+
662
+ ### 2020-09-14_1.128.0
663
+ - Add `auth_type_select_enabled`, `automated_microdeposits_enabled`, `instant_match_enabled`, and `same_day_microdeposits_enabled` to `/link/token/create`
664
+ - Marked `flow_type` parameter as deprecated
665
+
666
+ ### 2020-09-14_1.127.0
667
+ - Add `consent_id` filter to `/payment_initiation/payment/list`
668
+ - Add `consent_id` to `/link/token/create`
669
+
670
+ ### 2020-09-14_1.126.0
671
+
672
+ - Added `/credit/relay/create` endpoint
673
+
674
+ ### 2020-09-14_1.125.0
675
+
676
+ - Add `accounts` object to `/credit/payroll_income/get` response
677
+
678
+ ### 2020-09-14_1.124.0
679
+ - Added `include_fast_report` in `asset_report/create` endpoint. Added `fast_report` in `asset_report/get` endpoint
680
+
681
+ ### 2020-09-14_1.123.1
682
+ - Removed `reversed` and `reverse_swept` from possible event_type values in TransferEventListRequest docs
683
+
684
+ ### 2020-09-14_1.123.0
685
+
686
+ - Change `tokens` to `report_tokens` in `/credit/audit_copy_token/create` request
687
+
688
+ ### 2020-09-14_1.122.0
689
+
690
+ - Add `request_id` to all Identity Verification and Monitor responses
691
+
692
+ ### 2020-09-14_1.121.2
693
+ - Added sample user_id to INCOME_VERIFICATION webhook
694
+
695
+ ### 2020-09-14_1.121.1
696
+ - Pre-release API refinements to Monitor and Flow endpoints
697
+
698
+ # 15.6.0
699
+ - Updating to OAS 2020-09-14_1.121.0
700
+
701
+ ## OpenAPI Schema Changes
702
+ ### 2020-09-14_1.121.0
703
+ - Add TimestampNullable type
704
+
705
+ ### 2020-09-14_1.120.0
706
+ - Removed `Uploaded`, `Created` and `APPROVAL_STATUS_APPROVED` enum strings from `PayrollItemStatus` field.
707
+
708
+ ### 2020-09-14_1.119.0
709
+ - Add `returned` to TransferStatus enum
710
+ - Add `return_swept` to TransferSweepStatus enum
711
+ - Add `returned` and `return_swept` to TransferEventType enum
712
+
713
+ ### 2020-09-14_1.118.0
714
+ - Added `employee_type` and `last_paystub_date` to `/credit/employment/get` response
715
+
716
+ ### 2020-09-14_1.117.1
717
+ - Make `/payment_initiation/consent/create` API more strict
718
+
719
+ ### 2020-09-14_1.117.0
720
+ - Add `/credit/audit_copy_token/create` endpoint
721
+
722
+ ### 2020-09-14_1.116.0
723
+ - Add `/wallet/list` endpoint
724
+
725
+ # 15.5.0
726
+ - Updating to OAS 2020-09-14_1.115.2
727
+
728
+ ## OpenAPI Schema Changes
729
+ ### 2020-09-14_1.115.2
730
+ - Update description fields to fix formatting errors
731
+ - Reflect that `error.suggested_action` is `nullable`
732
+
733
+ ### 2020-09-14_1.115.1
734
+ - Update OpenAPI spec
735
+
736
+ ### 2020-09-14_1.115.0
737
+ - Added `income_report_token` to `/credit/payroll_income/get` response
738
+
739
+ ### 2020-09-14_1.114.2
740
+ - Add `/wallet/create` endpoint
741
+
742
+ ### 2020-09-14_1.114.1
743
+ - Add beta `additional_consented_products` field to `/link/token/create`
744
+
745
+ ### 2020-09-14_1.113.1
746
+ - Updated `/transactions/recurring/get` description
747
+
748
+ ### 2020-09-14_1.113.0
749
+ - Add webhooks for new Monitor and Identity Verification products
750
+
751
+ ### 2020-09-14_1.112.0
752
+ - Add endpoints for new Monitor and Identity Verification products
753
+
754
+ ### 2020-09-14_1.111.15
755
+ - Remove `emi_recipient_id` from Payment Initiation Recipient
756
+
757
+ ### 2020-09-14_1.111.14
758
+ - Add optional `iban` and `bacs` fields to `options` in the `/payment_initiation/consent/create` request
759
+
760
+ ### 2020-09-14_1.111.13
761
+ - Updated `/transactions/sync` description
762
+
763
+ ### 2020-09-14_1.111.12
764
+ - Add more accurate enum documentations to `/transactions/recurring/get` API doc
765
+
766
+ ### 2020-09-14_1.111.11
767
+ - Additional documentation for `/transactions/sync`
768
+
769
+ ### 2020-09-14_1.111.9
770
+ - Remove deprecated field `createdAt` from `/application/get` response
771
+
772
+ ### 2020-09-14_1.111.8
773
+ - Add field validation to `BankTransferDirection`
774
+
775
+ ### 2020-09-14_1.111.7
776
+ - Remove deprecated field `createdAt` from `/application/get` response
777
+
778
+ ### 2020-09-14_1.111.6
779
+ - Add external doc link to `transactions/recurring/get`
780
+
781
+ ### 2020-09-14_1.111.5
782
+ - Updating the API doc for Recurring Transactions
783
+
784
+ ### 2020-09-14_1.111.4
785
+ - Add `DisplayName` in `/application/get` response
786
+
787
+ ### 2020-09-14_1.111.3
788
+ - Updated sample responses for all Transfer endpoints
789
+
790
+ ### 2020-09-14_1.111.2
791
+ - Changing `beta/transactions/rules/` routes to `beta/transactions/rules/v1`
792
+
793
+ ### 2020-09-14_1.111.1
794
+ - Fixing `InsitututionMetadata` typo to `InstitutionMetadata` in private `/beta/credit/payroll_income/risk_signals/get`endpoint response
795
+
796
+ ### 2020-09-14_1.111.0
797
+ - Added `require_guarantee`, `guarantee_decision`, and `guarantee_decision_rationale` to `/transfer/intent` in order to support Guarantee when using Transfer UI.
798
+
799
+ ### 2020-09-14_1.110.2
800
+ - Add additional supported `type` enums in `WalletTransaction`.
801
+
802
+ ### 2020-09-14_1.110.1
803
+ - Add Additional History billing information for /asset_report/create.
804
+
805
+ ### 2020-09-14_1.110.0
806
+ - Add `user_id` to income verification webhook payload
807
+
808
+ ### 2020-09-14_1.109.1
809
+ - Make `consent_id` field nullable in `PaymentInitiationPayment`.
810
+
811
+ ### 2020-09-14_1.109.0
812
+ - Replace `initiated_refunds` with `refund_ids` in the `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
813
+
814
+ ### 2020-09-14_1.108.0
815
+ - Added `/beta/credit/payroll_income/risk_signals/get` endpoint (currently private)
816
+
817
+ ### 2020-09-14_1.107.4
818
+ - Remove unsupported ACH classes from `bank_transfer/` and `transfer/` endpoints.
819
+
820
+ ### 2020-09-14_1.107.3
821
+ - Add `enable_multiple_items` parameter for bank income.
822
+
823
+ ### 2020-09-14_1.107.2
824
+ - Fix typo in `institution_name` parameter for credit endpoints.
825
+
826
+ ### 2020-09-14_1.107.0
827
+ - Added `reference` and `idempotency_key` fields to the `payment_initiation/payment/reverse` request.
828
+
829
+ ### 2020-09-14_1.106.0
830
+ - Added `is_update_mode` to `income_verification` in the `/link/token/create` body
831
+
832
+ ### 2020-09-14_1.105.2
833
+ - Consolidate item schemas
834
+
835
+ # 15.4.0
836
+ - Updating to OAS 2020-09-14_1.105.1
837
+ - Expose Faraday::Connection object for additional configuration options
838
+
839
+ ## OpenAPI Schema Changes
840
+ ### 2020-09-14_1.105.1
841
+ - Removed `client_id` and `secret` as required fields from `/transfer/intent/{get,create}` to match actual API behavior.
842
+
843
+ ### 2020-09-14_1.105.0
844
+ - Add `/credit/payroll_income/refresh` endpoint
845
+
846
+ ### 2020-09-14_1.104.0
847
+ - Added `/signal/prepare`
848
+
849
+ ### 2020-09-14_1.103.0
850
+ - Add `/transactions/recurring/deactivate` endpoint
851
+
852
+ ### 2020-09-14_1.102.0
853
+ - Added `/watchlist_screening/individual/list` (currently private)
854
+ - Added `/watchlist_screening/individual/create` (currently private)
855
+ - Added `/watchlist_screening/individual/get` (currently private)
856
+ - Added `/watchlist_screening/individual/update` (currently private)
857
+ - Added `/watchlist_screening/individual/history/list` (currently private)
858
+ - Added `/watchlist_screening/individual/review/list` (currently private)
859
+ - Added `/watchlist_screening/individual/review/create` (currently private)
860
+ - Added `/watchlist_screening/individual/hit/list` (currently private)
861
+ - Added `/watchlist_screening/entity/list` (currently private)
862
+ - Added `/watchlist_screening/entity/create` (currently private)
863
+ - Added `/watchlist_screening/entity/get` (currently private)
864
+ - Added `/watchlist_screening/entity/update` (currently private)
865
+ - Added `/watchlist_screening/entity/history/list` (currently private)
866
+ - Added `/watchlist_screening/entity/hit/list` (currently private)
867
+ - Added `/watchlist_screening/entity/review/list` (currently private)
868
+ - Added `/watchlist_screening/entity/review/create` (currently private)
869
+ - Added `/watchlist_screening/individual/program/list` (currently private)
870
+ - Added `/watchlist_screening/individual/program/get` (currently private)
871
+ - Added `/watchlist_screening/entity/program/list` (currently private)
872
+ - Added `/watchlist_screening/entity/program/get` (currently private)
873
+ - Added `/dashboard_user/list` (currently private)
874
+ - Added `/dashboard_user/get` (currently private)
875
+ - Added `/identity_verification/list` (currently private)
876
+ - Added `/identity_verification/get` (currently private)
877
+ - Added `/identity_verification/retry` (currently private)
878
+ - Modified `/identity_verification/create` (currently private)
879
+
880
+ ### 2020-09-14_1.101.0
881
+ - Add endpoint for `/credit/bank_income/refresh`
882
+
883
+ ### 2020-09-14_1.100.0
884
+ - Add `include_original_description`, `include_personal_finance_category` options to `/transactions/sync` request.
885
+
886
+ ### 2020-09-14_1.99.0
887
+ - API changes for /credit/employment/get
888
+
889
+ ### 2020-09-14_1.98.1
890
+ - Add `gusto` as processor partner
891
+
892
+ ### 2020-09-14_1.98.0
893
+ - Add `user_token` as a request parameter for `/sandbox/public_token/create`
894
+
895
+ ### 2020-09-14_1.97.1
896
+ - Remove `auth`, `transactions_updates`, `investments_updates`, and `identity` as required fields from Item status to match actual API behavior.
897
+
898
+ # 15.3.0
899
+ - Updating to OAS 2020-09-14_1.97.0
900
+
901
+ ## OpenAPI Schema Changes
902
+ ### 2020-09-14_1.97.0
903
+ - [Beta] Rename some `Credit` refs that were preventing client library generation from completing successfully
904
+
905
+ ### 2020-09-14_1.96.0
906
+ - remove unused `payroll_income_id` from `/credit/payroll_income/get` field
907
+ - add status object to items in `/credit/payroll_income/get` response body
908
+
909
+ ### 2020-09-14_1.95.1
910
+ - Add `TransferEventsUpdateWebhook` schema
911
+
912
+ ### 2020-09-14_1.95.0
913
+ - Add `institution_data` parameter to `/link/token/create`
914
+
915
+ ### 2020-09-14_1.94.2
916
+ - Tidy up YAML
917
+
918
+ ### 2020-09-14_1.94.1
919
+ - Add `highnote` processor to `/processor/token/create`
920
+
921
+ # 15.2.0
922
+ - Updating to OAS 2020-09-14_1.94.0
923
+
924
+ ## OpenAPI Schema Changes
925
+ ### 2020-09-14_1.94.0
926
+ - Add `use_case`, `company_legal_name`, `city`, `region`, `country_code`, `postal_code` as a required response field of `Application`
927
+
928
+ ### 2020-09-14_1.93.2
929
+ - Remove `income_verification_id` from income webhook example
930
+ - Fix incorrect URL for `/user/create` endpoint
931
+
932
+ ### 2020-09-14_1.93.1
933
+ - Remove deprecated `income_verification_id` from income webhooks
934
+ - Standardize income webhook casing
935
+
936
+ ### 2020-09-14_1.93.0
937
+ - Add several new fields to `/signal/evaluate` response
938
+ -
939
+ ### 2020-09-14_1.92.4
940
+ - Add `/sandbox/transfer/fire_webhook` endpoint
941
+
942
+ ### 2020-09-14_1.91.4
943
+ - Mark certain Income endpoints as deprecated in favor of the new `/credit/*` endpoints.
944
+
945
+ ### 2020-09-14_1.91.3
946
+ - Add `checkout` processor to `/processor/token/create`
947
+
948
+ ### 2020-09-14_1.91.2
949
+ - Add `webhook_type` parameter to `/sandbox/item/fire_webhook`
950
+ - Support for investments transactions, investments holdings and liabilities `DEFAULT_UPDATE` webhooks
951
+
952
+ ### 2020-09-14_1.90.2
953
+ - Add new warning type to `/credit/bank_income/get` response
954
+
955
+ ### 2020-09-14_1.90.1
956
+ - Add `marqeta` and `solid` as Auth processor partners
957
+ - Fix schema of `cause` parameter for Asset Reports
958
+ - Fix some invalid examples
959
+
960
+ ### 2020-09-14_1.90.0
961
+ - Add `/credit/employment/get` endpoint
962
+ - Add optional `access_tokens` array to `/credit/payroll_income/precheck` request
963
+
964
+ ### 2020-09-14_1.89.3
965
+ - Update description of `/sandbox/item/fire_webhook`
966
+
967
+ ### 2020-09-14_1.89.2
968
+ - Update description of `accounts/get`
969
+
970
+ ### 2020-09-14_1.89.1
971
+ - Added `AUTH_DATA_UPDATE` webhook code as valid input to `/sandbox/item/fire_webhook`
972
+ - Update description for `/sandbox/item/fire_webhook`
973
+
974
+ ### 2020-09-14_1.89.0
975
+ - Add `/transfer/migrate_account` endpoint
976
+
977
+ ### 2020-09-14_1.88.2
978
+ - Fix operationId for `/credit/payroll_income/precheck`
979
+
980
+ ### 2020-09-14_1.88.1
981
+ - Remove deprecated fields from `/item/application/list`
982
+
983
+ ### 2020-09-14_1.88.0
984
+ - Add `wire_routing_number` parameter to `/bank_transfer/migrate_account`
985
+
986
+ ### 2020-09-14_1.87.1
987
+ - Specify minimum length of 1 for `description` on `TransferIntentCreateRequest`
988
+
989
+ ### 2020-09-14_1.87.0
990
+ - Add `consent_id` support in the Institutions Search request
991
+
992
+ ### 2020-09-14_1.86.1
993
+ - Add `apex_clearing` as a processor partner
994
+
995
+ ### 2020-09-14_1.86.0
996
+ - Introduce Credit Payroll Income APIs
997
+ - Introduce Credit Precheck API
998
+
999
+ ### 2020-09-14_1.85.1
1000
+ - Add `/identity_verification/create` endpoint, kept private for now
1001
+
1002
+ ### 2020-09-14_1.85.0
1003
+ - Add `status` field to `ConnectedApplication`
1004
+
1005
+ # 15.1.0
1006
+ - Updating to OAS 2020-09-14_1.84.5
1007
+
1008
+ ## OpenAPI Schema Changes
1009
+ ### 2020-09-14_1.84.5
1010
+ - Added missing `asset_report_id` field to `/asset_report/relay/refresh`
1011
+
1012
+ ### 2020-09-14_1.84.4
1013
+ - Change summary description and url for `/credit/bank_income/get`
1014
+
1015
+ ### 2020-09-14_1.84.3
1016
+ - Slight wording change for `/credit/bank_income/get` response fields
1017
+
1018
+ ### 2020-09-14_1.84.3
1019
+ - Move `user_token` to top level of `link/token/create` request
1020
+
1021
+ ### 2020-09-14_1.84.2
1022
+ - Correct typo in enum value for Investment subtypes (`person` -> `pension`)
1023
+
1024
+ ### 2020-09-14_1.84.1
1025
+ - Fix schema to properly handle personal finance categories in `/transactions/get`
1026
+
1027
+ ### 2020-09-14_1.84.0
1028
+ - Add `user_token` parameter to `link/token/create`
1029
+
1030
+ ### 2020-09-14_1.83.1
1031
+ - Add new fields to `/credit/bank_income/get` response
1032
+
1033
+ ### 2020-09-14_1.83.0
1034
+ - Remove `permitted` decision for `/transfer/authorization/create`
1035
+
1036
+ ### 2020-09-14_1.82.0
1037
+ - Add beta field `consented_products` to `/item/get/` endpoint response
1038
+
1039
+ ### 2020-09-14_1.82.0
1040
+ - Revamp LinkTokenCreate.IncomeVerificationOptions for GA
1041
+
1042
+ ### 2020-09-14_1.81.0
1043
+ - Add `/transaction/rules/create`, `/transaction/rules/list` and `/transaction/rules/remove` endpoints
1044
+
1045
+ ### 2020-09-14_1.80.0
1046
+ - Added `/user/create` endpoint
1047
+
1048
+ # 15.0.0
1049
+ - Updating to OAS 2020-09-14_1.79.0
1050
+
1051
+ ## Breaking changes
1052
+ - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
1053
+ - Non integer numbers are now `float64` fields
1054
+
1055
+ ## OpenAPI Schema Changes
1056
+ ### 2020-09-14_1.79.0
1057
+ - Update to include all changes up to `2020-09-14_1.77.4` (Undo revert from `1.78.x` updates)
1058
+
1059
+ ### 2020-09-14_1.77.4
1060
+ - Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects
1061
+
1062
+ ### 2020-09-14_1.77.3
1063
+ - Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects
1064
+
1065
+ ### 2020-09-14_1.77.2
1066
+ - Add `ProductAccess` fields for upcoming partner
1067
+
1068
+ # 14.14.0
1069
+ - Updating to OAS 2020-09-14_1.78.2
1070
+ - Ruby library 14.13.0 was erroneously released as a `minor` version; 14.13.0 changes will be re-released as a `major` version shortly.
1071
+
1072
+ # 14.13.0
1073
+ - Updating to OAS 2020-09-14_1.77.1
1074
+
1075
+ # Breaking changes
1076
+ - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
1077
+
1078
+ ## OpenAPI Schema Changes
1079
+ ### 2020-09-14_1.77.1
1080
+ - Fix extraneous field in enum that caused issue in code generation
1081
+ - Added `asset_report_id` to the example for `/asset_report/relay/refresh`
1082
+
1083
+ ### 2020-09-14_1.77.0
1084
+ - Explicitly set `format: double` for non-integer numbers so generated fields prefer float64
1085
+
1086
+ ### 2020-09-14_1.76.0
1087
+ - Add three new endpoints for Assets: `/asset_report/relay/create`, `/asset_report/relay/get`, and `/asset_report/relay/rmeove`
1088
+
1089
+ ### 2020-09-14_1.75.0
1090
+ - Added `/asset_report/relay/refresh` endpoint
1091
+
1092
+ ### 2020-09-14_1.74.0
1093
+ - Add `recurring_transactions` to list of products
1094
+
1095
+ ### 2020-09-14_1.73.0
1096
+ - Add new endpoint for `/credit/bank_income/get`
1097
+
1098
+ ### 2020-09-14_1.72.0
1099
+ - Updated documentation URLs for all product endpoints. They can now be found
1100
+ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
1101
+
1102
+ ### 2020-09-14_1.71.0
1103
+ - internal changes
1104
+
1105
+ ### 2020-09-14_1.70.0
1106
+ - Remove deprecated `income_verification_id` from `/sandbox/income/fire_webhook`
1107
+
1108
+ ### 2020-09-14_1.69.1
1109
+ - Reorder processors enum
1110
+
1111
+ ### 2020-09-14_1.69.0
1112
+ - Added `/beta/transactions/v1/enhance` endpoint
1113
+
1114
+ ### 2020-09-14_1.68.1
1115
+ - Added `status` object to sample responses for `/institutions/get` and `institutions/search` endpoints
1116
+
1117
+ ### 2020-09-14_1.68.0
1118
+ - Mark `include_personal_finance_category_beta` property as deprecated.
1119
+ - Add new argument `include_personal_finance_category` to TransactionsGetRequestOptions.
1120
+ - Update docs for `/transactions/get` request and response, referencing personal_finance_category taxonomy csv file.
1121
+
1122
+ ### 2020-09-14_1.67.1
1123
+ - internal changes
1124
+
1125
+ ### 2020-09-14_1.67.0
1126
+ - Removed unused `/income/verification/summary/get` endpoint
1127
+
1128
+ ### 2020-09-14_1.66.0
1129
+ - Added Payment Consent endpoints
1130
+
1131
+ ### 2020-09-14_1.65.0
1132
+ - Removed unused `/income/verification/paystub/get` endpoint
1133
+
1134
+ ### 2020-09-14_1.64.15
1135
+ - De-anonymized enums:
1136
+ - `PaymentInitiationPaymentReverseResponse.properties.status` => `PaymentInitiationRefundStatus`
1137
+ - `PaymentInitiationPaymentCreateResponse.properties.status` => `PaymentInitiationPaymentCreateStatus`
1138
+ - `PaymentInitiationRefund.properties.status` => `PaymentInitiationRefundStatus`
1139
+ - `PaymentAmount.properties.currency` => `PaymentAmountCurrency`
1140
+ - `InvestmentTransaction.properties.type` => `InvestmentTransactionType`
1141
+ - `InvestmentTransaction.properties.subtype` => `InvestmentTransactionSubtype`
1142
+ - `TransferAuthorizationDecisionRationale.properties.code` => `TransferAuthorizationDecisionRationaleCode`
1143
+ - `TransferAuthorizationGuaranteeDecisionRationale.properties.code` => `TransferAuthorizationGuaranteeDecisionRationaleCode`
1144
+ - `TransferAuthorization.properties.decision` => `TransferAuthorizationDecision`
1145
+ - `TransferEventListRequest.properties.transfer_type` => `TransferEventListTransferType`
1146
+ - `BankTransferEventListRequest.properties.bank_transfer_type` => `BankTransferEventListBankTransferType`
1147
+ - `BankTransferEventListRequest.properties.direction` => `BankTransferEventListDirection`
1148
+ - `TransferIntentCreate.properties.status` => `TransferIntentStatus`
1149
+ - `TransferIntentGet.properties.status` => `TransferIntentStatus`
1150
+ - `TransferIntentGet.properties.authorization_decision` => `TransferIntentAuthorizationDecision`
1151
+ - `IncomeVerificationPrecheckMilitaryInfo.properties.branch` is now a string field (previously enum)
1152
+
1153
+ ### 2020-09-14_1.64.15
1154
+ - Made `last_statement_balance` and `minimum_payment_amount` `nullable` for credit card liabilities schema to reflect existing API behavior.
1155
+
1156
+ ### 2020-09-14_1.64.14
1157
+ - Made `last_payment_amount` and `last_statement_issue_date` `nullable` for credit card liabilities schema to reflect existing API behavior.
1158
+ - Fix transfers examples to reflect more consistent usage of `region` field.
1159
+
1160
+ # 14.12.1
1161
+ - Updating to OAS 2020-09-14_1.64.13
1162
+ - Fix issue where library did not correctly detect if app is a Rails app.
1163
+
1164
+ ## OpenAPI Schema Changes
1165
+ ### 2020-09-14_1.64.13
1166
+ - Deprecate `idempotency_key` parameter in transfer/create
1167
+
1168
+ ### 2020-09-14_1.64.12
1169
+ - Removed the unused `required_product_access` and `optional_product_access` parameters from `RequestedScopes`
1170
+
1171
+ ### 2020-09-14_1.64.11
1172
+ - Fix some examples that were not consistent with their schemas
1173
+ - Add `adjustments` as an investments transaction type to make OpenAPI file consistent with values returned by the API
1174
+ - Clarify description field for `marital_status` to reflect possible values
1175
+
1176
+ ### 2020-09-14_1.64.10
1177
+ - Updated the external docs URL for Bank Transfers sandbox endpoints
1178
+
1179
+ ### 2020-09-14_1.64.9
1180
+ - De-anonymized the object filters under `LinkTokenCreateRequestAccountSubtypes`, as anonymous objects aren't compatible with the generated CLibs.
1181
+ - De-anonymized some misc. objects
1182
+ - `PaymentInitiationMetadata/properties/maximum_payment_amount`
1183
+ - `PaystubOverride/properties/employer`
1184
+ - `PaystubOverride/properties/employee`
1185
+ - `PaystubOverride/properties/employee/properties/address`
1186
+ - `LiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities`
1187
+
1188
+ ### 2020-09-14_1.64.8
1189
+ - Updated the description of the historical_balances array
1190
+
1191
+ ### 2020-09-14_1.64.7
1192
+ - Add new possible enums for income verification earnings breakdown canonical description
1193
+
1194
+ ### 2020-09-14_1.64.6
1195
+ - Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only.
1196
+
1197
+ ### 2020-09-14_1.64.5
1198
+ - Make guarantee fields required in Transfer endpoints
1199
+
1200
+ ### 2020-09-14_1.64.4
1201
+ - Updated description for `failure_reason` field in Transfer endpoints
1202
+
1203
+ ### 2020-09-14_1.64.3
1204
+ - Make `repayment_id` required in `/transfer/repayment/return/list` endpoint
1205
+
1206
+ ### 2020-09-14_1.64.2
1207
+ - Update description for legal name field in `BankTransferUser`
1208
+
1209
+ ### 2020-09-14_1.64.1
1210
+ - Update descriptions for `/transfer/repayment/list` and `/transfer/repayment/return/list` endpoints
1211
+
1212
+ ### 2020-09-14_1.64.0
1213
+ - Remove `scheme_automatic_downgrade` from `/payment_initiation/payment/create`
1214
+
1215
+ ### 2020-09-14_1.63.1
1216
+ - Update description for `/sandbox/transfer/sweep/simulate` endpoint
1217
+
1218
+ ### 2020-09-14_1.63.0
1219
+ - Refactor account subtype enums for greater specificity. This has no changes to the API but is a major semver change for Python, Node, Go, and Java client library interfaces to the AccountSubtype object within account filtering contexts in `/link/token/create`. The `AccountSubtype` namespace in this context is now prefixed with the AccountType. (Example for Node: Old: `AccountSubtype.checking` New: `DepositoryAccountSubtype.checking`)
1220
+
1221
+ ### 2020-09-14_1.62.7
1222
+ - Update description for `datetime` and `authorized_datetime` fields in Transactions endpoints
1223
+
1224
+ ### 2020-09-14_1.62.6
1225
+ - Make `sweep_id` / `sweep_amount` fields on Transfer Event nullable
1226
+
1227
+ ### 2020-09-14_1.62.6
1228
+ - Set `institution_status` to be nullable in `InstitutionsGetResponse`
1229
+
1230
+ ### 2020-09-14_1.62.5
1231
+ - Update external docs URLs for Transfer and Bank Transfer endpoints
1232
+ - Update description for `ach_return_code` field in Transfer endpoints
1233
+
1234
+ ### 2020-09-14_1.62.4
1235
+ - Add `join_date` to `/application/get` and `/item/application/list`
1236
+ - Remove `created_at` from `/application/get`
1237
+
1238
+ ### 2020-09-14_1.62.3
1239
+ - Updated various description fields for Income
1240
+
1241
+ ### 2020-09-14_1.62.2
1242
+ - Add `employment` as an available product in Product array.
1243
+
1244
+ # 14.12.0
1245
+ - Updating to OAS 2020-09-14_1.62.1
1246
+
1247
+ # 14.11.1
1248
+ - Added a release step to the `Makefile` to purge previously released version of plaid-ruby in the current release.
1249
+
1250
+ # 14.11.0
1251
+ - Updating to OAS 2020-09-14_1.61.0
1252
+
1253
+ # 14.10.0
1254
+ - Updating to OAS 2020-09-14_1.58.1
1255
+
1256
+ # 14.9.0
1257
+ - Updating to OAS 2020-09-14_1.54.2
1258
+
1259
+ # 14.8.0
1260
+ - Updating to OAS 2020-09-14_1.46.1
1261
+
1262
+ # 14.7.0
1263
+ - Updating to OAS 2020-09-14_1.44.0
1264
+
1265
+ # 14.6.0
1266
+ - Updating to OAS 2020-09-14_1.40.3
1267
+
1268
+ # 14.5.0
1269
+ - Updating to OAS 2020-09-14_1.36.4
1270
+
1271
+ # 14.4.0
1272
+ - Updating to OAS 2020-09-14_1.34.1
1273
+ - Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle
1274
+ new enum values being returned from endpoints. Previously, if there were new enum values
1275
+ endpoint calls would fail.
1276
+
1277
+ # 14.3.0
1278
+ Updating to OAS 2020-09-14_1.33.0.
1279
+
1280
+ # 14.2.0
1281
+ Updating to OAS 2020-09-14_1.31.1.
1282
+
1283
+ # 14.1.0
1284
+ Updating to OAS 2020-09-14_1.26.1.
1285
+
1286
+ # 14.0.0
1287
+ The official release of the `plaid-ruby` generated library. Refer to the beta migration guide for tips on migrating from older version of the libraries.
1288
+
1289
+ This particular version is pinned to OpenAPI version `2020-09-14_1.20.6`.
1290
+
1291
+ # 14.0.0.beta.5
1292
+ Generated from OAS version 2020-09-14_1.16.4. See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1293
+
1294
+ # 14.0.0.beta.4
1295
+ See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1296
+ - Remove validation for `maxProperties` due to generator bug.
1297
+
1298
+ # 14.0.0.beta.3
1299
+ Type fixes, see full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1300
+
1301
+ # 14.0.0.beta.1
1302
+
1303
+ This version represents a transition in how we maintain our external client libraries. We are now using an [API spec](https://github.com/plaid/plaid-openapi) written in `OpenAPI 3.0.0` and running our definition file through [OpenAPITool's `ruby` generator](https://github.com/OpenAPITools/openapi-generator).
1304
+
1305
+ The minimum required ruby version is 2.4.0.
1306
+
1307
+ **Ruby Migration Guide:**
1308
+
1309
+ ### Client initialization
1310
+ From:
1311
+ ```ruby
1312
+ client = Plaid::Client.new(env: :sandbox,
1313
+ client_id: client_id,
1314
+ secret: secret)
1315
+ ```
1316
+
1317
+ To:
1318
+ ```ruby
1319
+ configuration = Plaid::Configuration.new
1320
+ configuration.server_index = Plaid::Configuration::Environment["sandbox"]
1321
+ configuration.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_RUBY_CLIENT_ID"]
1322
+ configuration.api_key["PLAID-SECRET"] = ENV["PLAID_RUBY_SECRET"]
1323
+ configuration.api_key["Plaid-Version"] = "2020-09-14"
1324
+
1325
+ api_client = Plaid::ApiClient.new(
1326
+ configuration
1327
+ )
1328
+
1329
+ client = Plaid::PlaidApi.new(api_client)
1330
+ ```
1331
+
1332
+ ### Endpoints
1333
+ All endpoint requests now take a request model and the functions have been renamed to include `_`.
1334
+
1335
+ From:
1336
+ ```ruby
1337
+ response = client.auth.get(access_token)
1338
+ ```
1339
+
1340
+ To:
1341
+ ```ruby
1342
+ auth_get_request = Plaid::AuthGetRequest.new
1343
+ auth_get_request.access_token = access_token
1344
+
1345
+ or
1346
+
1347
+ auth_get_request = Plaid::AuthGetRequest.new({:access_token => access_token})
1348
+
1349
+ response = client.auth_get(auth_get_request)
1350
+ ```
1351
+
1352
+ ### Errors
1353
+
1354
+ From:
1355
+ ```ruby
1356
+ begin
1357
+ client.auth.get(auth_get_request)
1358
+ rescue Plaid::PlaidAPIError => e
1359
+ raise e if e.error_code != 'PRODUCT_NOT_READY'
1360
+ sleep 1
1361
+ end
1362
+ ```
1363
+
1364
+ To:
1365
+ ```ruby
1366
+ begin
1367
+ client.auth_get(auth_get_request)
1368
+ rescue Plaid::ApiError => e
1369
+ json_response = JSON.parse(e.response_body)
1370
+ if json_response["error_code"] != "PRODUCT_NOT_READY"
1371
+ end
1372
+ ```
1373
+
1374
+ # 13.2.0
2
1375
  - Add support for `options` to `/payment_initiation/payment/create`
3
1376
 
4
1377
  # 13.1.0