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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: plaid
3
3
  version: !ruby/object:Gem::Version
4
- version: 14.0.0.beta.2
4
+ version: 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown
5
5
  platform: ruby
6
6
  authors:
7
7
  - Plaid
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-02-18 00:00:00.000000000 Z
11
+ date: 2021-09-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -153,317 +153,6 @@ files:
153
153
  - README.md
154
154
  - Rakefile
155
155
  - UPGRADING.md
156
- - docs/ACHClass.md
157
- - docs/APR.md
158
- - docs/AccountAssets.md
159
- - docs/AccountAssetsAllOf.md
160
- - docs/AccountBalance.md
161
- - docs/AccountBase.md
162
- - docs/AccountFiltersResponse.md
163
- - docs/AccountIdentity.md
164
- - docs/AccountIdentityAllOf.md
165
- - docs/AccountSubtype.md
166
- - docs/AccountType.md
167
- - docs/AccountsBalanceGetRequest.md
168
- - docs/AccountsBalanceGetRequestOptions.md
169
- - docs/AccountsGetRequest.md
170
- - docs/AccountsGetRequestOptions.md
171
- - docs/AccountsGetResponse.md
172
- - docs/Address.md
173
- - docs/AddressData.md
174
- - docs/Amount.md
175
- - docs/AssetReport.md
176
- - docs/AssetReportAuditCopyCreateRequest.md
177
- - docs/AssetReportAuditCopyCreateResponse.md
178
- - docs/AssetReportAuditCopyGetRequest.md
179
- - docs/AssetReportAuditCopyRemoveRequest.md
180
- - docs/AssetReportAuditCopyRemoveResponse.md
181
- - docs/AssetReportCreateRequest.md
182
- - docs/AssetReportCreateRequestOptions.md
183
- - docs/AssetReportCreateResponse.md
184
- - docs/AssetReportFilterRequest.md
185
- - docs/AssetReportFilterResponse.md
186
- - docs/AssetReportGetRequest.md
187
- - docs/AssetReportGetResponse.md
188
- - docs/AssetReportItem.md
189
- - docs/AssetReportPDFGetRequest.md
190
- - docs/AssetReportRefreshRequest.md
191
- - docs/AssetReportRefreshRequestOptions.md
192
- - docs/AssetReportRefreshResponse.md
193
- - docs/AssetReportRemoveRequest.md
194
- - docs/AssetReportRemoveResponse.md
195
- - docs/AssetReportTransaction.md
196
- - docs/AssetReportTransactionAllOf.md
197
- - docs/AssetReportUser.md
198
- - docs/AssetsErrorWebhook.md
199
- - docs/AssetsProductReadyWebhook.md
200
- - docs/AuthGetNumbers.md
201
- - docs/AuthGetRequest.md
202
- - docs/AuthGetRequestOptions.md
203
- - docs/AuthGetResponse.md
204
- - docs/AutomaticallyVerifiedWebhook.md
205
- - docs/BankTransfer.md
206
- - docs/BankTransferBalance.md
207
- - docs/BankTransferBalanceGetRequest.md
208
- - docs/BankTransferBalanceGetResponse.md
209
- - docs/BankTransferCancelRequest.md
210
- - docs/BankTransferCancelResponse.md
211
- - docs/BankTransferCreateRequest.md
212
- - docs/BankTransferCreateResponse.md
213
- - docs/BankTransferDirection.md
214
- - docs/BankTransferEvent.md
215
- - docs/BankTransferEventListRequest.md
216
- - docs/BankTransferEventListResponse.md
217
- - docs/BankTransferEventSyncRequest.md
218
- - docs/BankTransferEventSyncResponse.md
219
- - docs/BankTransferEventType.md
220
- - docs/BankTransferFailure.md
221
- - docs/BankTransferGetRequest.md
222
- - docs/BankTransferGetResponse.md
223
- - docs/BankTransferListRequest.md
224
- - docs/BankTransferListResponse.md
225
- - docs/BankTransferMigrateAccountRequest.md
226
- - docs/BankTransferMigrateAccountResponse.md
227
- - docs/BankTransferNetwork.md
228
- - docs/BankTransferReceiverDetails.md
229
- - docs/BankTransferStatus.md
230
- - docs/BankTransferType.md
231
- - docs/BankTransferUser.md
232
- - docs/CategoriesGetResponse.md
233
- - docs/Category.md
234
- - docs/Cause.md
235
- - docs/CountryCode.md
236
- - docs/CreditCardLiability.md
237
- - docs/CreditFilter.md
238
- - docs/DefaultUpdateWebhook.md
239
- - docs/DepositSwitchAddressData.md
240
- - docs/DepositSwitchAltCreateRequest.md
241
- - docs/DepositSwitchAltCreateResponse.md
242
- - docs/DepositSwitchCreateRequest.md
243
- - docs/DepositSwitchCreateResponse.md
244
- - docs/DepositSwitchGetRequest.md
245
- - docs/DepositSwitchGetResponse.md
246
- - docs/DepositSwitchTargetAccount.md
247
- - docs/DepositSwitchTargetUser.md
248
- - docs/DepositSwitchTokenCreateRequest.md
249
- - docs/DepositSwitchTokenCreateResponse.md
250
- - docs/DepositoryFilter.md
251
- - docs/Email.md
252
- - docs/Employee.md
253
- - docs/EmployeeIncomeSummaryFieldString.md
254
- - docs/Employer.md
255
- - docs/EmployerIncomeSummaryFieldString.md
256
- - docs/EmployersSearchRequest.md
257
- - docs/EmployersSearchResponse.md
258
- - docs/Error.md
259
- - docs/ExternalPaymentSchedule.md
260
- - docs/HealthIncident.md
261
- - docs/HistoricalBalance.md
262
- - docs/HistoricalUpdateWebhook.md
263
- - docs/Holding.md
264
- - docs/HoldingsDefaultUpdateWebhook.md
265
- - docs/IdentityGetRequest.md
266
- - docs/IdentityGetRequestOptions.md
267
- - docs/IdentityGetResponse.md
268
- - docs/IncidentUpdate.md
269
- - docs/IncomeBreakdown.md
270
- - docs/IncomeSummary.md
271
- - docs/IncomeSummaryFieldNumber.md
272
- - docs/IncomeSummaryFieldString.md
273
- - docs/IncomeVerificationCreateRequest.md
274
- - docs/IncomeVerificationCreateResponse.md
275
- - docs/IncomeVerificationDocumentsDownloadRequest.md
276
- - docs/IncomeVerificationDocumentsDownloadResponse.md
277
- - docs/IncomeVerificationPaystubGetRequest.md
278
- - docs/IncomeVerificationPaystubGetResponse.md
279
- - docs/IncomeVerificationStatusWebhook.md
280
- - docs/IncomeVerificationSummaryGetRequest.md
281
- - docs/IncomeVerificationSummaryGetResponse.md
282
- - docs/IncomeVerificationWebhookStatus.md
283
- - docs/InflowModel.md
284
- - docs/InitialUpdateWebhook.md
285
- - docs/Institution.md
286
- - docs/InstitutionStatus.md
287
- - docs/InstitutionsGetByIdRequest.md
288
- - docs/InstitutionsGetByIdRequestOptions.md
289
- - docs/InstitutionsGetByIdResponse.md
290
- - docs/InstitutionsGetRequest.md
291
- - docs/InstitutionsGetRequestOptions.md
292
- - docs/InstitutionsGetResponse.md
293
- - docs/InstitutionsSearchAccountFilter.md
294
- - docs/InstitutionsSearchRequest.md
295
- - docs/InstitutionsSearchRequestOptions.md
296
- - docs/InstitutionsSearchResponse.md
297
- - docs/InvestmentFilter.md
298
- - docs/InvestmentHoldingsGetRequestOptions.md
299
- - docs/InvestmentTransaction.md
300
- - docs/InvestmentsDefaultUpdateWebhook.md
301
- - docs/InvestmentsHoldingsGetRequest.md
302
- - docs/InvestmentsHoldingsGetResponse.md
303
- - docs/InvestmentsTransactionsGetRequest.md
304
- - docs/InvestmentsTransactionsGetRequestOptions.md
305
- - docs/InvestmentsTransactionsGetResponse.md
306
- - docs/Item.md
307
- - docs/ItemAccessTokenInvalidateRequest.md
308
- - docs/ItemAccessTokenInvalidateResponse.md
309
- - docs/ItemErrorWebhook.md
310
- - docs/ItemGetRequest.md
311
- - docs/ItemGetResponse.md
312
- - docs/ItemImportRequest.md
313
- - docs/ItemImportRequestOptions.md
314
- - docs/ItemImportRequestUserAuth.md
315
- - docs/ItemImportResponse.md
316
- - docs/ItemProductReadyWebhook.md
317
- - docs/ItemPublicTokenCreateRequest.md
318
- - docs/ItemPublicTokenCreateResponse.md
319
- - docs/ItemPublicTokenExchangeRequest.md
320
- - docs/ItemPublicTokenExchangeResponse.md
321
- - docs/ItemRemoveRequest.md
322
- - docs/ItemRemoveResponse.md
323
- - docs/ItemStatus.md
324
- - docs/ItemStatusInvestments.md
325
- - docs/ItemStatusLastWebhook.md
326
- - docs/ItemStatusTransactions.md
327
- - docs/ItemWebhookUpdateRequest.md
328
- - docs/ItemWebhookUpdateResponse.md
329
- - docs/JWKPublicKey.md
330
- - docs/JWTHeader.md
331
- - docs/LiabilitiesGetRequest.md
332
- - docs/LiabilitiesGetRequestOptions.md
333
- - docs/LiabilitiesGetResponse.md
334
- - docs/LiabilitiesObject.md
335
- - docs/LiabilityOverride.md
336
- - docs/LinkTokenAccountFilters.md
337
- - docs/LinkTokenCreateRequest.md
338
- - docs/LinkTokenCreateRequestAccountSubtypes.md
339
- - docs/LinkTokenCreateRequestAccountSubtypesCredit.md
340
- - docs/LinkTokenCreateRequestAccountSubtypesDepository.md
341
- - docs/LinkTokenCreateRequestAccountSubtypesInvestment.md
342
- - docs/LinkTokenCreateRequestAccountSubtypesLoan.md
343
- - docs/LinkTokenCreateRequestDepositSwitch.md
344
- - docs/LinkTokenCreateRequestIncomeVerification.md
345
- - docs/LinkTokenCreateRequestPaymentInitiation.md
346
- - docs/LinkTokenCreateRequestUser.md
347
- - docs/LinkTokenCreateResponse.md
348
- - docs/LinkTokenGetMetadataResponse.md
349
- - docs/LinkTokenGetRequest.md
350
- - docs/LinkTokenGetResponse.md
351
- - docs/LoanFilter.md
352
- - docs/Location.md
353
- - docs/MFA.md
354
- - docs/Meta.md
355
- - docs/MortgageInterestRate.md
356
- - docs/MortgageLiability.md
357
- - docs/MortgagePropertyAddress.md
358
- - docs/NullableAccessToken.md
359
- - docs/NullableAddress.md
360
- - docs/NullableAddressData.md
361
- - docs/NullableItemStatus.md
362
- - docs/NullableNumbersACH.md
363
- - docs/NullableNumbersBACS.md
364
- - docs/NullableNumbersEFT.md
365
- - docs/NullableNumbersInternational.md
366
- - docs/NullableRecipientBACS.md
367
- - docs/Numbers.md
368
- - docs/NumbersACH.md
369
- - docs/NumbersBACS.md
370
- - docs/NumbersEFT.md
371
- - docs/NumbersInternational.md
372
- - docs/OverrideAccounts.md
373
- - docs/Owner.md
374
- - docs/OwnerOverride.md
375
- - docs/PSLFStatus.md
376
- - docs/PayFrequency.md
377
- - docs/PayPeriodDetails.md
378
- - docs/PaymentAmount.md
379
- - docs/PaymentInitiationAddress.md
380
- - docs/PaymentInitiationPaymentCreateRequest.md
381
- - docs/PaymentInitiationPaymentCreateResponse.md
382
- - docs/PaymentInitiationPaymentGetRequest.md
383
- - docs/PaymentInitiationPaymentGetResponse.md
384
- - docs/PaymentInitiationPaymentListRequest.md
385
- - docs/PaymentInitiationPaymentListResponse.md
386
- - docs/PaymentInitiationPaymentTokenCreateRequest.md
387
- - docs/PaymentInitiationPaymentTokenCreateResponse.md
388
- - docs/PaymentInitiationRecipient.md
389
- - docs/PaymentInitiationRecipientBacs.md
390
- - docs/PaymentInitiationRecipientCreateRequest.md
391
- - docs/PaymentInitiationRecipientCreateResponse.md
392
- - docs/PaymentInitiationRecipientGetRequest.md
393
- - docs/PaymentInitiationRecipientGetResponse.md
394
- - docs/PaymentInitiationRecipientListRequest.md
395
- - docs/PaymentInitiationRecipientListResponse.md
396
- - docs/PaymentMeta.md
397
- - docs/PaymentStatusUpdateWebhook.md
398
- - docs/Paystub.md
399
- - docs/PaystubDeduction.md
400
- - docs/PaystubYTDDetails.md
401
- - docs/PendingExpirationWebhook.md
402
- - docs/PhoneNumber.md
403
- - docs/PlaidApi.md
404
- - docs/ProcessorApexProcessorTokenCreateRequest.md
405
- - docs/ProcessorAuthGetRequest.md
406
- - docs/ProcessorAuthGetResponse.md
407
- - docs/ProcessorBalanceGetRequest.md
408
- - docs/ProcessorBalanceGetResponse.md
409
- - docs/ProcessorIdentityGetRequest.md
410
- - docs/ProcessorIdentityGetResponse.md
411
- - docs/ProcessorNumber.md
412
- - docs/ProcessorStripeBankAccountTokenCreateRequest.md
413
- - docs/ProcessorStripeBankAccountTokenCreateResponse.md
414
- - docs/ProcessorTokenCreateRequest.md
415
- - docs/ProcessorTokenCreateResponse.md
416
- - docs/ProductStatus.md
417
- - docs/ProductStatusBreakdown.md
418
- - docs/Products.md
419
- - docs/ProjectedIncomeSummaryFieldNumber.md
420
- - docs/RecaptchaRequiredError.md
421
- - docs/RecipientBACS.md
422
- - docs/SandboxBankTransferSimulateRequest.md
423
- - docs/SandboxBankTransferSimulateResponse.md
424
- - docs/SandboxItemFireWebhookRequest.md
425
- - docs/SandboxItemFireWebhookResponse.md
426
- - docs/SandboxItemResetLoginRequest.md
427
- - docs/SandboxItemResetLoginResponse.md
428
- - docs/SandboxItemSetVerificationStatusRequest.md
429
- - docs/SandboxItemSetVerificationStatusResponse.md
430
- - docs/SandboxProcessorTokenCreateRequest.md
431
- - docs/SandboxProcessorTokenCreateRequestOptions.md
432
- - docs/SandboxProcessorTokenCreateResponse.md
433
- - docs/SandboxPublicTokenCreateRequest.md
434
- - docs/SandboxPublicTokenCreateRequestOptions.md
435
- - docs/SandboxPublicTokenCreateRequestOptionsTransactions.md
436
- - docs/SandboxPublicTokenCreateResponse.md
437
- - docs/Security.md
438
- - docs/ServicerAddressData.md
439
- - docs/StandaloneAccountType.md
440
- - docs/StandaloneCurrencyCodeList.md
441
- - docs/StandaloneInvestmentTransactionSubtype.md
442
- - docs/StandaloneInvestmentTransactionType.md
443
- - docs/StudentLoan.md
444
- - docs/StudentLoanRepaymentModel.md
445
- - docs/StudentLoanStatus.md
446
- - docs/StudentRepaymentPlan.md
447
- - docs/Transaction.md
448
- - docs/TransactionCode.md
449
- - docs/TransactionData.md
450
- - docs/TransactionOverride.md
451
- - docs/TransactionsGetRequest.md
452
- - docs/TransactionsGetRequestOptions.md
453
- - docs/TransactionsGetResponse.md
454
- - docs/TransactionsRefreshRequest.md
455
- - docs/TransactionsRefreshResponse.md
456
- - docs/TransactionsRemovedWebhook.md
457
- - docs/UserCustomPassword.md
458
- - docs/UserPermissionRevokedWebhook.md
459
- - docs/VerificationExpiredWebhook.md
460
- - docs/VerificationStatus.md
461
- - docs/Warning.md
462
- - docs/WebhookUpdateAcknowledgedWebhook.md
463
- - docs/WebhookVerificationKeyGetRequest.md
464
- - docs/WebhookVerificationKeyGetResponse.md
465
- - docs/YTDGrossIncomeSummaryFieldNumber.md
466
- - docs/YTDNetIncomeSummaryFieldNumber.md
467
156
  - lib/plaid.rb
