plaid 14.0.0.beta.2 → 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown

Sign up to get free protection for your applications and to get access to all the features.
Files changed (651) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -1
  3. data/Gemfile.lock +19 -5
  4. data/LICENSE.txt +1 -1
  5. data/Makefile +2 -21
  6. data/PUBLISH.md +2 -3
  7. data/README.md +4 -4
  8. data/lib/plaid/api/plaid_api.rb +274 -116
  9. data/lib/plaid/api_client.rb +2 -2
  10. data/lib/plaid/api_error.rb +2 -2
  11. data/lib/plaid/configuration.rb +2 -2
  12. data/lib/plaid/models/account_assets.rb +3 -3
  13. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  14. data/lib/plaid/models/account_balance.rb +18 -7
  15. data/lib/plaid/models/account_base.rb +3 -3
  16. data/lib/plaid/models/account_filters_response.rb +2 -2
  17. data/lib/plaid/models/account_identity.rb +3 -3
  18. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  19. data/lib/plaid/models/account_subtype.rb +3 -2
  20. data/lib/plaid/models/account_type.rb +2 -2
  21. data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
  22. data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
  23. data/lib/plaid/models/accounts_get_request.rb +4 -4
  24. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  25. data/lib/plaid/models/accounts_get_response.rb +2 -2
  26. data/lib/plaid/models/ach_class.rb +2 -2
  27. data/lib/plaid/models/address.rb +2 -2
  28. data/lib/plaid/models/address_data.rb +2 -2
  29. data/lib/plaid/models/application.rb +273 -0
  30. data/lib/plaid/models/application_get_request.rb +255 -0
  31. data/lib/plaid/models/{link_token_create_request_account_subtypes_investment.rb → application_get_response.rb} +33 -16
  32. data/lib/plaid/models/apr.rb +2 -2
  33. data/lib/plaid/models/asset_report.rb +2 -2
  34. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
  35. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  36. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
  37. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
  38. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  39. data/lib/plaid/models/asset_report_create_request.rb +28 -4
  40. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  41. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  42. data/lib/plaid/models/asset_report_filter_request.rb +4 -4
  43. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  44. data/lib/plaid/models/asset_report_get_request.rb +5 -5
  45. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  46. data/lib/plaid/models/asset_report_item.rb +2 -2
  47. data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
  48. data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
  49. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  50. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  51. data/lib/plaid/models/asset_report_remove_request.rb +4 -4
  52. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  53. data/lib/plaid/models/asset_report_transaction.rb +28 -6
  54. data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
  55. data/lib/plaid/models/asset_report_user.rb +2 -2
  56. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  57. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  58. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  59. data/lib/plaid/models/auth_get_request.rb +4 -4
  60. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  61. data/lib/plaid/models/auth_get_response.rb +2 -2
  62. data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
  63. data/lib/plaid/models/bank_transfer.rb +11 -2
  64. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  65. data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
  66. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  67. data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
  68. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  69. data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
  70. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  71. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  72. data/lib/plaid/models/bank_transfer_event.rb +4 -2
  73. data/lib/plaid/models/bank_transfer_event_list_request.rb +8 -4
  74. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  75. data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
  76. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  77. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  78. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  79. data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
  80. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  81. data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
  82. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  83. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
  84. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_receiver_details.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  89. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  90. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  91. data/lib/plaid/models/categories_get_response.rb +2 -2
  92. data/lib/plaid/models/category.rb +2 -2
  93. data/lib/plaid/models/cause.rb +2 -2
  94. data/lib/plaid/models/country_code.rb +2 -2
  95. data/lib/plaid/models/credit_card_liability.rb +3 -18
  96. data/lib/plaid/models/credit_filter.rb +2 -2
  97. data/lib/plaid/models/default_update_webhook.rb +2 -2
  98. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  99. data/lib/plaid/models/deposit_switch_alt_create_request.rb +4 -4
  100. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  101. data/lib/plaid/models/deposit_switch_create_request.rb +4 -4
  102. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  103. data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
  104. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  105. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  106. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  107. data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
  108. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  109. data/lib/plaid/models/depository_filter.rb +2 -2
  110. data/lib/plaid/models/email.rb +2 -2
  111. data/lib/plaid/models/employee.rb +2 -2
  112. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  113. data/lib/plaid/models/employer.rb +2 -2
  114. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  115. data/lib/plaid/models/employers_search_request.rb +4 -4
  116. data/lib/plaid/models/employers_search_response.rb +2 -2
  117. data/lib/plaid/models/error.rb +4 -4
  118. data/lib/plaid/models/{item_status_transactions.rb → external_payment_options.rb} +33 -23
  119. data/lib/plaid/models/{link_token_create_request_account_subtypes_depository.rb → external_payment_refund_details.rb} +34 -16
  120. data/lib/plaid/models/external_payment_schedule.rb +7 -7
  121. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  122. data/lib/plaid/models/health_incident.rb +2 -2
  123. data/lib/plaid/models/historical_balance.rb +2 -2
  124. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  125. data/lib/plaid/models/holding.rb +3 -3
  126. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  127. data/lib/plaid/models/identity_get_request.rb +4 -4
  128. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  129. data/lib/plaid/models/identity_get_response.rb +2 -2
  130. data/lib/plaid/models/incident_update.rb +2 -2
  131. data/lib/plaid/models/income_breakdown.rb +2 -2
  132. data/lib/plaid/models/income_summary.rb +2 -2
  133. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  134. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  135. data/lib/plaid/models/income_verification_create_request.rb +4 -4
  136. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  137. data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
  138. data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
  139. data/lib/plaid/models/income_verification_paystub_get_request.rb +4 -4
  140. data/lib/plaid/models/income_verification_paystub_get_response.rb +2 -2
  141. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  142. data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
  143. data/lib/plaid/models/income_verification_summary_get_response.rb +2 -2
  144. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  145. data/lib/plaid/models/inflow_model.rb +2 -2
  146. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  147. data/lib/plaid/models/institution.rb +16 -6
  148. data/lib/plaid/models/institution_status.rb +2 -2
  149. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
  150. data/lib/plaid/models/institutions_get_by_id_request_options.rb +19 -7
  151. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  152. data/lib/plaid/models/institutions_get_request.rb +27 -4
  153. data/lib/plaid/models/institutions_get_request_options.rb +20 -8
  154. data/lib/plaid/models/institutions_get_response.rb +3 -3
  155. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  156. data/lib/plaid/models/{item_status_last_webhook.rb → institutions_search_payment_initiation_options.rb} +14 -26
  157. data/lib/plaid/models/institutions_search_request.rb +25 -4
  158. data/lib/plaid/models/institutions_search_request_options.rb +23 -10
  159. data/lib/plaid/models/institutions_search_response.rb +2 -2
  160. data/lib/plaid/models/investment_filter.rb +2 -2
  161. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  162. data/lib/plaid/models/investment_transaction.rb +4 -3
  163. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  164. data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
  165. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  166. data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
  167. data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
  168. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  169. data/lib/plaid/models/item.rb +43 -3
  170. data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
  171. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  172. data/lib/plaid/models/item_error_webhook.rb +2 -2
  173. data/lib/plaid/models/item_get_request.rb +4 -4
  174. data/lib/plaid/models/item_get_response.rb +6 -16
  175. data/lib/plaid/models/item_import_request.rb +25 -4
  176. data/lib/plaid/models/item_import_request_options.rb +2 -2
  177. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  178. data/lib/plaid/models/item_import_response.rb +2 -2
  179. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  180. data/lib/plaid/models/item_public_token_create_request.rb +4 -4
  181. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  182. data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
  183. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  184. data/lib/plaid/models/item_remove_request.rb +4 -4
  185. data/lib/plaid/models/item_remove_response.rb +2 -2
  186. data/lib/plaid/models/item_status.rb +17 -8
  187. data/lib/plaid/models/item_webhook_update_request.rb +4 -4
  188. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  189. data/lib/plaid/models/jwk_public_key.rb +42 -2
  190. data/lib/plaid/models/jwt_header.rb +2 -2
  191. data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
  192. data/lib/plaid/models/liabilities_get_request.rb +4 -4
  193. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  194. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  195. data/lib/plaid/models/liabilities_object.rb +2 -2
  196. data/lib/plaid/models/liability_override.rb +7 -24
  197. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  198. data/lib/plaid/models/link_token_create_request.rb +51 -12
  199. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +22 -10
  200. data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
  201. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  202. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  203. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  204. data/lib/plaid/models/link_token_create_request_user.rb +4 -4
  205. data/lib/plaid/models/link_token_create_response.rb +3 -3
  206. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  207. data/lib/plaid/models/link_token_get_request.rb +4 -4
  208. data/lib/plaid/models/link_token_get_response.rb +2 -2
  209. data/lib/plaid/models/loan_filter.rb +2 -2
  210. data/lib/plaid/models/location.rb +2 -2
  211. data/lib/plaid/models/meta.rb +2 -2
  212. data/lib/plaid/models/mfa.rb +2 -2
  213. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  214. data/lib/plaid/models/mortgage_liability.rb +2 -2
  215. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  216. data/lib/plaid/models/nullable_access_token.rb +2 -2
  217. data/lib/plaid/models/nullable_address.rb +2 -2
  218. data/lib/plaid/models/nullable_address_data.rb +2 -2
  219. data/lib/plaid/models/nullable_item_status.rb +17 -8
  220. data/lib/plaid/models/nullable_numbers_ach.rb +4 -4
  221. data/lib/plaid/models/nullable_numbers_bacs.rb +2 -2
  222. data/lib/plaid/models/nullable_numbers_eft.rb +2 -2
  223. data/lib/plaid/models/nullable_numbers_international.rb +2 -2
  224. data/lib/plaid/models/nullable_recipient_bacs.rb +2 -2
  225. data/lib/plaid/models/numbers.rb +2 -2
  226. data/lib/plaid/models/numbers_ach.rb +4 -4
  227. data/lib/plaid/models/numbers_bacs.rb +2 -2
  228. data/lib/plaid/models/numbers_eft.rb +2 -2
  229. data/lib/plaid/models/numbers_international.rb +2 -2
  230. data/lib/plaid/models/override_accounts.rb +2 -2
  231. data/lib/plaid/models/owner.rb +3 -3
  232. data/lib/plaid/models/owner_override.rb +2 -2
  233. data/lib/plaid/models/pay_frequency.rb +2 -2
  234. data/lib/plaid/models/pay_period_details.rb +2 -2
  235. data/lib/plaid/models/payment_amount.rb +38 -4
  236. data/lib/plaid/models/payment_initiation_address.rb +19 -2
  237. data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
  238. data/lib/plaid/models/{payment_initiation_recipient_bacs.rb → payment_initiation_optional_restriction_bacs.rb} +14 -15
  239. data/lib/plaid/models/payment_initiation_payment.rb +395 -0
  240. data/lib/plaid/models/payment_initiation_payment_create_request.rb +20 -10
  241. data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
  242. data/lib/plaid/models/payment_initiation_payment_get_request.rb +4 -4
  243. data/lib/plaid/models/payment_initiation_payment_get_response.rb +77 -22
  244. data/lib/plaid/models/payment_initiation_payment_list_request.rb +8 -4
  245. data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
  246. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +4 -4
  247. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
  248. data/lib/plaid/models/payment_initiation_recipient.rb +21 -10
  249. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +5 -4
  250. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  251. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +4 -4
  252. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +22 -3
  253. data/lib/plaid/models/{link_token_create_request_account_subtypes_loan.rb → payment_initiation_recipient_get_response_all_of.rb} +13 -16
  254. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
  255. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  256. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
  257. data/lib/plaid/models/payment_meta.rb +3 -3
  258. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  259. data/lib/plaid/models/payment_status_update_webhook.rb +47 -3
  260. data/lib/plaid/models/paystub.rb +6 -4
  261. data/lib/plaid/models/paystub_deduction.rb +2 -2
  262. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  263. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  264. data/lib/plaid/models/phone_number.rb +2 -2
  265. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
  266. data/lib/plaid/models/processor_auth_get_request.rb +4 -4
  267. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  268. data/lib/plaid/models/processor_balance_get_request.rb +4 -4
  269. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  270. data/lib/plaid/models/processor_identity_get_request.rb +4 -4
  271. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  272. data/lib/plaid/models/processor_number.rb +2 -2
  273. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
  274. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  275. data/lib/plaid/models/processor_token_create_request.rb +5 -5
  276. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  277. data/lib/plaid/models/product_status.rb +2 -2
  278. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  279. data/lib/plaid/models/products.rb +3 -2
  280. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  281. data/lib/plaid/models/pslf_status.rb +2 -2
  282. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  283. data/lib/plaid/models/recipient_bacs.rb +2 -2
  284. data/lib/plaid/models/{item_status_investments.rb → sandbox_bank_transfer_fire_webhook_request.rb} +36 -23
  285. data/lib/plaid/models/{link_token_create_request_account_subtypes_credit.rb → sandbox_bank_transfer_fire_webhook_response.rb} +19 -16
  286. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
  287. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  288. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
  289. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  290. data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
  291. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  292. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
  293. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  294. data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
  295. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  296. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  297. data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
  298. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  299. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  300. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  301. data/lib/plaid/models/security.rb +5 -8
  302. data/lib/plaid/models/servicer_address_data.rb +2 -2
  303. data/lib/plaid/models/standalone_account_type.rb +2 -2
  304. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  305. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
  306. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  307. data/lib/plaid/models/student_loan.rb +4 -15
  308. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  309. data/lib/plaid/models/student_loan_status.rb +2 -2
  310. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  311. data/lib/plaid/models/transaction.rb +28 -6
  312. data/lib/plaid/models/transaction_code.rb +2 -2
  313. data/lib/plaid/models/transaction_data.rb +2 -2
  314. data/lib/plaid/models/transaction_override.rb +21 -21
  315. data/lib/plaid/models/transactions_get_request.rb +4 -4
  316. data/lib/plaid/models/transactions_get_request_options.rb +6 -2
  317. data/lib/plaid/models/transactions_get_response.rb +2 -2
  318. data/lib/plaid/models/transactions_refresh_request.rb +9 -4
  319. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  320. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  321. data/lib/plaid/models/user_custom_password.rb +2 -2
  322. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  323. data/lib/plaid/models/verification_expired_webhook.rb +3 -3
  324. data/lib/plaid/models/verification_status.rb +2 -2
  325. data/lib/plaid/models/warning.rb +2 -2
  326. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  327. data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
  328. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  329. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  330. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  331. data/lib/plaid/version.rb +3 -3
  332. data/lib/plaid.rb +20 -11
  333. data/pkg/plaid-14.2.0.gem +0 -0
  334. data/plaid.gemspec +3 -3
  335. data/templates/ruby/partial_model_generic.mustache +362 -0
  336. data/test/test_bank_transfers.rb +1 -1
  337. data/test/test_item.rb +2 -2
  338. data/test/test_payment_initiation.rb +1 -2
  339. metadata +23 -324
  340. data/docs/ACHClass.md +0 -15
  341. data/docs/APR.md +0 -24
  342. data/docs/AccountAssets.md +0 -40
  343. data/docs/AccountAssetsAllOf.md +0 -24
  344. data/docs/AccountBalance.md +0 -26
  345. data/docs/AccountBase.md +0 -32
  346. data/docs/AccountFiltersResponse.md +0 -24
  347. data/docs/AccountIdentity.md +0 -34
  348. data/docs/AccountIdentityAllOf.md +0 -18
  349. data/docs/AccountSubtype.md +0 -15
  350. data/docs/AccountType.md +0 -15
  351. data/docs/AccountsBalanceGetRequest.md +0 -24
  352. data/docs/AccountsBalanceGetRequestOptions.md +0 -18
  353. data/docs/AccountsGetRequest.md +0 -24
  354. data/docs/AccountsGetRequestOptions.md +0 -18
  355. data/docs/AccountsGetResponse.md +0 -22
  356. data/docs/Address.md +0 -20
  357. data/docs/AddressData.md +0 -26
  358. data/docs/Amount.md +0 -20
  359. data/docs/AssetReport.md +0 -28
  360. data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
  361. data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
  362. data/docs/AssetReportAuditCopyGetRequest.md +0 -22
  363. data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
  364. data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
  365. data/docs/AssetReportCreateRequest.md +0 -26
  366. data/docs/AssetReportCreateRequestOptions.md +0 -22
  367. data/docs/AssetReportCreateResponse.md +0 -22
  368. data/docs/AssetReportFilterRequest.md +0 -24
  369. data/docs/AssetReportFilterResponse.md +0 -22
  370. data/docs/AssetReportGetRequest.md +0 -24
  371. data/docs/AssetReportGetResponse.md +0 -22
  372. data/docs/AssetReportItem.md +0 -26
  373. data/docs/AssetReportPDFGetRequest.md +0 -22
  374. data/docs/AssetReportRefreshRequest.md +0 -26
  375. data/docs/AssetReportRefreshRequestOptions.md +0 -22
  376. data/docs/AssetReportRefreshResponse.md +0 -22
  377. data/docs/AssetReportRemoveRequest.md +0 -22
  378. data/docs/AssetReportRemoveResponse.md +0 -20
  379. data/docs/AssetReportTransaction.md +0 -58
  380. data/docs/AssetReportTransactionAllOf.md +0 -20
  381. data/docs/AssetReportUser.md +0 -30
  382. data/docs/AssetsErrorWebhook.md +0 -24
  383. data/docs/AssetsProductReadyWebhook.md +0 -22
  384. data/docs/AuthGetNumbers.md +0 -24
  385. data/docs/AuthGetRequest.md +0 -24
  386. data/docs/AuthGetRequestOptions.md +0 -18
  387. data/docs/AuthGetResponse.md +0 -24
  388. data/docs/AutomaticallyVerifiedWebhook.md +0 -24
  389. data/docs/BankTransfer.md +0 -50
  390. data/docs/BankTransferBalance.md +0 -20
  391. data/docs/BankTransferBalanceGetRequest.md +0 -22
  392. data/docs/BankTransferBalanceGetResponse.md +0 -22
  393. data/docs/BankTransferCancelRequest.md +0 -22
  394. data/docs/BankTransferCancelResponse.md +0 -18
  395. data/docs/BankTransferCreateRequest.md +0 -46
  396. data/docs/BankTransferCreateResponse.md +0 -20
  397. data/docs/BankTransferDirection.md +0 -15
  398. data/docs/BankTransferEvent.md +0 -40
  399. data/docs/BankTransferEventListRequest.md +0 -40
  400. data/docs/BankTransferEventListResponse.md +0 -20
  401. data/docs/BankTransferEventSyncRequest.md +0 -24
  402. data/docs/BankTransferEventSyncResponse.md +0 -20
  403. data/docs/BankTransferEventType.md +0 -15
  404. data/docs/BankTransferFailure.md +0 -20
  405. data/docs/BankTransferGetRequest.md +0 -22
  406. data/docs/BankTransferGetResponse.md +0 -20
  407. data/docs/BankTransferListRequest.md +0 -32
  408. data/docs/BankTransferListResponse.md +0 -20
  409. data/docs/BankTransferMigrateAccountRequest.md +0 -26
  410. data/docs/BankTransferMigrateAccountResponse.md +0 -22
  411. data/docs/BankTransferNetwork.md +0 -15
  412. data/docs/BankTransferReceiverDetails.md +0 -18
  413. data/docs/BankTransferStatus.md +0 -15
  414. data/docs/BankTransferType.md +0 -15
  415. data/docs/BankTransferUser.md +0 -22
  416. data/docs/CategoriesGetResponse.md +0 -20
  417. data/docs/Category.md +0 -22
  418. data/docs/Cause.md +0 -20
  419. data/docs/CountryCode.md +0 -15
  420. data/docs/CreditCardLiability.md +0 -34
  421. data/docs/CreditFilter.md +0 -18
  422. data/docs/DefaultUpdateWebhook.md +0 -26
  423. data/docs/DepositSwitchAddressData.md +0 -26
  424. data/docs/DepositSwitchAltCreateRequest.md +0 -24
  425. data/docs/DepositSwitchAltCreateResponse.md +0 -20
  426. data/docs/DepositSwitchCreateRequest.md +0 -24
  427. data/docs/DepositSwitchCreateResponse.md +0 -20
  428. data/docs/DepositSwitchGetRequest.md +0 -22
  429. data/docs/DepositSwitchGetResponse.md +0 -38
  430. data/docs/DepositSwitchTargetAccount.md +0 -24
  431. data/docs/DepositSwitchTargetUser.md +0 -28
  432. data/docs/DepositSwitchTokenCreateRequest.md +0 -22
  433. data/docs/DepositSwitchTokenCreateResponse.md +0 -22
  434. data/docs/DepositoryFilter.md +0 -18
  435. data/docs/Email.md +0 -22
  436. data/docs/Employee.md +0 -22
  437. data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
  438. data/docs/Employer.md +0 -24
  439. data/docs/EmployerIncomeSummaryFieldString.md +0 -20
  440. data/docs/EmployersSearchRequest.md +0 -24
  441. data/docs/EmployersSearchResponse.md +0 -20
  442. data/docs/Error.md +0 -34
  443. data/docs/ExternalPaymentSchedule.md +0 -24
  444. data/docs/HealthIncident.md +0 -24
  445. data/docs/HistoricalBalance.md +0 -24
  446. data/docs/HistoricalUpdateWebhook.md +0 -26
  447. data/docs/Holding.md +0 -34
  448. data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
  449. data/docs/IdentityGetRequest.md +0 -24
  450. data/docs/IdentityGetRequestOptions.md +0 -18
  451. data/docs/IdentityGetResponse.md +0 -22
  452. data/docs/IncidentUpdate.md +0 -22
  453. data/docs/IncomeBreakdown.md +0 -24
  454. data/docs/IncomeSummary.md +0 -30
  455. data/docs/IncomeSummaryFieldNumber.md +0 -20
  456. data/docs/IncomeSummaryFieldString.md +0 -20
  457. data/docs/IncomeVerificationCreateRequest.md +0 -22
  458. data/docs/IncomeVerificationCreateResponse.md +0 -20
  459. data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
  460. data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
  461. data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
  462. data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
  463. data/docs/IncomeVerificationStatusWebhook.md +0 -24
  464. data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
  465. data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
  466. data/docs/IncomeVerificationWebhookStatus.md +0 -18
  467. data/docs/InflowModel.md +0 -26
  468. data/docs/InitialUpdateWebhook.md +0 -26
  469. data/docs/Institution.md +0 -36
  470. data/docs/InstitutionStatus.md +0 -30
  471. data/docs/InstitutionsGetByIdRequest.md +0 -26
  472. data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
  473. data/docs/InstitutionsGetByIdResponse.md +0 -20
  474. data/docs/InstitutionsGetRequest.md +0 -28
  475. data/docs/InstitutionsGetRequestOptions.md +0 -24
  476. data/docs/InstitutionsGetResponse.md +0 -22
  477. data/docs/InstitutionsSearchAccountFilter.md +0 -24
  478. data/docs/InstitutionsSearchRequest.md +0 -28
  479. data/docs/InstitutionsSearchRequestOptions.md +0 -22
  480. data/docs/InstitutionsSearchResponse.md +0 -20
  481. data/docs/InvestmentFilter.md +0 -18
  482. data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
  483. data/docs/InvestmentTransaction.md +0 -44
  484. data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
  485. data/docs/InvestmentsHoldingsGetRequest.md +0 -24
  486. data/docs/InvestmentsHoldingsGetResponse.md +0 -26
  487. data/docs/InvestmentsTransactionsGetRequest.md +0 -28
  488. data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
  489. data/docs/InvestmentsTransactionsGetResponse.md +0 -28
  490. data/docs/Item.md +0 -32
  491. data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
  492. data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
  493. data/docs/ItemErrorWebhook.md +0 -24
  494. data/docs/ItemGetRequest.md +0 -22
  495. data/docs/ItemGetResponse.md +0 -24
  496. data/docs/ItemImportRequest.md +0 -26
  497. data/docs/ItemImportRequestOptions.md +0 -18
  498. data/docs/ItemImportRequestUserAuth.md +0 -20
  499. data/docs/ItemImportResponse.md +0 -20
  500. data/docs/ItemProductReadyWebhook.md +0 -24
  501. data/docs/ItemPublicTokenCreateRequest.md +0 -22
  502. data/docs/ItemPublicTokenCreateResponse.md +0 -22
  503. data/docs/ItemPublicTokenExchangeRequest.md +0 -22
  504. data/docs/ItemPublicTokenExchangeResponse.md +0 -22
  505. data/docs/ItemRemoveRequest.md +0 -22
  506. data/docs/ItemRemoveResponse.md +0 -18
  507. data/docs/ItemStatus.md +0 -22
  508. data/docs/ItemStatusInvestments.md +0 -20
  509. data/docs/ItemStatusLastWebhook.md +0 -20
  510. data/docs/ItemStatusTransactions.md +0 -20
  511. data/docs/ItemWebhookUpdateRequest.md +0 -24
  512. data/docs/ItemWebhookUpdateResponse.md +0 -20
  513. data/docs/JWKPublicKey.md +0 -34
  514. data/docs/JWTHeader.md +0 -18
  515. data/docs/LiabilitiesGetRequest.md +0 -24
  516. data/docs/LiabilitiesGetRequestOptions.md +0 -18
  517. data/docs/LiabilitiesGetResponse.md +0 -24
  518. data/docs/LiabilitiesObject.md +0 -22
  519. data/docs/LiabilityOverride.md +0 -66
  520. data/docs/LinkTokenAccountFilters.md +0 -24
  521. data/docs/LinkTokenCreateRequest.md +0 -48
  522. data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
  523. data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
  524. data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
  525. data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
  526. data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
  527. data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
  528. data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
  529. data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
  530. data/docs/LinkTokenCreateRequestUser.md +0 -32
  531. data/docs/LinkTokenCreateResponse.md +0 -22
  532. data/docs/LinkTokenGetMetadataResponse.md +0 -30
  533. data/docs/LinkTokenGetRequest.md +0 -22
  534. data/docs/LinkTokenGetResponse.md +0 -26
  535. data/docs/LoanFilter.md +0 -18
  536. data/docs/Location.md +0 -32
  537. data/docs/MFA.md +0 -26
  538. data/docs/Meta.md +0 -22
  539. data/docs/MortgageInterestRate.md +0 -20
  540. data/docs/MortgageLiability.md +0 -56
  541. data/docs/MortgagePropertyAddress.md +0 -26
  542. data/docs/NullableAccessToken.md +0 -15
  543. data/docs/NullableAddress.md +0 -20
  544. data/docs/NullableAddressData.md +0 -26
  545. data/docs/NullableItemStatus.md +0 -22
  546. data/docs/NullableNumbersACH.md +0 -24
  547. data/docs/NullableNumbersBACS.md +0 -22
  548. data/docs/NullableNumbersEFT.md +0 -24
  549. data/docs/NullableNumbersInternational.md +0 -22
  550. data/docs/NullableRecipientBACS.md +0 -20
  551. data/docs/Numbers.md +0 -32
  552. data/docs/NumbersACH.md +0 -24
  553. data/docs/NumbersBACS.md +0 -22
  554. data/docs/NumbersEFT.md +0 -24
  555. data/docs/NumbersInternational.md +0 -22
  556. data/docs/OverrideAccounts.md +0 -38
  557. data/docs/Owner.md +0 -24
  558. data/docs/OwnerOverride.md +0 -24
  559. data/docs/PSLFStatus.md +0 -22
  560. data/docs/PayFrequency.md +0 -20
  561. data/docs/PayPeriodDetails.md +0 -26
  562. data/docs/PaymentAmount.md +0 -20
  563. data/docs/PaymentInitiationAddress.md +0 -24
  564. data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
  565. data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
  566. data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
  567. data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
  568. data/docs/PaymentInitiationPaymentListRequest.md +0 -24
  569. data/docs/PaymentInitiationPaymentListResponse.md +0 -22
  570. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
  571. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
  572. data/docs/PaymentInitiationRecipient.md +0 -26
  573. data/docs/PaymentInitiationRecipientBacs.md +0 -20
  574. data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
  575. data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
  576. data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
  577. data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
  578. data/docs/PaymentInitiationRecipientListRequest.md +0 -20
  579. data/docs/PaymentInitiationRecipientListResponse.md +0 -20
  580. data/docs/PaymentMeta.md +0 -32
  581. data/docs/PaymentStatusUpdateWebhook.md +0 -30
  582. data/docs/Paystub.md +0 -30
  583. data/docs/PaystubDeduction.md +0 -22
  584. data/docs/PaystubYTDDetails.md +0 -20
  585. data/docs/PendingExpirationWebhook.md +0 -24
  586. data/docs/PhoneNumber.md +0 -22
  587. data/docs/PlaidApi.md +0 -5580
  588. data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
  589. data/docs/ProcessorAuthGetRequest.md +0 -22
  590. data/docs/ProcessorAuthGetResponse.md +0 -22
  591. data/docs/ProcessorBalanceGetRequest.md +0 -22
  592. data/docs/ProcessorBalanceGetResponse.md +0 -20
  593. data/docs/ProcessorIdentityGetRequest.md +0 -22
  594. data/docs/ProcessorIdentityGetResponse.md +0 -20
  595. data/docs/ProcessorNumber.md +0 -24
  596. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
  597. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
  598. data/docs/ProcessorTokenCreateRequest.md +0 -26
  599. data/docs/ProcessorTokenCreateResponse.md +0 -20
  600. data/docs/ProductStatus.md +0 -22
  601. data/docs/ProductStatusBreakdown.md +0 -24
  602. data/docs/Products.md +0 -15
  603. data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
  604. data/docs/RecaptchaRequiredError.md +0 -30
  605. data/docs/RecipientBACS.md +0 -20
  606. data/docs/SandboxBankTransferSimulateRequest.md +0 -26
  607. data/docs/SandboxBankTransferSimulateResponse.md +0 -18
  608. data/docs/SandboxItemFireWebhookRequest.md +0 -24
  609. data/docs/SandboxItemFireWebhookResponse.md +0 -20
  610. data/docs/SandboxItemResetLoginRequest.md +0 -22
  611. data/docs/SandboxItemResetLoginResponse.md +0 -20
  612. data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
  613. data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
  614. data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
  615. data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
  616. data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
  617. data/docs/SandboxPublicTokenCreateRequest.md +0 -26
  618. data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
  619. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
  620. data/docs/SandboxPublicTokenCreateResponse.md +0 -20
  621. data/docs/Security.md +0 -46
  622. data/docs/ServicerAddressData.md +0 -26
  623. data/docs/StandaloneAccountType.md +0 -26
  624. data/docs/StandaloneCurrencyCodeList.md +0 -20
  625. data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
  626. data/docs/StandaloneInvestmentTransactionType.md +0 -28
  627. data/docs/StudentLoan.md +0 -66
  628. data/docs/StudentLoanRepaymentModel.md +0 -22
  629. data/docs/StudentLoanStatus.md +0 -20
  630. data/docs/StudentRepaymentPlan.md +0 -20
  631. data/docs/Transaction.md +0 -54
  632. data/docs/TransactionCode.md +0 -15
  633. data/docs/TransactionData.md +0 -26
  634. data/docs/TransactionOverride.md +0 -26
  635. data/docs/TransactionsGetRequest.md +0 -28
  636. data/docs/TransactionsGetRequestOptions.md +0 -22
  637. data/docs/TransactionsGetResponse.md +0 -26
  638. data/docs/TransactionsRefreshRequest.md +0 -22
  639. data/docs/TransactionsRefreshResponse.md +0 -18
  640. data/docs/TransactionsRemovedWebhook.md +0 -26
  641. data/docs/UserCustomPassword.md +0 -28
  642. data/docs/UserPermissionRevokedWebhook.md +0 -24
  643. data/docs/VerificationExpiredWebhook.md +0 -24
  644. data/docs/VerificationStatus.md +0 -15
  645. data/docs/Warning.md +0 -22
  646. data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
  647. data/docs/WebhookVerificationKeyGetRequest.md +0 -22
  648. data/docs/WebhookVerificationKeyGetResponse.md +0 -20
  649. data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
  650. data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
  651. data/pkg/plaid-14.0.0.beta.2.gem +0 -0
