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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
data/docs/SandboxPublicTokenCreateRequest.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::SandboxPublicTokenCreateRequest
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 the Item will be associated with | |
10
- | **initial_products** | [**Array<Products>**](Products.md) | The products to initially pull for the Item. May be any products that the specified `institution_id` supports. This array may not be empty. | |
11
- | **options** | [**SandboxPublicTokenCreateRequestOptions**](SandboxPublicTokenCreateRequestOptions.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::SandboxPublicTokenCreateRequest.new(
19
- client_id: null,
20
- secret: null,
21
- institution_id: null,
22
- initial_products: null,
23
- options: null
24
- )
25
- ```
26
-
data/docs/SandboxPublicTokenCreateRequestOptions.md DELETED
@@ -1,24 +0,0 @@
1
- # Plaid::SandboxPublicTokenCreateRequestOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook** | **String** | Specify a webhook to associate with the new Item. | [optional] |
8
- | **override_username** | **String** | Test username to use for the creation of the Sandbox Item. Default value is `user_good`. | [optional][default to 'user_good'] |
9
- | **override_password** | **String** | Test password to use for the creation of the Sandbox Item. Default value is `pass_good`. | [optional][default to 'pass_good'] |
10
- | **transactions** | [**SandboxPublicTokenCreateRequestOptionsTransactions**](SandboxPublicTokenCreateRequestOptionsTransactions.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::SandboxPublicTokenCreateRequestOptions.new(
18
- webhook: null,
19
- override_username: null,
20
- override_password: null,
21
- transactions: null
22
- )
23
- ```
24
-
data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md DELETED
@@ -1,20 +0,0 @@
1
- # Plaid::SandboxPublicTokenCreateRequestOptionsTransactions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **start_date** | **String** | The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. | [optional] |
8
- | **end_date** | **String** | The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::SandboxPublicTokenCreateRequestOptionsTransactions.new(
16
- start_date: null,
17
- end_date: null
18
- )
19
- ```
20
-
data/docs/SandboxPublicTokenCreateResponse.md DELETED
@@ -1,20 +0,0 @@
1
- # Plaid::SandboxPublicTokenCreateResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **public_token** | **String** | A public token that can be exchanged for an access token using `/item/public_token/exchange` | |
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::SandboxPublicTokenCreateResponse.new(
16
- public_token: null,
17
- request_id: null
18
- )
19
- ```
20
-
data/docs/Security.md DELETED
@@ -1,46 +0,0 @@
1
- # Plaid::Security
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **security_id** | **String** | A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the `security_id` is case sensitive. | |
8
- | **isin** | **String** | 12-character ISIN, a globally unique securities identifier. | [optional] |
9
- | **cusip** | **String** | 9-character CUSIP, an identifier assigned to North American securities. | [optional] |
10
- | **sedol** | **String** | 7-character SEDOL, an identifier assigned to securities in the UK. | [optional] |
11
- | **institution_security_id** | **String** | An identifier given to the security by the institution | [optional] |
12
- | **institution_id** | **String** | If `institution_security_id` is present, this field indicates the Plaid `institution_id` of the institution to whom the identifier belongs. | [optional] |
13
- | **proxy_security_id** | **String** | In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security. | [optional] |
14
- | **name** | **String** | A descriptive name for the security, suitable for display. | [optional] |
15
- | **ticker_symbol** | **String** | The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available. | [optional] |
16
- | **is_cash_equivalent** | **Boolean** | Indicates that a security is a highly liquid asset and can be treated like cash. | [optional] |
17
- | **type** | **String** | The security type of the holding. Valid security types are: `cash`: Cash, currency, and money market funds `derivative`: Options, warrants, and other derivative instruments `equity`: Domestic and foreign equities `etf`: Multi-asset exchange-traded investment funds `fixed income`: Bonds and certificates of deposit (CDs) `loan`: Loans and loan receivables. `mutual fund`: Open- and closed-end vehicles pooling funds of multiple investors. `other`: Unknown or other investment types | |
18
- | **close_price** | **Float** | Price of the security at the close of the previous trading session. `null` for non-public securities. | [optional] |
19
- | **close_price_as_of** | **String** | Date for which `close_price` is accurate. Always `null` if `close_price` is `null`. | [optional] |
20
- | **iso_currency_code** | **String** | The ISO-4217 currency code of the price given. Always `null` if `unofficial_currency_code` is non-`null`. | [optional] |
21
- | **unofficial_currency_code** | **String** | The unofficial currency code associated with the security. 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 `iso_currency_code`s. | [optional] |
22
-
23
- ## Example
24
-
25
- ```ruby
26
- require 'plaid'
27
-
28
- instance = Plaid::Security.new(
29
- security_id: null,
30
- isin: null,
31
- cusip: null,
32
- sedol: null,
33
- institution_security_id: null,
34
- institution_id: null,
35
- proxy_security_id: null,
36
- name: null,
37
- ticker_symbol: null,
38
- is_cash_equivalent: null,
39
- type: null,
40
- close_price: null,
41
- close_price_as_of: null,
42
- iso_currency_code: null,
43
- unofficial_currency_code: null
44
- )
45
- ```
46
-
data/docs/ServicerAddressData.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::ServicerAddressData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **city** | **String** | The full city name | [optional] |
8
- | **region** | **String** | The region or state Example: `\"NC\"` | [optional] |
9
- | **street** | **String** | The full street address Example: `\"564 Main Street, APT 15\"` | [optional] |
10
- | **postal_code** | **String** | The postal code | [optional] |
11
- | **country** | **String** | The ISO 3166-1 alpha-2 country code | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::ServicerAddressData.new(
19
- city: null,
20
- region: null,
21
- street: null,
22
- postal_code: null,
23
- country: null
24
- )
25
- ```
26
-
data/docs/StandaloneAccountType.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::StandaloneAccountType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **depository** | **String** | An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth, Balance, Transactions, Identity, Payment Initiation, and Assets. | |
8
- | **credit** | **String** | A credit card type account. Supported products for `credit` accounts are: Balance, Transactions, Identity, and Liabilities. | |
9
- | **loan** | **String** | A loan type account. Supported products for `loan` accounts are: Balance, Liabilities, and Transactions. | |
10
- | **investment** | **String** | An investment account. Supported products for `investment` accounts are: Balance and Investments. | |
11
- | **other** | **String** | Other or unknown account type. Supported products for `other` accounts are: Balance, Transactions, Identity, and Assets. | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::StandaloneAccountType.new(
19
- depository: null,
20
- credit: null,
21
- loan: null,
22
- investment: null,
23
- other: null
24
- )
25
- ```
26
-
data/docs/StandaloneCurrencyCodeList.md DELETED
@@ -1,20 +0,0 @@
1
- # Plaid::StandaloneCurrencyCodeList
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **iso_currency_code** | **String** | Plaid supports all ISO 4217 currency codes. | |
8
- | **unofficial_currency_code** | **String** | List of unofficial currency codes | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::StandaloneCurrencyCodeList.new(
16
- iso_currency_code: null,
17
- unofficial_currency_code: null
18
- )
19
- ```
20
-
data/docs/StandaloneInvestmentTransactionSubtype.md DELETED
@@ -1,104 +0,0 @@
1
- # Plaid::StandaloneInvestmentTransactionSubtype
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **account_fee** | **String** | Fees paid for account maintenance | [optional] |
8
- | **assignment** | **String** | Assignment of short option holding | [optional] |
9
- | **buy** | **String** | Purchase to open or increase a position | [optional] |
10
- | **buy_to_cover** | **String** | Purchase to close a short position | [optional] |
11
- | **contribution** | **String** | Inflow of assets into a tax-advantaged account | [optional] |
12
- | **deposit** | **String** | Inflow of cash into an account | [optional] |
13
- | **distribution** | **String** | Outflow of assets from a tax-advantaged account | [optional] |
14
- | **dividend** | **String** | Inflow of cash from a dividend | [optional] |
15
- | **dividend_reinvestment** | **String** | Purchase using proceeds from a cash dividend | [optional] |
16
- | **exercise** | **String** | Exercise of an option or warrant contract | [optional] |
17
- | **expire** | **String** | Expiration of an option or warrant contract | [optional] |
18
- | **fund_fee** | **String** | Fees paid for administration of a mutual fund or other pooled investment vehicle | [optional] |
19
- | **interest** | **String** | Inflow of cash from interest | [optional] |
20
- | **interest_receivable** | **String** | Inflow of cash from interest receivable | [optional] |
21
- | **interest_reinvestment** | **String** | Purchase using proceeds from a cash interest payment | [optional] |
22
- | **legal_fee** | **String** | Fees paid for legal charges or services | [optional] |
23
- | **loan_payment** | **String** | Inflow of cash related to payment on a loan | [optional] |
24
- | **long_term_capital_gain** | **String** | Long-term capital gain received as cash | [optional] |
25
- | **long_term_capital_gain_reinvestment** | **String** | Purchase using long-term capital gain cash proceeds | [optional] |
26
- | **management_fee** | **String** | Fees paid for investment management of a mutual fund or other pooled investment vehicle | [optional] |
27
- | **margin_expense** | **String** | Fees paid for maintaining margin debt | [optional] |
28
- | **merger** | **String** | Stock exchanged at a pre-defined ratio as part of a merger between companies | [optional] |
29
- | **miscellaneous_fee** | **String** | Fee associated with various account or holding actions | [optional] |
30
- | **non_qualified_dividend** | **String** | Inflow of cash from a non-qualified dividend | [optional] |
31
- | **non_resident_tax** | **String** | Taxes paid on behalf of the investor for non-residency in investment jurisdiction | [optional] |
32
- | **pending_credit** | **String** | Pending inflow of cash | [optional] |
33
- | **pending_debit** | **String** | Pending outflow of cash | [optional] |
34
- | **qualified_dividend** | **String** | Inflow of cash from a qualified dividend | [optional] |
35
- | **rebalance** | **String** | Rebalancing transaction (buy or sell) with no net impact to value in the account | [optional] |
36
- | **return_of_principal** | **String** | Repayment of loan principal | [optional] |
37
- | **sell** | **String** | Sell to close or decrease an existing holding | [optional] |
38
- | **sell_short** | **String** | Sell to open a short position | [optional] |
39
- | **short_term_capital_gain** | **String** | Short-term capital gain received as cash | [optional] |
40
- | **short_term_capital_gain_reinvestment** | **String** | Purchase using short-term capital gain cash proceeds | [optional] |
41
- | **spin_off** | **String** | Inflow of stock from spin-off transaction of an existing holding | [optional] |
42
- | **split** | **String** | Inflow of stock from a forward split of an existing holding | [optional] |
43
- | **stock_distribution** | **String** | Inflow of stock from a distribution | [optional] |
44
- | **tax** | **String** | Taxes paid on behalf of the investor | [optional] |
45
- | **tax_withheld** | **String** | Taxes withheld on behalf of the customer | [optional] |
46
- | **transfer** | **String** | Movement of assets into or out of an account | [optional] |
47
- | **transfer_fee** | **String** | Fees incurred for transfer of a holding or account | [optional] |
48
- | **trust_fee** | **String** | Fees related to adminstration of a trust account | [optional] |
49
- | **unqualified_gain** | **String** | Unqualified capital gain received as cash | [optional] |
50
- | **withdrawal** | **String** | Outflow of cash from an account | [optional] |
51
-
52
- ## Example
53
-
54
- ```ruby
55
- require 'plaid'
56
-
57
- instance = Plaid::StandaloneInvestmentTransactionSubtype.new(
58
- account_fee: null,
59
- assignment: null,
60
- buy: null,
61
- buy_to_cover: null,
62
- contribution: null,
63
- deposit: null,
64
- distribution: null,
65
- dividend: null,
66
- dividend_reinvestment: null,
67
- exercise: null,
68
- expire: null,
69
- fund_fee: null,
70
- interest: null,
71
- interest_receivable: null,
72
- interest_reinvestment: null,
73
- legal_fee: null,
74
- loan_payment: null,
75
- long_term_capital_gain: null,
76
- long_term_capital_gain_reinvestment: null,
77
- management_fee: null,
78
- margin_expense: null,
79
- merger: null,
80
- miscellaneous_fee: null,
81
- non_qualified_dividend: null,
82
- non_resident_tax: null,
83
- pending_credit: null,
84
- pending_debit: null,
85
- qualified_dividend: null,
86
- rebalance: null,
87
- return_of_principal: null,
88
- sell: null,
89
- sell_short: null,
90
- short_term_capital_gain: null,
91
- short_term_capital_gain_reinvestment: null,
92
- spin_off: null,
93
- split: null,
94
- stock_distribution: null,
95
- tax: null,
96
- tax_withheld: null,
97
- transfer: null,
98
- transfer_fee: null,
99
- trust_fee: null,
100
- unqualified_gain: null,
101
- withdrawal: null
102
- )
103
- ```
104
-
data/docs/StandaloneInvestmentTransactionType.md DELETED
@@ -1,28 +0,0 @@
1
- # Plaid::StandaloneInvestmentTransactionType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **buy** | **String** | Buying an investment | |
8
- | **sell** | **String** | Selling an investment | |
9
- | **cancel** | **String** | A cancellation of a pending transaction | |
10
- | **cash** | **String** | Activity that modifies a cash position | |
11
- | **fee** | **String** | Fees on the account, e.g. commission, bookkeeping, options-related. | |
12
- | **transfer** | **String** | Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'plaid'
18
-
19
- instance = Plaid::StandaloneInvestmentTransactionType.new(
20
- buy: null,
21
- sell: null,
22
- cancel: null,
23
- cash: null,
24
- fee: null,
25
- transfer: null
26
- )
27
- ```
28
-
data/docs/StudentLoan.md DELETED
@@ -1,66 +0,0 @@
1
- # Plaid::StudentLoan
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **account_id** | **String** | The ID of the account that this liability belongs to. | [optional] |
8
- | **account_number** | **String** | The account number of the loan. | [optional] |
9
- | **disbursement_dates** | **Array<String>** | The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
10
- | **expected_payoff_date** | **String** | The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
11
- | **guarantor** | **String** | The guarantor of the student loan. | [optional] |
12
- | **interest_rate_percentage** | **Float** | The interest rate on the loan as a percentage. | |
13
- | **is_overdue** | **Boolean** | `true` if a payment is currently overdue. Availability for this field is limited. | [optional] |
14
- | **last_payment_amount** | **Float** | The amount of the last payment. | [optional] |
15
- | **last_payment_date** | **String** | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
16
- | **last_statement_balance** | **Float** | The outstanding balance on the last statement. This field could also be interpreted as the next payment due. Availability for this field is limited. | [optional] |
17
- | **last_statement_issue_date** | **String** | The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
18
- | **loan_name** | **String** | The type of loan, e.g., \"Consolidation Loans\". | [optional] |
19
- | **loan_status** | [**StudentLoanStatus**](StudentLoanStatus.md) | | [optional] |
20
- | **minimum_payment_amount** | **Float** | The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) will display as $0 if there is an autopay program in effect. | [optional] |
21
- | **next_payment_due_date** | **String** | The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
22
- | **origination_date** | **String** | The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
23
- | **origination_principal_amount** | **Float** | The original principal balance of the loan. | [optional] |
24
- | **outstanding_interest_amount** | **Float** | The total dollar amount of the accrued interest balance. For Sallie Mae ( `ins_116944`), this amount is included in the current balance of the loan, so this field will return as `null`. | [optional] |
25
- | **payment_reference_number** | **String** | The relevant account number that should be used to reference this loan for payments. In the majority of cases, `payment_reference_number` will match a`ccount_number,` but in some institutions, such as Great Lakes (`ins_116861`), it will be different. | [optional] |
26
- | **pslf_status** | [**PSLFStatus**](PSLFStatus.md) | | [optional] |
27
- | **repayment_plan** | [**StudentRepaymentPlan**](StudentRepaymentPlan.md) | | [optional] |
28
- | **sequence_number** | **String** | The sequence number of the student loan. Heartland ECSI (`ins_116948`) does not make this field available. | [optional] |
29
- | **servicer_address** | [**ServicerAddressData**](ServicerAddressData.md) | | [optional] |
30
- | **ytd_interest_paid** | **Float** | The year to date (YTD) interest paid. Availability for this field is limited. | [optional] |
31
- | **ytd_principal_paid** | **Float** | The year to date (YTD) principal paid. Availability for this field is limited. | [optional] |
32
-
33
- ## Example
34
-
35
- ```ruby
36
- require 'plaid'
37
-
38
- instance = Plaid::StudentLoan.new(
39
- account_id: null,
40
- account_number: null,
41
- disbursement_dates: null,
42
- expected_payoff_date: null,
43
- guarantor: null,
44
- interest_rate_percentage: null,
45
- is_overdue: null,
46
- last_payment_amount: null,
47
- last_payment_date: null,
48
- last_statement_balance: null,
49
- last_statement_issue_date: null,
50
- loan_name: null,
51
- loan_status: null,
52
- minimum_payment_amount: null,
53
- next_payment_due_date: null,
54
- origination_date: null,
55
- origination_principal_amount: null,
56
- outstanding_interest_amount: null,
57
- payment_reference_number: null,
58
- pslf_status: null,
59
- repayment_plan: null,
60
- sequence_number: null,
61
- servicer_address: null,
62
- ytd_interest_paid: null,
63
- ytd_principal_paid: null
64
- )
65
- ```
66
-
data/docs/StudentLoanRepaymentModel.md DELETED
@@ -1,22 +0,0 @@
1
- # Plaid::StudentLoanRepaymentModel
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | The only currently supported value for this field is `standard`. | |
8
- | **non_repayment_months** | **Float** | Configures the number of months before repayment starts. | |
9
- | **repayment_months** | **Float** | Configures the number of months of repayments before the loan is paid off. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::StudentLoanRepaymentModel.new(
17
- type: null,
18
- non_repayment_months: null,
19
- repayment_months: null
20
- )
21
- ```
22
-
data/docs/StudentLoanStatus.md DELETED
@@ -1,20 +0,0 @@
1
- # Plaid::StudentLoanStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **end_date** | **String** | The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
8
- | **type** | **String** | The status type of the student loan | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::StudentLoanStatus.new(
16
- end_date: null,
17
- type: null
18
- )
19
- ```
20
-
data/docs/StudentRepaymentPlan.md DELETED
@@ -1,20 +0,0 @@
1
- # Plaid::StudentRepaymentPlan
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **description** | **String** | The description of the repayment plan as provided by the servicer. | [optional] |
8
- | **type** | **String** | The type of the repayment plan. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::StudentRepaymentPlan.new(
16
- description: null,
17
- type: null
18
- )
19
- ```
20
-
data/docs/Transaction.md DELETED
@@ -1,54 +0,0 @@
1
- # Plaid::Transaction
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **transaction_type** | **String** | Please use the `payment_channel` field, `transaction_type` will be deprecated in the future. `digital:` transactions that took place online. `place:` transactions that were made at a physical location. `special:` transactions that relate to banks, e.g. fees or deposits. `unresolved:` transactions that do not fit into the other three types. | [optional] |
8
- | **transaction_id** | **String** | The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive. | |
9
- | **account_owner** | **String** | The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts. | [optional] |
10
- | **pending_transaction_id** | **String** | The ID of a posted transaction's associated pending transaction, where applicable. | [optional] |
11
- | **pending** | **Boolean** | When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. | |
12
- | **payment_channel** | **String** | The channel used to make a payment. `online:` transactions that took place online. `in store:` transactions that were made at a physical location. `other:` transactions that relate to banks, e.g. fees or deposits. This field replaces the `transaction_type` field. | [optional] |
13
- | **payment_meta** | [**PaymentMeta**](PaymentMeta.md) | | [optional] |
14
- | **name** | **String** | The merchant name or transaction description. If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
15
- | **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
16
- | **location** | [**Location**](Location.md) | | [optional] |
17
- | **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
18
- | **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | |
19
- | **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
20
- | **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
21
- | **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. 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 `iso_currency_code`s. | [optional] |
22
- | **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null. | [optional] |
23
- | **amount** | **Float** | The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. | |
24
- | **account_id** | **String** | The ID of the account in which this transaction occurred. | |
25
- | **transaction_code** | [**TransactionCode**](TransactionCode.md) | | [optional] |
26
-
27
- ## Example
28
-
29
- ```ruby
30
- require 'plaid'
31
-
32
- instance = Plaid::Transaction.new(
33
- transaction_type: null,
34
- transaction_id: null,
35
- account_owner: null,
36
- pending_transaction_id: null,
37
- pending: null,
38
- payment_channel: null,
39
- payment_meta: null,
40
- name: null,
41
- merchant_name: null,
42
- location: null,
43
- authorized_date: null,
44
- date: null,
45
- category_id: null,
46
- category: null,
47
- unofficial_currency_code: null,
48
- iso_currency_code: null,
49
- amount: null,
50
- account_id: null,
51
- transaction_code: null
52
- )
53
- ```
54
-
data/docs/TransactionCode.md DELETED
@@ -1,15 +0,0 @@
1
- # Plaid::TransactionCode
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'plaid'
12
-
13
- instance = Plaid::TransactionCode.new()
14
- ```
15
-
data/docs/TransactionData.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::TransactionData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **description** | **String** | The description of the transaction. | |
8
- | **amount** | **Float** | The amount of the transaction. | |
9
- | **date** | **String** | The date of the transaction, in ISO 8601 format (\"yyyy-mm-dd\"). | |
10
- | **account_id** | **String** | A unique identifier for the end user's account. | |
11
- | **transaction_id** | **String** | A unique identifier for the transaction. | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::TransactionData.new(
19
- description: null,
20
- amount: null,
21
- date: null,
22
- account_id: null,
23
- transaction_id: null
24
- )
25
- ```
26
-
data/docs/TransactionOverride.md DELETED
@@ -1,26 +0,0 @@
1
- # Plaid::TransactionOverride
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **transaction_date** | **String** | The date of the transaction, in ISO8601 (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. | |
8
- | **posted_date** | **String** | The date the transaction posted, in ISO8601 (YYYY-MM-DD) format | |
9
- | **amount** | **Float** | The transaction amount. Can be negative. | |
10
- | **description** | **String** | The transaction description. | |
11
- | **currency** | **String** | The ISO-4217 format currency code for the transaction. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::TransactionOverride.new(
19
- transaction_date: null,
20
- posted_date: null,
21
- amount: null,
22
- description: null,
23
- currency: null
24
- )
25
- ```
26
-
data/docs/TransactionsGetRequest.md DELETED
@@ -1,28 +0,0 @@
1
- # Plaid::TransactionsGetRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **options** | [**TransactionsGetRequestOptions**](TransactionsGetRequestOptions.md) | | [optional] |
9
- | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
11
- | **start_date** | **Date** | The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | |
12
- | **end_date** | **Date** | The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'plaid'
18
-
19
- instance = Plaid::TransactionsGetRequest.new(
20
- client_id: null,
21
- options: null,
22
- access_token: null,
23
- secret: null,
24
- start_date: null,
25
- end_date: null
26
- )
27
- ```
28
-