468
157
  - lib/plaid/api/plaid_api.rb
469
158
  - lib/plaid/api_client.rb
@@ -486,7 +175,9 @@ files:
486
175
  - lib/plaid/models/ach_class.rb
487
176
  - lib/plaid/models/address.rb
488
177
  - lib/plaid/models/address_data.rb
489
- - lib/plaid/models/amount.rb
178
+ - lib/plaid/models/application.rb
179
+ - lib/plaid/models/application_get_request.rb
180
+ - lib/plaid/models/application_get_response.rb
490
181
  - lib/plaid/models/apr.rb
491
182
  - lib/plaid/models/asset_report.rb
492
183
  - lib/plaid/models/asset_report_audit_copy_create_request.rb
@@ -545,6 +236,7 @@ files:
545
236
  - lib/plaid/models/bank_transfer_status.rb
546
237
  - lib/plaid/models/bank_transfer_type.rb
547
238
  - lib/plaid/models/bank_transfer_user.rb
239
+ - lib/plaid/models/bank_transfers_events_update_webhook.rb
548
240
  - lib/plaid/models/categories_get_response.rb
549
241
  - lib/plaid/models/category.rb
550
242
  - lib/plaid/models/cause.rb
@@ -572,7 +264,10 @@ files:
572
264
  - lib/plaid/models/employers_search_request.rb