@@ -1,30 +0,0 @@
1
- # Plaid::IncomeSummary
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **employer_name** | [**EmployerIncomeSummaryFieldString**](EmployerIncomeSummaryFieldString.md) | | [optional] |
8
- | **employee_name** | [**EmployeeIncomeSummaryFieldString**](EmployeeIncomeSummaryFieldString.md) | | [optional] |
9
- | **ytd_gross_income** | [**YTDGrossIncomeSummaryFieldNumber**](YTDGrossIncomeSummaryFieldNumber.md) | | [optional] |
10
- | **ytd_net_income** | [**YTDNetIncomeSummaryFieldNumber**](YTDNetIncomeSummaryFieldNumber.md) | | [optional] |
11
- | **pay_frequency** | [**PayFrequency**](PayFrequency.md) | | [optional] |
12
- | **projected_wage** | [**ProjectedIncomeSummaryFieldNumber**](ProjectedIncomeSummaryFieldNumber.md) | | [optional] |
13
- | **verified_transaction** | [**TransactionData**](TransactionData.md) | | [optional] |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'plaid'
19
-
20
- instance = Plaid::IncomeSummary.new(
21
- employer_name: null,
22
- employee_name: null,
23
- ytd_gross_income: null,
24
- ytd_net_income: null,
25
- pay_frequency: null,
26
- projected_wage: null,
27
- verified_transaction: null
28
- )
29
- ```
30
-
@@ -1,20 +0,0 @@
1
- # Plaid::IncomeSummaryFieldNumber
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **value** | **Float** | The value of the field. | |
8
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::IncomeSummaryFieldNumber.new(
16
- value: null,
17
- verification_status: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # Plaid::IncomeSummaryFieldString
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **value** | **String** | The value of the field. | |
8
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::IncomeSummaryFieldString.new(
16
- value: null,
17
- verification_status: null
18
- )
19
- ```
20
-
@@ -1,22 +0,0 @@
1
- # Plaid::IncomeVerificationCreateRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **webhook** | **String** | The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::IncomeVerificationCreateRequest.new(
17
- client_id: null,
18
- secret: null,
19
- webhook: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Plaid::IncomeVerificationCreateResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **income_verification_id** | **String** | ID of the verification. This ID is persisted throughout the lifetime of the verification. | |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::IncomeVerificationCreateResponse.new(
16
- income_verification_id: null,
17
- request_id: null
18
- )
19
- ```
20
-
@@ -1,22 +0,0 @@
1
- # Plaid::IncomeVerificationDocumentsDownloadRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **income_verification_id** | **String** | The ID of the verification. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::IncomeVerificationDocumentsDownloadRequest.new(
17
- client_id: null,
18
- secret: null,
19
- income_verification_id: null
20
- )
21
- ```
22
-
@@ -1,18 +0,0 @@
1
- # Plaid::IncomeVerificationDocumentsDownloadResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'plaid'
13
-
14
- instance = Plaid::IncomeVerificationDocumentsDownloadResponse.new(
15
- id: null
16
- )
17
- ```
18
-
@@ -1,22 +0,0 @@
1
- # Plaid::IncomeVerificationPaystubGetRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **income_verification_id** | **String** | The ID of the verification for which to get paystub information. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::IncomeVerificationPaystubGetRequest.new(
17
- client_id: null,
18
- secret: null,
19
- income_verification_id: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Plaid::IncomeVerificationPaystubGetResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **paystub** | [**Paystub**](Paystub.md) | | [optional] |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::IncomeVerificationPaystubGetResponse.new(
16
- paystub: null,
17
- request_id: null
18
- )
19
- ```
20
-
@@ -1,24 +0,0 @@
1
- # Plaid::IncomeVerificationStatusWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `\"INCOME\"` | |
8
- | **webhook_code** | **String** | `income_verification` | |
9
- | **income_verification_id** | **String** | The `income_verification_id` of the verification instance whose status is being reported. | |
10
- | **verification_status** | **String** | `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end user attempted to upload their verification documentation. `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload verification documentation in an unsupported file format. `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub. `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation. | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::IncomeVerificationStatusWebhook.new(
18
- webhook_type: null,
19
- webhook_code: null,
20
- income_verification_id: null,
21
- verification_status: null
22
- )
23
- ```
24
-
@@ -1,22 +0,0 @@
1
- # Plaid::IncomeVerificationSummaryGetRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **income_verification_id** | **String** | The ID of the verification. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::IncomeVerificationSummaryGetRequest.new(
17
- client_id: null,
18
- secret: null,
19
- income_verification_id: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Plaid::IncomeVerificationSummaryGetResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **income_summaries** | [**Array<IncomeSummary>**](IncomeSummary.md) | A list of income summaries. | |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::IncomeVerificationSummaryGetResponse.new(
16
- income_summaries: null,
17
- request_id: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # Plaid::IncomeVerificationWebhookStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'plaid'
13
-
14
- instance = Plaid::IncomeVerificationWebhookStatus.new(
15
- id: null
16
- )
17
- ```
18
-
data/docs/InflowModel.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::InflowModel
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | Inflow model. One of the following: `none`: No income `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`. | |
8
- | **income_amount** | **Float** | Amount of income per month. This value is required if `type` is `monthly-income`. | |
9
- | **payment_day_of_month** | **Float** | Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. | |
10
- | **transaction_name** | **String** | The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. | |
11
- | **statement_day_of_month** | **String** | Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`. | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::InflowModel.new(
19
- type: null,
20
- income_amount: null,
21
- payment_day_of_month: null,
22
- transaction_name: null,
23
- statement_day_of_month: null
24
- )
25
- ```
26
-
@@ -1,26 +0,0 @@
1
- # Plaid::InitialUpdateWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `TRANSACTIONS` | |
8
- | **webhook_code** | **String** | `INITIAL_UPDATE` | |
9
- | **error** | **String** | The error code associated with the webhook. | [optional] |
10
- | **new_transactions** | **Float** | The number of new, unfetched transactions available. | |
11
- | **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::InitialUpdateWebhook.new(
19
- webhook_type: null,
20
- webhook_code: null,
21
- error: null,
22
- new_transactions: null,
23
- item_id: null
24
- )
25
- ```
26
-
data/docs/Institution.md DELETED
@@ -1,36 +0,0 @@
1
- # Plaid::Institution
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **institution_id** | **String** | Unique identifier for the institution | |
8
- | **name** | **String** | The official name of the institution | |
9
- | **products** | [**Array<Products>**](Products.md) | A list of the Plaid products supported by the institution | |
10
- | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | A list of the country codes supported by the institution. | |
11
- | **url** | **String** | The URL for the institution's website | [optional] |
12
- | **primary_color** | **String** | Hexadecimal representation of the primary color used by the institution | [optional] |
13
- | **logo** | **String** | Base64 encoded representation of the institution's logo | [optional] |
14
- | **routing_numbers** | **Array<String>** | A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution. | [optional] |
15
- | **oauth** | **Boolean** | Indicates that the institution has an OAuth login flow. This is primarily relevant to institutions with European country codes. | |
16
- | **status** | [**InstitutionStatus**](InstitutionStatus.md) | | [optional] |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'plaid'
22
-
23
- instance = Plaid::Institution.new(
24
- institution_id: null,
25
- name: null,
26
- products: null,
27
- country_codes: null,
28
- url: null,
29
- primary_color: null,
30
- logo: null,
31
- routing_numbers: null,
32
- oauth: null,
33
- status: null
34
- )
35
- ```
36
-
@@ -1,30 +0,0 @@
1
- # Plaid::InstitutionStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **item_logins** | [**ProductStatus**](ProductStatus.md) | | |
8
- | **transactions_updates** | [**ProductStatus**](ProductStatus.md) | | |
9
- | **auth** | [**ProductStatus**](ProductStatus.md) | | |
10
- | **balance** | [**ProductStatus**](ProductStatus.md) | | |
11
- | **identity** | [**ProductStatus**](ProductStatus.md) | | |
12
- | **investments_updates** | [**ProductStatus**](ProductStatus.md) | | |
13
- | **health_incidents** | [**Array<HealthIncident>**](HealthIncident.md) | Details of recent health incidents associated with the institution. | [optional] |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'plaid'
19
-
20
- instance = Plaid::InstitutionStatus.new(
21
- item_logins: null,
22
- transactions_updates: null,
23
- auth: null,
24
- balance: null,
25
- identity: null,
26
- investments_updates: null,
27
- health_incidents: null
28
- )
29
- ```
30
-
@@ -1,26 +0,0 @@
1
- # Plaid::InstitutionsGetByIdRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **institution_id** | **String** | The ID of the institution to get details about | |
10
- | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. | |
11
- | **options** | [**InstitutionsGetByIdRequestOptions**](InstitutionsGetByIdRequestOptions.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::InstitutionsGetByIdRequest.new(
19
- client_id: null,
20
- secret: null,
21
- institution_id: null,
22
- country_codes: null,
23
- options: null
24
- )
25
- ```
26
-
@@ -1,20 +0,0 @@
1
- # Plaid::InstitutionsGetByIdRequestOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **include_optional_metadata** | **Boolean** | When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`. Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos. | [optional][default to false] |
8
- | **include_status** | **Boolean** | If `true`, the response will include status information about the institution. Default value is `false`. | [optional][default to false] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::InstitutionsGetByIdRequestOptions.new(
16
- include_optional_metadata: null,
17
- include_status: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # Plaid::InstitutionsGetByIdResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **institution** | [**Institution**](Institution.md) | | |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::InstitutionsGetByIdResponse.new(
16
- institution: null,
17
- request_id: null
18
- )
19
- ```
20
-
@@ -1,28 +0,0 @@
1
- # Plaid::InstitutionsGetRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **count** | **Integer** | The total number of Institutions to return. | |
10
- | **offset** | **Integer** | The number of Institutions to skip. | |
11
- | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. | |
12
- | **options** | [**InstitutionsGetRequestOptions**](InstitutionsGetRequestOptions.md) | | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'plaid'
18
-
19
- instance = Plaid::InstitutionsGetRequest.new(
20
- client_id: null,
21
- secret: null,
22
- count: null,
23
- offset: null,
24
- country_codes: null,
25
- options: null
26
- )
27
- ```
28
-
@@ -1,24 +0,0 @@
1
- # Plaid::InstitutionsGetRequestOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **products** | [**Array<Products>**](Products.md) | Filter the Institutions based on which products they support. | [optional] |
8
- | **routing_numbers** | **Array<String>** | Specify an array of routing numbers to filter institutions. | [optional] |
9
- | **oauth** | **Boolean** | Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes. | [optional] |
10
- | **include_optional_metadata** | **Boolean** | When `true`, return the institution's homepage URL, logo and primary brand color. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::InstitutionsGetRequestOptions.new(
18
- products: null,
19
- routing_numbers: null,
20
- oauth: null,
21
- include_optional_metadata: null
22
- )
23
- ```
24
-
@@ -1,22 +0,0 @@
1
- # Plaid::InstitutionsGetResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **institutions** | [**Array<Institution>**](Institution.md) | A list of Plaid Institution | |
8
- | **total** | **Integer** | The number of institutions returned | |
9
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::InstitutionsGetResponse.new(
17
- institutions: null,
18
- total: null,
19
- request_id: null
20
- )
21
- ```
22
-
@@ -1,24 +0,0 @@
1
- # Plaid::InstitutionsSearchAccountFilter
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **loan** | [**Array<AccountSubtype>**](AccountSubtype.md) | | [optional] |
8
- | **depository** | [**Array<AccountSubtype>**](AccountSubtype.md) | | [optional] |
9
- | **credit** | [**Array<AccountSubtype>**](AccountSubtype.md) | | [optional] |
10
- | **investment** | [**Array<AccountSubtype>**](AccountSubtype.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::InstitutionsSearchAccountFilter.new(
18
- loan: null,
19
- depository: null,
20
- credit: null,
21
- investment: null
22
- )
23
- ```
24
-
@@ -1,28 +0,0 @@
1
- # Plaid::InstitutionsSearchRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
- | **query** | **String** | The search query. Institutions with names matching the query are returned | |
10
- | **products** | [**Array<Products>**](Products.md) | Filter the Institutions based on whether they support all products listed in products. Provide `null` to get institutions regardless of supported products | |
11
- | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. | |
12
- | **options** | [**InstitutionsSearchRequestOptions**](InstitutionsSearchRequestOptions.md) | | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'plaid'
18
-
19
- instance = Plaid::InstitutionsSearchRequest.new(
20
- client_id: null,
21
- secret: null,
22
- query: null,
23
- products: null,
24
- country_codes: null,
25
- options: null
26
- )
27
- ```
28
-
@@ -1,22 +0,0 @@
1
- # Plaid::InstitutionsSearchRequestOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **oauth** | **Boolean** | Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes | [optional] |
8
- | **include_optional_metadata** | **Boolean** | When true, return the institution's homepage URL, logo and primary brand color. Learn more | [optional] |
9
- | **account_filter** | [**InstitutionsSearchAccountFilter**](InstitutionsSearchAccountFilter.md) | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::InstitutionsSearchRequestOptions.new(
17
- oauth: null,
18
- include_optional_metadata: null,
19
- account_filter: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Plaid::InstitutionsSearchResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **institutions** | [**Array<Institution>**](Institution.md) | An array of institutions matching the search criteria | |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::InstitutionsSearchResponse.new(
16
- institutions: null,
17
- request_id: null
18
- )
19
- ```
20
-