573
265
  - lib/plaid/models/employers_search_response.rb
574
266
  - lib/plaid/models/error.rb
267
+ - lib/plaid/models/external_payment_options.rb
268
+ - lib/plaid/models/external_payment_refund_details.rb
575
269
  - lib/plaid/models/external_payment_schedule.rb
270
+ - lib/plaid/models/external_payment_schedule_get.rb
576
271
  - lib/plaid/models/health_incident.rb
577
272
  - lib/plaid/models/historical_balance.rb
578
273
  - lib/plaid/models/historical_update_webhook.rb
@@ -607,6 +302,7 @@ files:
607
302
  - lib/plaid/models/institutions_get_request_options.rb
608
303
  - lib/plaid/models/institutions_get_response.rb
609
304
  - lib/plaid/models/institutions_search_account_filter.rb
305
+ - lib/plaid/models/institutions_search_payment_initiation_options.rb
610
306
  - lib/plaid/models/institutions_search_request.rb
611
307
  - lib/plaid/models/institutions_search_request_options.rb
612
308
  - lib/plaid/models/institutions_search_response.rb
@@ -637,13 +333,11 @@ files:
637
333
  - lib/plaid/models/item_remove_request.rb
638
334
  - lib/plaid/models/item_remove_response.rb
639
335
  - lib/plaid/models/item_status.rb
640
- - lib/plaid/models/item_status_investments.rb
641
- - lib/plaid/models/item_status_last_webhook.rb
642
- - lib/plaid/models/item_status_transactions.rb
643
336
  - lib/plaid/models/item_webhook_update_request.rb
644
337
  - lib/plaid/models/item_webhook_update_response.rb
645
338
  - lib/plaid/models/jwk_public_key.rb
646
339
  - lib/plaid/models/jwt_header.rb
340
+ - lib/plaid/models/liabilities_default_update_webhook.rb
647
341
  - lib/plaid/models/liabilities_get_request.rb
648
342
  - lib/plaid/models/liabilities_get_request_options.rb
649
343
  - lib/plaid/models/liabilities_get_response.rb
@@ -652,10 +346,7 @@ files:
652
346
  - lib/plaid/models/link_token_account_filters.rb
653
347
  - lib/plaid/models/link_token_create_request.rb
654
348
  - lib/plaid/models/link_token_create_request_account_subtypes.rb
655
- - lib/plaid/models/link_token_create_request_account_subtypes_credit.rb
656
- - lib/plaid/models/link_token_create_request_account_subtypes_depository.rb
657
- - lib/plaid/models/link_token_create_request_account_subtypes_investment.rb
658
- - lib/plaid/models/link_token_create_request_account_subtypes_loan.rb
349
+ - lib/plaid/models/link_token_create_request_auth.rb
659
350
  - lib/plaid/models/link_token_create_request_deposit_switch.rb
660
351
  - lib/plaid/models/link_token_create_request_income_verification.rb
661
352
  - lib/plaid/models/link_token_create_request_payment_initiation.rb
@@ -692,6 +383,9 @@ files:
692
383
  - lib/plaid/models/pay_period_details.rb
693
384
  - lib/plaid/models/payment_amount.rb
694
385
  - lib/plaid/models/payment_initiation_address.rb
386
+ - lib/plaid/models/payment_initiation_metadata.rb
387
+ - lib/plaid/models/payment_initiation_optional_restriction_bacs.rb
388
+ - lib/plaid/models/payment_initiation_payment.rb
695
389
  - lib/plaid/models/payment_initiation_payment_create_request.rb
696
390
  - lib/plaid/models/payment_initiation_payment_create_response.rb
697
391
  - lib/plaid/models/payment_initiation_payment_get_request.rb
@@ -701,14 +395,16 @@ files:
701
395
  - lib/plaid/models/payment_initiation_payment_token_create_request.rb
702
396
  - lib/plaid/models/payment_initiation_payment_token_create_response.rb
703
397
  - lib/plaid/models/payment_initiation_recipient.rb
704
- - lib/plaid/models/payment_initiation_recipient_bacs.rb
705
398
  - lib/plaid/models/payment_initiation_recipient_create_request.rb
706
399
  - lib/plaid/models/payment_initiation_recipient_create_response.rb
707
400
  - lib/plaid/models/payment_initiation_recipient_get_request.rb
708
401
  - lib/plaid/models/payment_initiation_recipient_get_response.rb
402
+ - lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb
709
403
  - lib/plaid/models/payment_initiation_recipient_list_request.rb
710
404
  - lib/plaid/models/payment_initiation_recipient_list_response.rb
405
+ - lib/plaid/models/payment_initiation_standing_order_metadata.rb
711
406
  - lib/plaid/models/payment_meta.rb
407
+ - lib/plaid/models/payment_schedule_interval.rb
712
408
  - lib/plaid/models/payment_status_update_webhook.rb
713
409
  - lib/plaid/models/paystub.rb
714
410
  - lib/plaid/models/paystub_deduction.rb
@@ -734,6 +430,8 @@ files:
734
430
  - lib/plaid/models/pslf_status.rb
735
431
  - lib/plaid/models/recaptcha_required_error.rb
736
432
  - lib/plaid/models/recipient_bacs.rb
433
+ - lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb
434
+ - lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb
737
435
  - lib/plaid/models/sandbox_bank_transfer_simulate_request.rb
738
436
  - lib/plaid/models/sandbox_bank_transfer_simulate_response.rb
739
437
  - lib/plaid/models/sandbox_item_fire_webhook_request.rb
@@ -780,12 +478,13 @@ files:
780
478
  - lib/plaid/models/ytd_gross_income_summary_field_number.rb
781
479
  - lib/plaid/models/ytd_net_income_summary_field_number.rb
782
480
  - lib/plaid/version.rb
783
- - pkg/plaid-14.0.0.beta.2.gem
481
+ - pkg/plaid-14.2.0.gem
784
482
  - plaid.gemspec
785
483
  - templates/ruby/api_client.mustache
786
484
  - templates/ruby/api_client_faraday_partial.mustache
787
485
  - templates/ruby/configuration.mustache
788
486
  - templates/ruby/gemspec.mustache
487
+ - templates/ruby/partial_model_generic.mustache
789
488
  - test/test_accounts.rb
790
489
  - test/test_asset_report.rb
791
490
  - test/test_auth.rb
@@ -816,7 +515,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
816
515
  requirements:
817
516
  - - ">="
818
517
  - !ruby/object:Gem::Version
819
- version: 2.7.1
518
+ version: 2.4.0
820
519
  required_rubygems_version: !ruby/object:Gem::Requirement
821
520
  requirements:
822
521
  - - ">"
data/docs/ACHClass.md DELETED
@@ -1,15 +0,0 @@
1
- # Plaid::ACHClass
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'plaid'
12
-
13
- instance = Plaid::ACHClass.new()
14
- ```
15
-
data/docs/APR.md DELETED
@@ -1,24 +0,0 @@
1
- # Plaid::APR
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **apr_percentage** | **Float** | Annual Percentage Rate applied. | |
8
- | **apr_type** | **String** | The type of balance to which the APR applies. | |
9
- | **balance_subject_to_apr** | **Float** | Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance. | [optional] |
10
- | **interest_charge_amount** | **Float** | Amount of money charged due to interest from last statement. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::APR.new(
18
- apr_percentage: null,
19
- apr_type: null,
20
- balance_subject_to_apr: null,
21
- interest_charge_amount: null
22
- )
23
- ```
24
-
@@ -1,40 +0,0 @@
1
- # Plaid::AccountAssets
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account. The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`. Like all Plaid identifiers, the `account_id` is case sensitive. | |
8
- | **balances** | [**AccountBalance**](AccountBalance.md) | | |
9
- | **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
10
- | **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself | |
11
- | **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
12
- | **type** | [**AccountType**](AccountType.md) | | |
13
- | **subtype** | [**AccountSubtype**](AccountSubtype.md) | | |
14
- | **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only. `pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. | [optional] |
15
- | **days_available** | **Float** | The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Assets endpoints. | [optional] |
16
- | **transactions** | [**Array<AssetReportTransaction>**](AssetReportTransaction.md) | Transaction history associated with the account. Only returned by Assets endpoints. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. | [optional] |
17
- | **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. | |
18
- | **historical_balances** | [**Array<HistoricalBalance>**](HistoricalBalance.md) | Calculated data about the historical balances on the account. Only returned by Assets endpoints. | [optional] |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'plaid'
24
-
25
- instance = Plaid::AccountAssets.new(
26
- account_id: null,
27
- balances: null,
28
- mask: null,
29
- name: null,
30
- official_name: null,
31
- type: null,
32
- subtype: null,
33
- verification_status: null,
34
- days_available: null,
35
- transactions: null,
36
- owners: null,
37
- historical_balances: null
38
- )
39
- ```
40
-
@@ -1,24 +0,0 @@
1
- # Plaid::AccountAssetsAllOf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **days_available** | **Float** | The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Assets endpoints. | [optional] |
8
- | **transactions** | [**Array<AssetReportTransaction>**](AssetReportTransaction.md) | Transaction history associated with the account. Only returned by Assets endpoints. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. | [optional] |
9
- | **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. | |
10
- | **historical_balances** | [**Array<HistoricalBalance>**](HistoricalBalance.md) | Calculated data about the historical balances on the account. Only returned by Assets endpoints. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::AccountAssetsAllOf.new(
18
- days_available: null,
19
- transactions: null,
20
- owners: null,
21
- historical_balances: null
22
- )
23
- ```
24
-
@@ -1,26 +0,0 @@
1
- # Plaid::AccountBalance
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **available** | **Float** | The amount of funds available to be withdrawn from the account, as determined by the financial institution. For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. | [optional] |
8
- | **current** | **Float** | The total amount of funds in or owed by the account. For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. For `investment`-type accounts, the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get`, and current balance information is typically not updated intra-day. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. | |
9
- | **limit** | **Float** | For `credit`-type accounts, this represents the credit limit. For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for `credit`-type accounts. | [optional] |
10
- | **iso_currency_code** | **String** | The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null. | [optional] |
11
- | **unofficial_currency_code** | **String** | The unofficial currency code associated with the balance. Always null if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::AccountBalance.new(
19
- available: null,
20
- current: null,
21
- limit: null,
22
- iso_currency_code: null,
23
- unofficial_currency_code: null
24
- )
25
- ```
26
-
data/docs/AccountBase.md DELETED
@@ -1,32 +0,0 @@
1
- # Plaid::AccountBase
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account. The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`. Like all Plaid identifiers, the `account_id` is case sensitive. | |
8
- | **balances** | [**AccountBalance**](AccountBalance.md) | | |
9
- | **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
10
- | **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself | |
11
- | **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
12
- | **type** | [**AccountType**](AccountType.md) | | |
13
- | **subtype** | [**AccountSubtype**](AccountSubtype.md) | | |
14
- | **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only. `pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. | [optional] |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'plaid'
20
-
21
- instance = Plaid::AccountBase.new(
22
- account_id: null,
23
- balances: null,
24
- mask: null,
25
- name: null,
26
- official_name: null,
27
- type: null,
28
- subtype: null,
29
- verification_status: null
30
- )
31
- ```
32
-
@@ -1,24 +0,0 @@
1
- # Plaid::AccountFiltersResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **depository** | [**DepositoryFilter**](DepositoryFilter.md) | | [optional] |
8
- | **credit** | [**CreditFilter**](CreditFilter.md) | | [optional] |
9
- | **loan** | [**LoanFilter**](LoanFilter.md) | | [optional] |
10
- | **investment** | [**InvestmentFilter**](InvestmentFilter.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::AccountFiltersResponse.new(
18
- depository: null,
19
- credit: null,
20
- loan: null,
21
- investment: null
22
- )
23
- ```
24
-