plaid 14.0.0.beta.4 → 14.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (772) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -1
  3. data/CONTRIBUTING.md +1 -5
  4. data/Gemfile.lock +18 -4
  5. data/LICENSE.txt +1 -1
  6. data/Makefile +2 -2
  7. data/PUBLISH.md +1 -1
  8. data/README.md +12 -11
  9. data/lib/plaid/api/plaid_api.rb +2392 -812
  10. data/lib/plaid/api_client.rb +5 -4
  11. data/lib/plaid/api_error.rb +3 -3
  12. data/lib/plaid/configuration.rb +4 -2
  13. data/lib/plaid/models/account_access.rb +238 -0
  14. data/lib/plaid/models/account_assets.rb +18 -7
  15. data/lib/plaid/models/account_assets_all_of.rb +16 -4
  16. data/lib/plaid/models/account_balance.rb +21 -14
  17. data/lib/plaid/models/account_base.rb +3 -4
  18. data/lib/plaid/models/account_filter.rb +258 -0
  19. data/lib/plaid/models/account_filters_response.rb +1 -1
  20. data/lib/plaid/models/account_identity.rb +3 -4
  21. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  22. data/lib/plaid/models/account_selection_cardinality.rb +38 -0
  23. data/lib/plaid/models/account_subtype.rb +7 -1
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +15 -5
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/address.rb +1 -2
  32. data/lib/plaid/models/address_data.rb +2 -6
  33. data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +5 -9
  34. data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +4 -5
  35. data/lib/plaid/models/application.rb +288 -0
  36. data/lib/plaid/models/application_get_request.rb +255 -0
  37. data/lib/plaid/models/application_get_response.rb +239 -0
  38. data/lib/plaid/models/apr.rb +1 -1
  39. data/lib/plaid/models/asset_report.rb +3 -3
  40. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  41. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  42. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  43. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  44. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  45. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  46. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  47. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  48. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_get_request.rb +2 -2
  51. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  52. data/lib/plaid/models/asset_report_item.rb +3 -3
  53. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  56. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  57. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_transaction.rb +108 -187
  60. data/lib/plaid/models/asset_report_transaction_all_of.rb +6 -21
  61. data/lib/plaid/models/asset_report_user.rb +2 -2
  62. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  63. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  64. data/lib/plaid/models/auth_get_numbers.rb +21 -1
  65. data/lib/plaid/models/auth_get_request.rb +1 -1
  66. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  67. data/lib/plaid/models/auth_get_response.rb +1 -1
  68. data/lib/plaid/models/auth_metadata.rb +220 -0
  69. data/lib/plaid/models/auth_supported_methods.rb +255 -0
  70. data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
  71. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  72. data/lib/plaid/models/bank_transfer.rb +3 -3
  73. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  74. data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
  75. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  76. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  77. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  78. data/lib/plaid/models/bank_transfer_create_request.rb +4 -4
  79. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  80. data/lib/plaid/models/bank_transfer_direction.rb +2 -1
  81. data/lib/plaid/models/bank_transfer_event.rb +2 -2
  82. data/lib/plaid/models/bank_transfer_event_list_request.rb +17 -5
  83. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  84. data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  87. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  89. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  90. data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
  91. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  92. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +2 -2
  93. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  94. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_receiver_details.rb +3 -3
  96. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_sweep.rb +316 -0
  98. data/lib/plaid/models/bank_transfer_sweep_account.rb +238 -0
  99. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +277 -0
  100. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
  101. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +330 -0
  102. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
  103. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  105. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  106. data/lib/plaid/models/categories_get_response.rb +1 -1
  107. data/lib/plaid/models/category.rb +1 -1
  108. data/lib/plaid/models/cause.rb +1 -1
  109. data/lib/plaid/models/connected_application.rb +357 -0
  110. data/lib/plaid/models/country_code.rb +1 -1
  111. data/lib/plaid/models/credit_card_liability.rb +9 -28
  112. data/lib/plaid/models/credit_filter.rb +2 -2
  113. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  114. data/lib/plaid/models/deductions.rb +232 -0
  115. data/lib/plaid/models/default_update_webhook.rb +1 -1
  116. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  117. data/lib/plaid/models/deposit_switch_alt_create_request.rb +59 -5
  118. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  119. data/lib/plaid/models/deposit_switch_create_request.rb +59 -5
  120. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  121. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  122. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  123. data/lib/plaid/models/deposit_switch_get_response.rb +76 -9
  124. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
  125. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  126. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  127. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  128. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  129. data/lib/plaid/models/depository_filter.rb +2 -2
  130. data/lib/plaid/models/distribution_details.rb +263 -0
  131. data/lib/plaid/models/document_metadata.rb +240 -0
  132. data/lib/plaid/models/earnings.rb +232 -0
  133. data/lib/plaid/models/earnings_total.rb +304 -0
  134. data/lib/plaid/models/email.rb +1 -1
  135. data/lib/plaid/models/employee.rb +25 -12
  136. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  137. data/lib/plaid/models/employer.rb +7 -3
  138. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  139. data/lib/plaid/models/employers_search_request.rb +1 -1
  140. data/lib/plaid/models/employers_search_response.rb +1 -1
  141. data/lib/plaid/models/employment_details.rb +230 -0
  142. data/lib/plaid/models/error.rb +4 -11
  143. data/lib/plaid/models/external_payment_options.rb +296 -0
  144. data/lib/plaid/models/external_payment_refund_details.rb +245 -0
  145. data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +24 -28
  146. data/lib/plaid/models/external_payment_schedule_get.rb +22 -22
  147. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  148. data/lib/plaid/models/health_incident.rb +20 -7
  149. data/lib/plaid/models/historical_balance.rb +4 -4
  150. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  151. data/lib/plaid/models/holding.rb +4 -4
  152. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  153. data/lib/plaid/models/holdings_override.rb +289 -0
  154. data/lib/plaid/models/identity_get_request.rb +1 -1
  155. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  156. data/lib/plaid/models/identity_get_response.rb +1 -1
  157. data/lib/plaid/models/incident_update.rb +5 -5
  158. data/lib/plaid/models/income_breakdown.rb +37 -2
  159. data/lib/plaid/models/income_summary.rb +26 -1
  160. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  161. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  162. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  163. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  164. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -10
  165. data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
  166. data/lib/plaid/models/income_verification_paystub_get_request.rb +17 -10
  167. data/lib/plaid/models/income_verification_paystub_get_response.rb +22 -2
  168. data/lib/plaid/models/income_verification_paystubs_get_request.rb +252 -0
  169. data/lib/plaid/models/income_verification_paystubs_get_response.rb +262 -0
  170. data/lib/plaid/models/income_verification_precheck_employer.rb +229 -0
  171. data/lib/plaid/models/{amount.rb → income_verification_precheck_military_info.rb} +29 -38
  172. data/lib/plaid/models/income_verification_precheck_request.rb +271 -0
  173. data/lib/plaid/models/income_verification_precheck_response.rb +289 -0
  174. data/lib/plaid/models/income_verification_precheck_user.rb +252 -0
  175. data/lib/plaid/models/income_verification_refresh_request.rb +252 -0
  176. data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
  177. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  178. data/lib/plaid/models/income_verification_summary_get_request.rb +17 -10
  179. data/lib/plaid/models/income_verification_summary_get_response.rb +12 -2
  180. data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
  181. data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
  182. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  183. data/lib/plaid/models/inflow_model.rb +1 -1
  184. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  185. data/lib/plaid/models/institution.rb +26 -6
  186. data/lib/plaid/models/institution_status.rb +30 -3
  187. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  188. data/lib/plaid/models/institutions_get_by_id_request_options.rb +29 -5
  189. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  190. data/lib/plaid/models/institutions_get_request.rb +1 -1
  191. data/lib/plaid/models/institutions_get_request_options.rb +29 -5
  192. data/lib/plaid/models/institutions_get_response.rb +1 -1
  193. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  194. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +220 -0
  195. data/lib/plaid/models/institutions_search_request.rb +2 -2
  196. data/lib/plaid/models/institutions_search_request_options.rb +40 -6
  197. data/lib/plaid/models/institutions_search_response.rb +1 -1
  198. data/lib/plaid/models/investment_filter.rb +2 -2
  199. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  200. data/lib/plaid/models/investment_transaction.rb +7 -7
  201. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  202. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  203. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  204. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  205. data/lib/plaid/models/investments_transactions_get_request_options.rb +6 -6
  206. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  207. data/lib/plaid/models/investments_transactions_override.rb +319 -0
  208. data/lib/plaid/models/item.rb +6 -6
  209. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  210. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  211. data/lib/plaid/models/item_application_list_request.rb +241 -0
  212. data/lib/plaid/models/item_application_list_response.rb +237 -0
  213. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  214. data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
  215. data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
  216. data/lib/plaid/models/item_error_webhook.rb +1 -1
  217. data/lib/plaid/models/item_get_request.rb +1 -1
  218. data/lib/plaid/models/item_get_response.rb +6 -16
  219. data/lib/plaid/models/item_import_request.rb +1 -1
  220. data/lib/plaid/models/item_import_request_options.rb +1 -1
  221. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  222. data/lib/plaid/models/item_import_response.rb +1 -1
  223. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  224. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  225. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  226. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  227. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  228. data/lib/plaid/models/item_remove_request.rb +1 -1
  229. data/lib/plaid/models/item_remove_response.rb +1 -1
  230. data/lib/plaid/models/item_status.rb +7 -16
  231. data/lib/plaid/models/item_status_investments.rb +232 -0
  232. data/lib/plaid/models/{nullable_recipient_bacs.rb → item_status_last_webhook.rb} +22 -26
  233. data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +10 -19
  234. data/lib/plaid/models/item_status_transactions.rb +232 -0
  235. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  236. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  237. data/lib/plaid/models/jwk_public_key.rb +43 -1
  238. data/lib/plaid/models/jwt_header.rb +1 -1
  239. data/lib/plaid/models/liabilities_default_update_webhook.rb +299 -0
  240. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  241. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  242. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  243. data/lib/plaid/models/liabilities_object.rb +4 -4
  244. data/lib/plaid/models/liability_override.rb +6 -21
  245. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  246. data/lib/plaid/models/link_token_create_request.rb +16 -7
  247. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  248. data/lib/plaid/models/link_token_create_request_auth.rb +18 -18
  249. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  250. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -3
  251. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +22 -1
  252. data/lib/plaid/models/link_token_create_request_user.rb +9 -9
  253. data/lib/plaid/models/link_token_create_response.rb +2 -2
  254. data/lib/plaid/models/{nullable_access_token.rb → link_token_eu_config.rb} +17 -6
  255. data/lib/plaid/models/link_token_get_metadata_response.rb +11 -1
  256. data/lib/plaid/models/link_token_get_request.rb +1 -1
  257. data/lib/plaid/models/link_token_get_response.rb +13 -3
  258. data/lib/plaid/models/loan_filter.rb +2 -2
  259. data/lib/plaid/models/location.rb +1 -1
  260. data/lib/plaid/models/meta.rb +1 -1
  261. data/lib/plaid/models/mfa.rb +1 -1
  262. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  263. data/lib/plaid/models/mortgage_liability.rb +24 -10
  264. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  265. data/lib/plaid/models/net_pay.rb +230 -0
  266. data/lib/plaid/models/numbers.rb +1 -41
  267. data/lib/plaid/models/numbers_ach.rb +3 -3
  268. data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +6 -6
  269. data/lib/plaid/models/numbers_bacs.rb +1 -1
  270. data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +4 -4
  271. data/lib/plaid/models/numbers_eft.rb +1 -1
  272. data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +4 -4
  273. data/lib/plaid/models/numbers_international.rb +1 -1
  274. data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +4 -4
  275. data/lib/plaid/models/override_account_type.rb +40 -0
  276. data/lib/plaid/models/override_accounts.rb +21 -3
  277. data/lib/plaid/models/owner.rb +2 -2
  278. data/lib/plaid/models/owner_override.rb +1 -1
  279. data/lib/plaid/models/pay.rb +258 -0
  280. data/lib/plaid/models/pay_frequency.rb +1 -1
  281. data/lib/plaid/models/pay_period_details.rb +7 -7
  282. data/lib/plaid/models/payment_amount.rb +48 -3
  283. data/lib/plaid/models/payment_initiation_address.rb +118 -4
  284. data/lib/plaid/models/payment_initiation_metadata.rb +267 -0
  285. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +288 -0
  286. data/lib/plaid/models/payment_initiation_payment.rb +425 -0
  287. data/lib/plaid/models/payment_initiation_payment_create_request.rb +67 -7
  288. data/lib/plaid/models/payment_initiation_payment_create_response.rb +35 -1
  289. data/lib/plaid/models/payment_initiation_payment_get_request.rb +22 -1
  290. data/lib/plaid/models/payment_initiation_payment_get_response.rb +101 -17
  291. data/lib/plaid/models/payment_initiation_payment_list_request.rb +13 -2
  292. data/lib/plaid/models/payment_initiation_payment_list_response.rb +4 -8
  293. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
  294. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +289 -0
  295. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +22 -1
  296. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
  297. data/lib/plaid/models/payment_initiation_recipient.rb +21 -12
  298. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +50 -2
  299. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  300. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +22 -1
  301. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +22 -3
  302. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  303. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  304. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  305. data/lib/plaid/models/payment_initiation_refund.rb +303 -0
  306. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
  307. data/lib/plaid/models/payment_meta.rb +2 -2
  308. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  309. data/lib/plaid/models/payment_status_update_webhook.rb +4 -4
  310. data/lib/plaid/models/paystub.rb +56 -25
  311. data/lib/plaid/models/paystub_address.rb +297 -0
  312. data/lib/plaid/models/paystub_deduction.rb +1 -1
  313. data/lib/plaid/models/paystub_details.rb +299 -0
  314. data/lib/plaid/models/paystub_employer.rb +229 -0
  315. data/lib/plaid/models/paystub_ytd_details.rb +4 -11
  316. data/lib/plaid/models/pending_expiration_webhook.rb +3 -3
  317. data/lib/plaid/models/personal_finance_category.rb +240 -0
  318. data/lib/plaid/models/phone_number.rb +11 -3
  319. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  320. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  321. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  322. data/lib/plaid/models/processor_balance_get_request.rb +14 -5
  323. data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
  324. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  325. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  326. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  327. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  328. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  329. data/lib/plaid/models/processor_number.rb +5 -5
  330. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  331. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  332. data/lib/plaid/models/processor_token_create_request.rb +36 -2
  333. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  334. data/lib/plaid/models/product_access.rb +262 -0
  335. data/lib/plaid/models/product_status.rb +4 -4
  336. data/lib/plaid/models/product_status_breakdown.rb +1 -2
  337. data/lib/plaid/models/products.rb +3 -1
  338. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  339. data/lib/plaid/models/pslf_status.rb +3 -3
  340. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  341. data/lib/plaid/models/recipient_bacs.rb +53 -1
  342. data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
  343. data/lib/plaid/models/requested_scopes.rb +261 -0
  344. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  345. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  346. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  347. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  348. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
  349. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
  350. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +6 -1
  351. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  352. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  353. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  354. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  355. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  356. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  357. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  358. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  359. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  360. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  361. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  362. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +4 -4
  363. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  364. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
  365. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
  366. data/lib/plaid/models/scopes.rb +243 -0
  367. data/lib/plaid/models/scopes_context.rb +37 -0
  368. data/lib/plaid/models/scopes_nullable.rb +249 -0
  369. data/lib/plaid/models/security.rb +6 -9
  370. data/lib/plaid/models/security_override.rb +270 -0
  371. data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
  372. data/lib/plaid/models/servicer_address_data.rb +1 -1
  373. data/lib/plaid/models/signal_address_data.rb +263 -0
  374. data/lib/plaid/models/signal_decision_report_request.rb +260 -0
  375. data/lib/plaid/models/signal_decision_report_response.rb +225 -0
  376. data/lib/plaid/models/signal_device.rb +232 -0
  377. data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
  378. data/lib/plaid/models/signal_evaluate_request.rb +356 -0
  379. data/lib/plaid/models/signal_evaluate_response.rb +253 -0
  380. data/lib/plaid/models/signal_person_name.rb +265 -0
  381. data/lib/plaid/models/signal_return_report_request.rb +260 -0
  382. data/lib/plaid/models/signal_return_report_response.rb +225 -0
  383. data/lib/plaid/models/signal_scores.rb +228 -0
  384. data/lib/plaid/models/signal_user.rb +252 -0
  385. data/lib/plaid/models/standalone_account_type.rb +1 -1
  386. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  387. data/lib/plaid/models/standalone_investment_transaction_type.rb +3 -3
  388. data/lib/plaid/models/student_loan.rb +34 -25
  389. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  390. data/lib/plaid/models/student_loan_status.rb +3 -3
  391. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  392. data/lib/plaid/models/taxform.rb +233 -0
  393. data/lib/plaid/models/taxpayer_id.rb +257 -0
  394. data/lib/plaid/models/total.rb +284 -0
  395. data/lib/plaid/models/transaction.rb +191 -130
  396. data/lib/plaid/models/transaction_all_of.rb +333 -0
  397. data/lib/plaid/models/transaction_base.rb +436 -0
  398. data/lib/plaid/models/transaction_code.rb +1 -1
  399. data/lib/plaid/models/transaction_data.rb +3 -3
  400. data/lib/plaid/models/transaction_override.rb +5 -5
  401. data/lib/plaid/models/transactions_get_request.rb +1 -1
  402. data/lib/plaid/models/transactions_get_request_options.rb +30 -5
  403. data/lib/plaid/models/transactions_get_response.rb +1 -1
  404. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  405. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  406. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  407. data/lib/plaid/models/transfer.rb +417 -0
  408. data/lib/plaid/models/transfer_authorization.rb +313 -0
  409. data/lib/plaid/models/transfer_authorization_create_request.rb +350 -0
  410. data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
  411. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +274 -0
  412. data/lib/plaid/models/transfer_authorization_device.rb +230 -0
  413. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +312 -0
  414. data/lib/plaid/models/transfer_cancel_request.rb +245 -0
  415. data/lib/plaid/models/transfer_cancel_response.rb +225 -0
  416. data/lib/plaid/models/transfer_create_request.rb +451 -0
  417. data/lib/plaid/models/transfer_create_response.rb +239 -0
  418. data/lib/plaid/models/transfer_event.rb +355 -0
  419. data/lib/plaid/models/transfer_event_list_request.rb +411 -0
  420. data/lib/plaid/models/transfer_event_list_response.rb +241 -0
  421. data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
  422. data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
  423. data/lib/plaid/models/transfer_event_type.rb +40 -0
  424. data/lib/plaid/models/transfer_failure.rb +231 -0
  425. data/lib/plaid/models/transfer_get_request.rb +245 -0
  426. data/lib/plaid/models/transfer_get_response.rb +239 -0
  427. data/lib/plaid/models/transfer_list_request.rb +330 -0
  428. data/lib/plaid/models/transfer_list_response.rb +241 -0
  429. data/lib/plaid/models/transfer_network.rb +37 -0
  430. data/lib/plaid/models/transfer_status.rb +40 -0
  431. data/lib/plaid/models/transfer_type.rb +37 -0
  432. data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
  433. data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
  434. data/lib/plaid/models/transfer_user_in_request.rb +254 -0
  435. data/lib/plaid/models/transfer_user_in_response.rb +257 -0
  436. data/lib/plaid/models/user_custom_password.rb +1 -1
  437. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  438. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  439. data/lib/plaid/models/verification_refresh_status.rb +36 -0
  440. data/lib/plaid/models/verification_status.rb +1 -1
  441. data/lib/plaid/models/w2.rb +437 -0
  442. data/lib/plaid/models/w2_box12.rb +231 -0
  443. data/lib/plaid/models/w2_state_and_local_wages.rb +286 -0
  444. data/lib/plaid/models/warning.rb +35 -1
  445. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  446. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  447. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  448. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  449. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  450. data/lib/plaid/version.rb +2 -2
  451. data/lib/plaid.rb +143 -13
  452. data/plaid.gemspec +1 -1
  453. data/templates/ruby/api_client.mustache +3 -2
  454. data/templates/ruby/api_client_faraday_partial.mustache +2 -1
  455. data/templates/ruby/api_error.mustache +49 -0
  456. data/templates/ruby/configuration.mustache +3 -1
  457. data/test/test_accounts.rb +4 -8
  458. data/test/test_bank_transfers.rb +2 -3
  459. data/test/test_item.rb +0 -10
  460. data/test/test_payment_initiation.rb +2 -3
  461. data/test/test_processor.rb +1 -16
  462. metadata +147 -325
  463. data/docs/ACHClass.md +0 -15
  464. data/docs/APR.md +0 -24
  465. data/docs/AccountAssets.md +0 -40
  466. data/docs/AccountAssetsAllOf.md +0 -24
  467. data/docs/AccountBalance.md +0 -26
  468. data/docs/AccountBase.md +0 -32
  469. data/docs/AccountFiltersResponse.md +0 -24
  470. data/docs/AccountIdentity.md +0 -34
  471. data/docs/AccountIdentityAllOf.md +0 -18
  472. data/docs/AccountSubtype.md +0 -15
  473. data/docs/AccountType.md +0 -15
  474. data/docs/AccountsBalanceGetRequest.md +0 -24
  475. data/docs/AccountsBalanceGetRequestOptions.md +0 -18
  476. data/docs/AccountsGetRequest.md +0 -24
  477. data/docs/AccountsGetRequestOptions.md +0 -18
  478. data/docs/AccountsGetResponse.md +0 -22
  479. data/docs/Address.md +0 -20
  480. data/docs/AddressData.md +0 -26
  481. data/docs/Amount.md +0 -20
  482. data/docs/AssetReport.md +0 -28
  483. data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
  484. data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
  485. data/docs/AssetReportAuditCopyGetRequest.md +0 -22
  486. data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
  487. data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
  488. data/docs/AssetReportCreateRequest.md +0 -26
  489. data/docs/AssetReportCreateRequestOptions.md +0 -22
  490. data/docs/AssetReportCreateResponse.md +0 -22
  491. data/docs/AssetReportFilterRequest.md +0 -24
  492. data/docs/AssetReportFilterResponse.md +0 -22
  493. data/docs/AssetReportGetRequest.md +0 -24
  494. data/docs/AssetReportGetResponse.md +0 -22
  495. data/docs/AssetReportItem.md +0 -26
  496. data/docs/AssetReportPDFGetRequest.md +0 -22
  497. data/docs/AssetReportRefreshRequest.md +0 -26
  498. data/docs/AssetReportRefreshRequestOptions.md +0 -22
  499. data/docs/AssetReportRefreshResponse.md +0 -22
  500. data/docs/AssetReportRemoveRequest.md +0 -22
  501. data/docs/AssetReportRemoveResponse.md +0 -20
  502. data/docs/AssetReportTransaction.md +0 -62
  503. data/docs/AssetReportTransactionAllOf.md +0 -20
  504. data/docs/AssetReportUser.md +0 -30
  505. data/docs/AssetsErrorWebhook.md +0 -24
  506. data/docs/AssetsProductReadyWebhook.md +0 -22
  507. data/docs/AuthGetNumbers.md +0 -24
  508. data/docs/AuthGetRequest.md +0 -24
  509. data/docs/AuthGetRequestOptions.md +0 -18
  510. data/docs/AuthGetResponse.md +0 -24
  511. data/docs/AutomaticallyVerifiedWebhook.md +0 -24
  512. data/docs/BankTransfer.md +0 -50
  513. data/docs/BankTransferBalance.md +0 -20
  514. data/docs/BankTransferBalanceGetRequest.md +0 -22
  515. data/docs/BankTransferBalanceGetResponse.md +0 -22
  516. data/docs/BankTransferCancelRequest.md +0 -22
  517. data/docs/BankTransferCancelResponse.md +0 -18
  518. data/docs/BankTransferCreateRequest.md +0 -46
  519. data/docs/BankTransferCreateResponse.md +0 -20
  520. data/docs/BankTransferDirection.md +0 -15
  521. data/docs/BankTransferEvent.md +0 -40
  522. data/docs/BankTransferEventListRequest.md +0 -40
  523. data/docs/BankTransferEventListResponse.md +0 -20
  524. data/docs/BankTransferEventSyncRequest.md +0 -24
  525. data/docs/BankTransferEventSyncResponse.md +0 -20
  526. data/docs/BankTransferEventType.md +0 -15
  527. data/docs/BankTransferFailure.md +0 -20
  528. data/docs/BankTransferGetRequest.md +0 -22
  529. data/docs/BankTransferGetResponse.md +0 -20
  530. data/docs/BankTransferListRequest.md +0 -32
  531. data/docs/BankTransferListResponse.md +0 -20
  532. data/docs/BankTransferMigrateAccountRequest.md +0 -26
  533. data/docs/BankTransferMigrateAccountResponse.md +0 -22
  534. data/docs/BankTransferNetwork.md +0 -15
  535. data/docs/BankTransferReceiverDetails.md +0 -18
  536. data/docs/BankTransferStatus.md +0 -15
  537. data/docs/BankTransferType.md +0 -15
  538. data/docs/BankTransferUser.md +0 -22
  539. data/docs/BankTransfersEventsUpdateWebhook.md +0 -20
  540. data/docs/CategoriesGetResponse.md +0 -20
  541. data/docs/Category.md +0 -22
  542. data/docs/Cause.md +0 -20
  543. data/docs/CountryCode.md +0 -15
  544. data/docs/CreditCardLiability.md +0 -34
  545. data/docs/CreditFilter.md +0 -18
  546. data/docs/DefaultUpdateWebhook.md +0 -26
  547. data/docs/DepositSwitchAddressData.md +0 -26
  548. data/docs/DepositSwitchAltCreateRequest.md +0 -24
  549. data/docs/DepositSwitchAltCreateResponse.md +0 -20
  550. data/docs/DepositSwitchCreateRequest.md +0 -24
  551. data/docs/DepositSwitchCreateResponse.md +0 -20
  552. data/docs/DepositSwitchGetRequest.md +0 -22
  553. data/docs/DepositSwitchGetResponse.md +0 -38
  554. data/docs/DepositSwitchTargetAccount.md +0 -24
  555. data/docs/DepositSwitchTargetUser.md +0 -28
  556. data/docs/DepositSwitchTokenCreateRequest.md +0 -22
  557. data/docs/DepositSwitchTokenCreateResponse.md +0 -22
  558. data/docs/DepositoryFilter.md +0 -18
  559. data/docs/Email.md +0 -22
  560. data/docs/Employee.md +0 -22
  561. data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
  562. data/docs/Employer.md +0 -24
  563. data/docs/EmployerIncomeSummaryFieldString.md +0 -20
  564. data/docs/EmployersSearchRequest.md +0 -24
  565. data/docs/EmployersSearchResponse.md +0 -20
  566. data/docs/Error.md +0 -34
  567. data/docs/ExternalPaymentSchedule.md +0 -24
  568. data/docs/ExternalPaymentScheduleGet.md +0 -26
  569. data/docs/HealthIncident.md +0 -24
  570. data/docs/HistoricalBalance.md +0 -24
  571. data/docs/HistoricalUpdateWebhook.md +0 -26
  572. data/docs/Holding.md +0 -34
  573. data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
  574. data/docs/IdentityGetRequest.md +0 -24
  575. data/docs/IdentityGetRequestOptions.md +0 -18
  576. data/docs/IdentityGetResponse.md +0 -22
  577. data/docs/IncidentUpdate.md +0 -22
  578. data/docs/IncomeBreakdown.md +0 -24
  579. data/docs/IncomeSummary.md +0 -30
  580. data/docs/IncomeSummaryFieldNumber.md +0 -20
  581. data/docs/IncomeSummaryFieldString.md +0 -20
  582. data/docs/IncomeVerificationCreateRequest.md +0 -22
  583. data/docs/IncomeVerificationCreateResponse.md +0 -20
  584. data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
  585. data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
  586. data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
  587. data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
  588. data/docs/IncomeVerificationStatusWebhook.md +0 -24
  589. data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
  590. data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
  591. data/docs/IncomeVerificationWebhookStatus.md +0 -18
  592. data/docs/InflowModel.md +0 -26
  593. data/docs/InitialUpdateWebhook.md +0 -26
  594. data/docs/Institution.md +0 -36
  595. data/docs/InstitutionStatus.md +0 -30
  596. data/docs/InstitutionsGetByIdRequest.md +0 -26
  597. data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
  598. data/docs/InstitutionsGetByIdResponse.md +0 -20
  599. data/docs/InstitutionsGetRequest.md +0 -28
  600. data/docs/InstitutionsGetRequestOptions.md +0 -24
  601. data/docs/InstitutionsGetResponse.md +0 -22
  602. data/docs/InstitutionsSearchAccountFilter.md +0 -24
  603. data/docs/InstitutionsSearchRequest.md +0 -28
  604. data/docs/InstitutionsSearchRequestOptions.md +0 -20
  605. data/docs/InstitutionsSearchResponse.md +0 -20
  606. data/docs/InvestmentFilter.md +0 -18
  607. data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
  608. data/docs/InvestmentTransaction.md +0 -44
  609. data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
  610. data/docs/InvestmentsHoldingsGetRequest.md +0 -24
  611. data/docs/InvestmentsHoldingsGetResponse.md +0 -26
  612. data/docs/InvestmentsTransactionsGetRequest.md +0 -28
  613. data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
  614. data/docs/InvestmentsTransactionsGetResponse.md +0 -28
  615. data/docs/Item.md +0 -32
  616. data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
  617. data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
  618. data/docs/ItemErrorWebhook.md +0 -24
  619. data/docs/ItemGetRequest.md +0 -22
  620. data/docs/ItemGetResponse.md +0 -24
  621. data/docs/ItemImportRequest.md +0 -26
  622. data/docs/ItemImportRequestOptions.md +0 -18
  623. data/docs/ItemImportRequestUserAuth.md +0 -20
  624. data/docs/ItemImportResponse.md +0 -20
  625. data/docs/ItemProductReadyWebhook.md +0 -24
  626. data/docs/ItemPublicTokenCreateRequest.md +0 -22
  627. data/docs/ItemPublicTokenCreateResponse.md +0 -22
  628. data/docs/ItemPublicTokenExchangeRequest.md +0 -22
  629. data/docs/ItemPublicTokenExchangeResponse.md +0 -22
  630. data/docs/ItemRemoveRequest.md +0 -22
  631. data/docs/ItemRemoveResponse.md +0 -18
  632. data/docs/ItemStatus.md +0 -22
  633. data/docs/ItemWebhookUpdateRequest.md +0 -24
  634. data/docs/ItemWebhookUpdateResponse.md +0 -20
  635. data/docs/JWKPublicKey.md +0 -34
  636. data/docs/JWTHeader.md +0 -18
  637. data/docs/LiabilitiesGetRequest.md +0 -24
  638. data/docs/LiabilitiesGetRequestOptions.md +0 -18
  639. data/docs/LiabilitiesGetResponse.md +0 -24
  640. data/docs/LiabilitiesObject.md +0 -22
  641. data/docs/LiabilityOverride.md +0 -66
  642. data/docs/LinkTokenAccountFilters.md +0 -24
  643. data/docs/LinkTokenCreateRequest.md +0 -52
  644. data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
  645. data/docs/LinkTokenCreateRequestAuth.md +0 -18
  646. data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
  647. data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
  648. data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
  649. data/docs/LinkTokenCreateRequestUser.md +0 -32
  650. data/docs/LinkTokenCreateResponse.md +0 -22
  651. data/docs/LinkTokenGetMetadataResponse.md +0 -30
  652. data/docs/LinkTokenGetRequest.md +0 -22
  653. data/docs/LinkTokenGetResponse.md +0 -26
  654. data/docs/LoanFilter.md +0 -18
  655. data/docs/Location.md +0 -32
  656. data/docs/MFA.md +0 -26
  657. data/docs/Meta.md +0 -22
  658. data/docs/MortgageInterestRate.md +0 -20
  659. data/docs/MortgageLiability.md +0 -56
  660. data/docs/MortgagePropertyAddress.md +0 -26
  661. data/docs/NullableAccessToken.md +0 -15
  662. data/docs/NullableAddress.md +0 -20
  663. data/docs/NullableAddressData.md +0 -26
  664. data/docs/NullableItemStatus.md +0 -22
  665. data/docs/NullableNumbersACH.md +0 -24
  666. data/docs/NullableNumbersBACS.md +0 -22
  667. data/docs/NullableNumbersEFT.md +0 -24
  668. data/docs/NullableNumbersInternational.md +0 -22
  669. data/docs/NullableRecipientBACS.md +0 -20
  670. data/docs/Numbers.md +0 -32
  671. data/docs/NumbersACH.md +0 -24
  672. data/docs/NumbersBACS.md +0 -22
  673. data/docs/NumbersEFT.md +0 -24
  674. data/docs/NumbersInternational.md +0 -22
  675. data/docs/OverrideAccounts.md +0 -38
  676. data/docs/Owner.md +0 -24
  677. data/docs/OwnerOverride.md +0 -24
  678. data/docs/PSLFStatus.md +0 -22
  679. data/docs/PayFrequency.md +0 -20
  680. data/docs/PayPeriodDetails.md +0 -26
  681. data/docs/PaymentAmount.md +0 -20
  682. data/docs/PaymentInitiationAddress.md +0 -24
  683. data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
  684. data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
  685. data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
  686. data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
  687. data/docs/PaymentInitiationPaymentListRequest.md +0 -24
  688. data/docs/PaymentInitiationPaymentListResponse.md +0 -22
  689. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
  690. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
  691. data/docs/PaymentInitiationRecipient.md +0 -26
  692. data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
  693. data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
  694. data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
  695. data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
  696. data/docs/PaymentInitiationRecipientListRequest.md +0 -20
  697. data/docs/PaymentInitiationRecipientListResponse.md +0 -20
  698. data/docs/PaymentMeta.md +0 -32
  699. data/docs/PaymentStatusUpdateWebhook.md +0 -38
  700. data/docs/Paystub.md +0 -30
  701. data/docs/PaystubDeduction.md +0 -22
  702. data/docs/PaystubYTDDetails.md +0 -20
  703. data/docs/PendingExpirationWebhook.md +0 -24
  704. data/docs/PhoneNumber.md +0 -22
  705. data/docs/PlaidApi.md +0 -5660
  706. data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
  707. data/docs/ProcessorAuthGetRequest.md +0 -22
  708. data/docs/ProcessorAuthGetResponse.md +0 -22
  709. data/docs/ProcessorBalanceGetRequest.md +0 -22
  710. data/docs/ProcessorBalanceGetResponse.md +0 -20
  711. data/docs/ProcessorIdentityGetRequest.md +0 -22
  712. data/docs/ProcessorIdentityGetResponse.md +0 -20
  713. data/docs/ProcessorNumber.md +0 -24
  714. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
  715. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
  716. data/docs/ProcessorTokenCreateRequest.md +0 -26
  717. data/docs/ProcessorTokenCreateResponse.md +0 -20
  718. data/docs/ProductStatus.md +0 -22
  719. data/docs/ProductStatusBreakdown.md +0 -24
  720. data/docs/Products.md +0 -15
  721. data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
  722. data/docs/RecaptchaRequiredError.md +0 -30
  723. data/docs/RecipientBACS.md +0 -20
  724. data/docs/SandboxBankTransferFireWebhookRequest.md +0 -22
  725. data/docs/SandboxBankTransferFireWebhookResponse.md +0 -18
  726. data/docs/SandboxBankTransferSimulateRequest.md +0 -26
  727. data/docs/SandboxBankTransferSimulateResponse.md +0 -18
  728. data/docs/SandboxItemFireWebhookRequest.md +0 -24
  729. data/docs/SandboxItemFireWebhookResponse.md +0 -20
  730. data/docs/SandboxItemResetLoginRequest.md +0 -22
  731. data/docs/SandboxItemResetLoginResponse.md +0 -20
  732. data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
  733. data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
  734. data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
  735. data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
  736. data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
  737. data/docs/SandboxPublicTokenCreateRequest.md +0 -26
  738. data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
  739. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
  740. data/docs/SandboxPublicTokenCreateResponse.md +0 -20
  741. data/docs/Security.md +0 -46
  742. data/docs/ServicerAddressData.md +0 -26
  743. data/docs/StandaloneAccountType.md +0 -26
  744. data/docs/StandaloneCurrencyCodeList.md +0 -20
  745. data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
  746. data/docs/StandaloneInvestmentTransactionType.md +0 -28
  747. data/docs/StudentLoan.md +0 -66
  748. data/docs/StudentLoanRepaymentModel.md +0 -22
  749. data/docs/StudentLoanStatus.md +0 -20
  750. data/docs/StudentRepaymentPlan.md +0 -20
  751. data/docs/Transaction.md +0 -58
  752. data/docs/TransactionCode.md +0 -15
  753. data/docs/TransactionData.md +0 -26
  754. data/docs/TransactionOverride.md +0 -26
  755. data/docs/TransactionsGetRequest.md +0 -28
  756. data/docs/TransactionsGetRequestOptions.md +0 -22
  757. data/docs/TransactionsGetResponse.md +0 -26
  758. data/docs/TransactionsRefreshRequest.md +0 -22
  759. data/docs/TransactionsRefreshResponse.md +0 -18
  760. data/docs/TransactionsRemovedWebhook.md +0 -26
  761. data/docs/UserCustomPassword.md +0 -28
  762. data/docs/UserPermissionRevokedWebhook.md +0 -24
  763. data/docs/VerificationExpiredWebhook.md +0 -24
  764. data/docs/VerificationStatus.md +0 -15
  765. data/docs/Warning.md +0 -22
  766. data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
  767. data/docs/WebhookVerificationKeyGetRequest.md +0 -22
  768. data/docs/WebhookVerificationKeyGetResponse.md +0 -20
  769. data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
  770. data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
  771. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
  772. data/pkg/plaid-14.0.0.beta.4.gem +0 -0
@@ -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`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [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`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [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
-
@@ -1,22 +0,0 @@
1
- # Plaid::TransactionsGetRequestOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **account_ids** | **Array<String>** | A list of `account_ids` to retrieve for the Item Note: An error will be returned if a provided `account_id` is not associated with the Item. | [optional] |
8
- | **count** | **Integer** | The number of transactions to fetch. | [optional][default to 100] |
9
- | **offset** | **Integer** | The number of transactions to skip. The default value is 0. | [optional][default to 0] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::TransactionsGetRequestOptions.new(
17
- account_ids: null,
18
- count: null,
19
- offset: null
20
- )
21
- ```
22
-
@@ -1,26 +0,0 @@
1
- # Plaid::TransactionsGetResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **accounts** | [**Array<AccountBase>**](AccountBase.md) | An array containing the `accounts` associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the `account_id` field. | |
8
- | **transactions** | [**Array<Transaction>**](Transaction.md) | An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the `count` parameter. | |
9
- | **total_transactions** | **Integer** | The total number of transactions available within the date range specified. If `total_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter. | |
10
- | **item** | [**Item**](Item.md) | | |
11
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::TransactionsGetResponse.new(
19
- accounts: null,
20
- transactions: null,
21
- total_transactions: null,
22
- item: null,
23
- request_id: null
24
- )
25
- ```
26
-
@@ -1,22 +0,0 @@
1
- # Plaid::TransactionsRefreshRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
8
- | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
9
- | **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::TransactionsRefreshRequest.new(
17
- client_id: null,
18
- access_token: null,
19
- secret: null
20
- )
21
- ```
22
-
@@ -1,18 +0,0 @@
1
- # Plaid::TransactionsRefreshResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'plaid'
13
-
14
- instance = Plaid::TransactionsRefreshResponse.new(
15
- request_id: null
16
- )
17
- ```
18
-
@@ -1,26 +0,0 @@
1
- # Plaid::TransactionsRemovedWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `TRANSACTIONS` | |
8
- | **webhook_code** | **String** | `TRANSACTIONS_REMOVED` | |
9
- | **error** | [**Error**](Error.md) | | [optional] |
10
- | **removed_transactions** | **Array<String>** | An array of `transaction_ids` corresponding to the removed transactions | |
11
- | **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::TransactionsRemovedWebhook.new(
19
- webhook_type: null,
20
- webhook_code: null,
21
- error: null,
22
- removed_transactions: null,
23
- item_id: null
24
- )
25
- ```
26
-
@@ -1,28 +0,0 @@
1
- # Plaid::UserCustomPassword
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **version** | **String** | The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite. | [optional] |
8
- | **seed** | **String** | A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument. If no seed is specified, the randomly generated data will be different each time. Note that transactions data is generated relative to the Item's creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19. | |
9
- | **override_accounts** | [**Array<OverrideAccounts>**](OverrideAccounts.md) | An array of account overrides to configure the accounts for the Item. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data. | |
10
- | **mfa** | [**MFA**](MFA.md) | | |
11
- | **recaptcha** | **String** | You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field. Possible values are `good` or `bad`. A value of `good` will result in successful Item creation and `bad` will result in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link. | |
12
- | **force_error** | **String** | An error code to force on Item creation. Possible values are: `\"INSTITUTION_NOT_RESPONDING\"` `\"INSTITUTION_NO_LONGER_SUPPORTED\"` `\"INVALID_CREDENTIALS\"` `\"INVALID_MFA\"` `\"ITEM_LOCKED\"` `\"ITEM_LOGIN_REQUIRED\"` `\"ITEM_NOT_SUPPORTED\"` `\"INVALID_LINK_TOKEN\"` `\"MFA_NOT_SUPPORTED\"` `\"NO_ACCOUNTS\"` `\"PLAID_ERROR\"` `\"PRODUCTS_NOT_SUPPORTED\"` `\"USER_SETUP_REQUIRED\"` | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'plaid'
18
-
19
- instance = Plaid::UserCustomPassword.new(
20
- version: null,
21
- seed: null,
22
- override_accounts: null,
23
- mfa: null,
24
- recaptcha: null,
25
- force_error: null
26
- )
27
- ```
28
-
@@ -1,24 +0,0 @@
1
- # Plaid::UserPermissionRevokedWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `ITEM` | |
8
- | **webhook_code** | **String** | `USER_PERMISSION_REVOKED` | |
9
- | **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
10
- | **error** | [**Error**](Error.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::UserPermissionRevokedWebhook.new(
18
- webhook_type: null,
19
- webhook_code: null,
20
- item_id: null,
21
- error: null
22
- )
23
- ```
24
-
@@ -1,24 +0,0 @@
1
- # Plaid::VerificationExpiredWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `AUTH` | |
8
- | **webhook_code** | **String** | `VERIFICATION_EXPIRED` | |
9
- | **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
10
- | **account_id** | **String** | The `account_id` of the account associated with the webhook | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'plaid'
16
-
17
- instance = Plaid::VerificationExpiredWebhook.new(
18
- webhook_type: null,
19
- webhook_code: null,
20
- item_id: null,
21
- account_id: null
22
- )
23
- ```
24
-
@@ -1,15 +0,0 @@
1
- # Plaid::VerificationStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'plaid'
12
-
13
- instance = Plaid::VerificationStatus.new()
14
- ```
15
-
data/docs/Warning.md DELETED
@@ -1,22 +0,0 @@
1
- # Plaid::Warning
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **warning_type** | **String** | The warning type, which will always be `ASSET_REPORT_WARNING` | |
8
- | **warning_code** | **String** | The warning code identifies a specific kind of warning. Currently, the only possible warning code is `OWNERS_UNAVAILABLE`, which indicates that account-owner information is not available. | |
9
- | **cause** | [**Cause**](Cause.md) | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::Warning.new(
17
- warning_type: null,
18
- warning_code: null,
19
- cause: null
20
- )
21
- ```
22
-
@@ -1,26 +0,0 @@
1
- # Plaid::WebhookUpdateAcknowledgedWebhook
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **webhook_type** | **String** | `ITEM` | |
8
- | **webhook_code** | **String** | `WEBHOOK_UPDATE_ACKNOWLEDGED` | |
9
- | **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
10
- | **new_webhook_url** | **String** | The new webhook URL | |
11
- | **error** | [**Error**](Error.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'plaid'
17
-
18
- instance = Plaid::WebhookUpdateAcknowledgedWebhook.new(
19
- webhook_type: null,
20
- webhook_code: null,
21
- item_id: null,
22
- new_webhook_url: null,
23
- error: null
24
- )
25
- ```
26
-
@@ -1,22 +0,0 @@
1
- # Plaid::WebhookVerificationKeyGetRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
9
- | **key_id** | **String** | The key ID ( `kid` ) from the JWT header. | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'plaid'
15
-
16
- instance = Plaid::WebhookVerificationKeyGetRequest.new(
17
- client_id: null,
18
- secret: null,
19
- key_id: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Plaid::WebhookVerificationKeyGetResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **key** | [**JWKPublicKey**](JWKPublicKey.md) | | |
8
- | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::WebhookVerificationKeyGetResponse.new(
16
- key: null,
17
- request_id: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # Plaid::YTDGrossIncomeSummaryFieldNumber
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **value** | **Float** | The value of the field. | |
8
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::YTDGrossIncomeSummaryFieldNumber.new(
16
- value: null,
17
- verification_status: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # Plaid::YTDNetIncomeSummaryFieldNumber
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **value** | **Float** | The value of the field. | |
8
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'plaid'
14
-
15
- instance = Plaid::YTDNetIncomeSummaryFieldNumber.new(
16
- value: null,
17
- verification_status: null
18
- )
19
- ```
20
-
@@ -1,650 +0,0 @@
1
- =begin
2
- #The Plaid API
3
-
4
- #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
-
6
- The version of the OpenAPI document: 2020-09-14_1.11.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.1.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module Plaid
17
- # Valid subtypes for Investment transaction subtypes. Note that transactions representing inflow of cash will appear as negative amounts, outflow of cash will appear as positive amounts.
18
- class StandaloneInvestmentTransactionSubtype
19
- # Fees paid for account maintenance
20
- attr_accessor :account_fee
21
-
22
- # Assignment of short option holding
23
- attr_accessor :assignment
24
-
25
- # Purchase to open or increase a position
26
- attr_accessor :buy
27
-
28
- # Purchase to close a short position
29
- attr_accessor :buy_to_cover
30
-
31
- # Inflow of assets into a tax-advantaged account
32
- attr_accessor :contribution
33
-
34
- # Inflow of cash into an account
35
- attr_accessor :deposit
36
-
37
- # Outflow of assets from a tax-advantaged account
38
- attr_accessor :distribution
39
-
40
- # Inflow of cash from a dividend
41
- attr_accessor :dividend
42
-
43
- # Purchase using proceeds from a cash dividend
44
- attr_accessor :dividend_reinvestment
45
-
46
- # Exercise of an option or warrant contract
47
- attr_accessor :exercise
48
-
49
- # Expiration of an option or warrant contract
50
- attr_accessor :expire
51
-
52
- # Fees paid for administration of a mutual fund or other pooled investment vehicle
53
- attr_accessor :fund_fee
54
-
55
- # Inflow of cash from interest
56
- attr_accessor :interest
57
-
58
- # Inflow of cash from interest receivable
59
- attr_accessor :interest_receivable
60
-
61
- # Purchase using proceeds from a cash interest payment
62
- attr_accessor :interest_reinvestment
63
-
64
- # Fees paid for legal charges or services
65
- attr_accessor :legal_fee
66
-
67
- # Inflow of cash related to payment on a loan
68
- attr_accessor :loan_payment
69
-
70
- # Long-term capital gain received as cash
71
- attr_accessor :long_term_capital_gain
72
-
73
- # Purchase using long-term capital gain cash proceeds
74
- attr_accessor :long_term_capital_gain_reinvestment
75
-
76
- # Fees paid for investment management of a mutual fund or other pooled investment vehicle
77
- attr_accessor :management_fee
78
-
79
- # Fees paid for maintaining margin debt
80
- attr_accessor :margin_expense
81
-
82
- # Stock exchanged at a pre-defined ratio as part of a merger between companies
83
- attr_accessor :merger
84
-
85
- # Fee associated with various account or holding actions
86
- attr_accessor :miscellaneous_fee
87
-
88
- # Inflow of cash from a non-qualified dividend
89
- attr_accessor :non_qualified_dividend
90
-
91
- # Taxes paid on behalf of the investor for non-residency in investment jurisdiction
92
- attr_accessor :non_resident_tax
93
-
94
- # Pending inflow of cash
95
- attr_accessor :pending_credit
96
-
97
- # Pending outflow of cash
98
- attr_accessor :pending_debit
99
-
100
- # Inflow of cash from a qualified dividend
101
- attr_accessor :qualified_dividend
102
-
103
- # Rebalancing transaction (buy or sell) with no net impact to value in the account
104
- attr_accessor :rebalance
105
-
106
- # Repayment of loan principal
107
- attr_accessor :return_of_principal
108
-
109
- # Sell to close or decrease an existing holding
110
- attr_accessor :sell
111
-
112
- # Sell to open a short position
113
- attr_accessor :sell_short
114
-
115
- # Short-term capital gain received as cash
116
- attr_accessor :short_term_capital_gain
117
-
118
- # Purchase using short-term capital gain cash proceeds
119
- attr_accessor :short_term_capital_gain_reinvestment
120
-
121
- # Inflow of stock from spin-off transaction of an existing holding
122
- attr_accessor :spin_off
123
-
124
- # Inflow of stock from a forward split of an existing holding
125
- attr_accessor :split
126
-
127
- # Inflow of stock from a distribution
128
- attr_accessor :stock_distribution
129
-
130
- # Taxes paid on behalf of the investor
131
- attr_accessor :tax
132
-
133
- # Taxes withheld on behalf of the customer
134
- attr_accessor :tax_withheld
135
-
136
- # Movement of assets into or out of an account
137
- attr_accessor :transfer
138
-
139
- # Fees incurred for transfer of a holding or account
140
- attr_accessor :transfer_fee
141
-
142
- # Fees related to adminstration of a trust account
143
- attr_accessor :trust_fee
144
-
145
- # Unqualified capital gain received as cash
146
- attr_accessor :unqualified_gain
147
-
148
- # Outflow of cash from an account
149
- attr_accessor :withdrawal
150
-
151
- # Attribute mapping from ruby-style variable name to JSON key.
152
- def self.attribute_map
153
- {
154
- :'account_fee' => :'account fee',
155
- :'assignment' => :'assignment',
156
- :'buy' => :'buy',
157
- :'buy_to_cover' => :'buy to cover',
158
- :'contribution' => :'contribution',
159
- :'deposit' => :'deposit',
160
- :'distribution' => :'distribution',
161
- :'dividend' => :'dividend',
162
- :'dividend_reinvestment' => :'dividend reinvestment',
163
- :'exercise' => :'exercise',
164
- :'expire' => :'expire',
165
- :'fund_fee' => :'fund fee',
166
- :'interest' => :'interest',
167
- :'interest_receivable' => :'interest receivable',
168
- :'interest_reinvestment' => :'interest reinvestment',
169
- :'legal_fee' => :'legal fee',
170
- :'loan_payment' => :'loan payment',
171
- :'long_term_capital_gain' => :'long-term capital gain',
172
- :'long_term_capital_gain_reinvestment' => :'long-term capital gain reinvestment',
173
- :'management_fee' => :'management fee',
174
- :'margin_expense' => :'margin expense',
175
- :'merger' => :'merger',
176
- :'miscellaneous_fee' => :'miscellaneous fee',
177
- :'non_qualified_dividend' => :'non-qualified dividend',
178
- :'non_resident_tax' => :'non-resident tax',
179
- :'pending_credit' => :'pending credit',
180
- :'pending_debit' => :'pending debit',
181
- :'qualified_dividend' => :'qualified dividend',
182
- :'rebalance' => :'rebalance',
183
- :'return_of_principal' => :'return of principal',
184
- :'sell' => :'sell',
185
- :'sell_short' => :'sell short',
186
- :'short_term_capital_gain' => :'short-term capital gain',
187
- :'short_term_capital_gain_reinvestment' => :'short-term capital gain reinvestment',
188
- :'spin_off' => :'spin off',
189
- :'split' => :'split',
190
- :'stock_distribution' => :'stock distribution',
191
- :'tax' => :'tax',
192
- :'tax_withheld' => :'tax withheld',
193
- :'transfer' => :'transfer',
194
- :'transfer_fee' => :'transfer fee',
195
- :'trust_fee' => :'trust fee',
196
- :'unqualified_gain' => :'unqualified gain',
197
- :'withdrawal' => :'withdrawal'
198
- }
199
- end
200
-
201
- # Returns all the JSON keys this model knows about
202
- def self.acceptable_attributes
203
- attribute_map.values
204
- end
205
-
206
- # Attribute type mapping.
207
- def self.openapi_types
208
- {
209
- :'account_fee' => :'String',
210
- :'assignment' => :'String',
211
- :'buy' => :'String',
212
- :'buy_to_cover' => :'String',
213
- :'contribution' => :'String',
214
- :'deposit' => :'String',
215
- :'distribution' => :'String',
216
- :'dividend' => :'String',
217
- :'dividend_reinvestment' => :'String',
218
- :'exercise' => :'String',
219
- :'expire' => :'String',
220
- :'fund_fee' => :'String',
221
- :'interest' => :'String',
222
- :'interest_receivable' => :'String',
223
- :'interest_reinvestment' => :'String',
224
- :'legal_fee' => :'String',
225
- :'loan_payment' => :'String',
226
- :'long_term_capital_gain' => :'String',
227
- :'long_term_capital_gain_reinvestment' => :'String',
228
- :'management_fee' => :'String',
229
- :'margin_expense' => :'String',
230
- :'merger' => :'String',
231
- :'miscellaneous_fee' => :'String',
232
- :'non_qualified_dividend' => :'String',
233
- :'non_resident_tax' => :'String',
234
- :'pending_credit' => :'String',
235
- :'pending_debit' => :'String',
236
- :'qualified_dividend' => :'String',
237
- :'rebalance' => :'String',
238
- :'return_of_principal' => :'String',
239
- :'sell' => :'String',
240
- :'sell_short' => :'String',
241
- :'short_term_capital_gain' => :'String',
242
- :'short_term_capital_gain_reinvestment' => :'String',
243
- :'spin_off' => :'String',
244
- :'split' => :'String',
245
- :'stock_distribution' => :'String',
246
- :'tax' => :'String',
247
- :'tax_withheld' => :'String',
248
- :'transfer' => :'String',
249
- :'transfer_fee' => :'String',
250
- :'trust_fee' => :'String',
251
- :'unqualified_gain' => :'String',
252
- :'withdrawal' => :'String'
253
- }
254
- end
255
-
256
- # List of attributes with nullable: true
257
- def self.openapi_nullable
258
- Set.new([
259
- ])
260
- end
261
-
262
- # Initializes the object
263
- # @param [Hash] attributes Model attributes in the form of hash
264
- def initialize(attributes = {})
265
- if (!attributes.is_a?(Hash))
266
- fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::StandaloneInvestmentTransactionSubtype` initialize method"
267
- end
268
-
269
- # check to see if the attribute exists and convert string to symbol for hash key
270
- attributes = attributes.each_with_object({}) { |(k, v), h|
271
- if (!self.class.attribute_map.key?(k.to_sym))
272
- fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::StandaloneInvestmentTransactionSubtype`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
273
- end
274
- h[k.to_sym] = v
275
- }
276
-
277
- if attributes.key?(:'account_fee')
278
- self.account_fee = attributes[:'account_fee']
279
- end
280
-
281
- if attributes.key?(:'assignment')
282
- self.assignment = attributes[:'assignment']
283
- end
284
-
285
- if attributes.key?(:'buy')
286
- self.buy = attributes[:'buy']
287
- end
288
-
289
- if attributes.key?(:'buy_to_cover')
290
- self.buy_to_cover = attributes[:'buy_to_cover']
291
- end
292
-
293
- if attributes.key?(:'contribution')
294
- self.contribution = attributes[:'contribution']
295
- end
296
-
297
- if attributes.key?(:'deposit')
298
- self.deposit = attributes[:'deposit']
299
- end
300
-
301
- if attributes.key?(:'distribution')
302
- self.distribution = attributes[:'distribution']
303
- end
304
-
305
- if attributes.key?(:'dividend')
306
- self.dividend = attributes[:'dividend']
307
- end
308
-
309
- if attributes.key?(:'dividend_reinvestment')
310
- self.dividend_reinvestment = attributes[:'dividend_reinvestment']
311
- end
312
-
313
- if attributes.key?(:'exercise')
314
- self.exercise = attributes[:'exercise']
315
- end
316
-
317
- if attributes.key?(:'expire')
318
- self.expire = attributes[:'expire']
319
- end
320
-
321
- if attributes.key?(:'fund_fee')
322
- self.fund_fee = attributes[:'fund_fee']
323
- end
324
-
325
- if attributes.key?(:'interest')
326
- self.interest = attributes[:'interest']
327
- end
328
-
329
- if attributes.key?(:'interest_receivable')
330
- self.interest_receivable = attributes[:'interest_receivable']
331
- end
332
-
333
- if attributes.key?(:'interest_reinvestment')
334
- self.interest_reinvestment = attributes[:'interest_reinvestment']
335
- end
336
-
337
- if attributes.key?(:'legal_fee')
338
- self.legal_fee = attributes[:'legal_fee']
339
- end
340
-
341
- if attributes.key?(:'loan_payment')
342
- self.loan_payment = attributes[:'loan_payment']
343
- end
344
-
345
- if attributes.key?(:'long_term_capital_gain')
346
- self.long_term_capital_gain = attributes[:'long_term_capital_gain']
347
- end
348
-
349
- if attributes.key?(:'long_term_capital_gain_reinvestment')
350
- self.long_term_capital_gain_reinvestment = attributes[:'long_term_capital_gain_reinvestment']
351
- end
352
-
353
- if attributes.key?(:'management_fee')
354
- self.management_fee = attributes[:'management_fee']
355
- end
356
-
357
- if attributes.key?(:'margin_expense')
358
- self.margin_expense = attributes[:'margin_expense']
359
- end
360
-
361
- if attributes.key?(:'merger')
362
- self.merger = attributes[:'merger']
363
- end
364
-
365
- if attributes.key?(:'miscellaneous_fee')
366
- self.miscellaneous_fee = attributes[:'miscellaneous_fee']
367
- end
368
-
369
- if attributes.key?(:'non_qualified_dividend')
370
- self.non_qualified_dividend = attributes[:'non_qualified_dividend']
371
- end
372
-
373
- if attributes.key?(:'non_resident_tax')
374
- self.non_resident_tax = attributes[:'non_resident_tax']
375
- end
376
-
377
- if attributes.key?(:'pending_credit')
378
- self.pending_credit = attributes[:'pending_credit']
379
- end
380
-
381
- if attributes.key?(:'pending_debit')
382
- self.pending_debit = attributes[:'pending_debit']
383
- end
384
-
385
- if attributes.key?(:'qualified_dividend')
386
- self.qualified_dividend = attributes[:'qualified_dividend']
387
- end
388
-
389
- if attributes.key?(:'rebalance')
390
- self.rebalance = attributes[:'rebalance']
391
- end
392
-
393
- if attributes.key?(:'return_of_principal')
394
- self.return_of_principal = attributes[:'return_of_principal']
395
- end
396
-
397
- if attributes.key?(:'sell')
398
- self.sell = attributes[:'sell']
399
- end
400
-
401
- if attributes.key?(:'sell_short')
402
- self.sell_short = attributes[:'sell_short']
403
- end
404
-
405
- if attributes.key?(:'short_term_capital_gain')
406
- self.short_term_capital_gain = attributes[:'short_term_capital_gain']
407
- end
408
-
409
- if attributes.key?(:'short_term_capital_gain_reinvestment')
410
- self.short_term_capital_gain_reinvestment = attributes[:'short_term_capital_gain_reinvestment']
411
- end
412
-
413
- if attributes.key?(:'spin_off')
414
- self.spin_off = attributes[:'spin_off']
415
- end
416
-
417
- if attributes.key?(:'split')
418
- self.split = attributes[:'split']
419
- end
420
-
421
- if attributes.key?(:'stock_distribution')
422
- self.stock_distribution = attributes[:'stock_distribution']
423
- end
424
-
425
- if attributes.key?(:'tax')
426
- self.tax = attributes[:'tax']
427
- end
428
-
429
- if attributes.key?(:'tax_withheld')
430
- self.tax_withheld = attributes[:'tax_withheld']
431
- end
432
-
433
- if attributes.key?(:'transfer')
434
- self.transfer = attributes[:'transfer']
435
- end
436
-
437
- if attributes.key?(:'transfer_fee')
438
- self.transfer_fee = attributes[:'transfer_fee']
439
- end
440
-
441
- if attributes.key?(:'trust_fee')
442
- self.trust_fee = attributes[:'trust_fee']
443
- end
444
-
445
- if attributes.key?(:'unqualified_gain')
446
- self.unqualified_gain = attributes[:'unqualified_gain']
447
- end
448
-
449
- if attributes.key?(:'withdrawal')
450
- self.withdrawal = attributes[:'withdrawal']
451
- end
452
- end
453
-
454
- # Show invalid properties with the reasons. Usually used together with valid?
455
- # @return Array for valid properties with the reasons
456
- def list_invalid_properties
457
- invalid_properties = Array.new
458
- invalid_properties
459
- end
460
-
461
- # Check to see if the all the properties in the model are valid
462
- # @return true if the model is valid
463
- def valid?
464
- true
465
- end
466
-
467
- # Checks equality by comparing each attribute.
468
- # @param [Object] Object to be compared
469
- def ==(o)
470
- return true if self.equal?(o)
471
- self.class == o.class &&
472
- account_fee == o.account_fee &&
473
- assignment == o.assignment &&
474
- buy == o.buy &&
475
- buy_to_cover == o.buy_to_cover &&
476
- contribution == o.contribution &&
477
- deposit == o.deposit &&
478
- distribution == o.distribution &&
479
- dividend == o.dividend &&
480
- dividend_reinvestment == o.dividend_reinvestment &&
481
- exercise == o.exercise &&
482
- expire == o.expire &&
483
- fund_fee == o.fund_fee &&
484
- interest == o.interest &&
485
- interest_receivable == o.interest_receivable &&
486
- interest_reinvestment == o.interest_reinvestment &&
487
- legal_fee == o.legal_fee &&
488
- loan_payment == o.loan_payment &&
489
- long_term_capital_gain == o.long_term_capital_gain &&
490
- long_term_capital_gain_reinvestment == o.long_term_capital_gain_reinvestment &&
491
- management_fee == o.management_fee &&
492
- margin_expense == o.margin_expense &&
493
- merger == o.merger &&
494
- miscellaneous_fee == o.miscellaneous_fee &&
495
- non_qualified_dividend == o.non_qualified_dividend &&
496
- non_resident_tax == o.non_resident_tax &&
497
- pending_credit == o.pending_credit &&
498
- pending_debit == o.pending_debit &&
499
- qualified_dividend == o.qualified_dividend &&
500
- rebalance == o.rebalance &&
501
- return_of_principal == o.return_of_principal &&
502
- sell == o.sell &&
503
- sell_short == o.sell_short &&
504
- short_term_capital_gain == o.short_term_capital_gain &&
505
- short_term_capital_gain_reinvestment == o.short_term_capital_gain_reinvestment &&
506
- spin_off == o.spin_off &&
507
- split == o.split &&
508
- stock_distribution == o.stock_distribution &&
509
- tax == o.tax &&
510
- tax_withheld == o.tax_withheld &&
511
- transfer == o.transfer &&
512
- transfer_fee == o.transfer_fee &&
513
- trust_fee == o.trust_fee &&
514
- unqualified_gain == o.unqualified_gain &&
515
- withdrawal == o.withdrawal
516
- end
517
-
518
- # @see the `==` method
519
- # @param [Object] Object to be compared
520
- def eql?(o)
521
- self == o
522
- end
523
-
524
- # Calculates hash code according to all attributes.
525
- # @return [Integer] Hash code
526
- def hash
527
- [account_fee, assignment, buy, buy_to_cover, contribution, deposit, distribution, dividend, dividend_reinvestment, exercise, expire, fund_fee, interest, interest_receivable, interest_reinvestment, legal_fee, loan_payment, long_term_capital_gain, long_term_capital_gain_reinvestment, management_fee, margin_expense, merger, miscellaneous_fee, non_qualified_dividend, non_resident_tax, pending_credit, pending_debit, qualified_dividend, rebalance, return_of_principal, sell, sell_short, short_term_capital_gain, short_term_capital_gain_reinvestment, spin_off, split, stock_distribution, tax, tax_withheld, transfer, transfer_fee, trust_fee, unqualified_gain, withdrawal].hash
528
- end
529
-
530
- # Builds the object from hash
531
- # @param [Hash] attributes Model attributes in the form of hash
532
- # @return [Object] Returns the model itself
533
- def self.build_from_hash(attributes)
534
- new.build_from_hash(attributes)
535
- end
536
-
537
- # Builds the object from hash
538
- # @param [Hash] attributes Model attributes in the form of hash
539
- # @return [Object] Returns the model itself
540
- def build_from_hash(attributes)
541
- return nil unless attributes.is_a?(Hash)
542
- self.class.openapi_types.each_pair do |key, type|
543
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
544
- self.send("#{key}=", nil)
545
- elsif type =~ /\AArray<(.*)>/i
546
- # check to ensure the input is an array given that the attribute
547
- # is documented as an array but the input is not
548
- if attributes[self.class.attribute_map[key]].is_a?(Array)
549
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
550
- end
551
- elsif !attributes[self.class.attribute_map[key]].nil?
552
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
553
- end
554
- end
555
-
556
- self
557
- end
558
-
559
- # Deserializes the data based on type
560
- # @param string type Data type
561
- # @param string value Value to be deserialized
562
- # @return [Object] Deserialized data
563
- def _deserialize(type, value)
564
- case type.to_sym
565
- when :Time
566
- Time.parse(value)
567
- when :Date
568
- Date.parse(value)
569
- when :String
570
- value.to_s
571
- when :Integer
572
- value.to_i
573
- when :Float
574
- value.to_f
575
- when :Boolean
576
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
577
- true
578
- else
579
- false
580
- end
581
- when :Object
582
- # generic object (usually a Hash), return directly
583
- value
584
- when /\AArray<(?<inner_type>.+)>\z/
585
- inner_type = Regexp.last_match[:inner_type]
586
- value.map { |v| _deserialize(inner_type, v) }
587
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
588
- k_type = Regexp.last_match[:k_type]
589
- v_type = Regexp.last_match[:v_type]
590
- {}.tap do |hash|
591
- value.each do |k, v|
592
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
593
- end
594
- end
595
- else # model
596
- # models (e.g. Pet) or oneOf
597
- klass = Plaid.const_get(type)
598
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
599
- end
600
- end
601
-
602
- # Returns the string representation of the object
603
- # @return [String] String presentation of the object
604
- def to_s
605
- to_hash.to_s
606
- end
607
-
608
- # to_body is an alias to to_hash (backward compatibility)
609
- # @return [Hash] Returns the object in the form of hash
610
- def to_body
611
- to_hash
612
- end
613
-
614
- # Returns the object in the form of hash
615
- # @return [Hash] Returns the object in the form of hash
616
- def to_hash
617
- hash = {}
618
- self.class.attribute_map.each_pair do |attr, param|
619
- value = self.send(attr)
620
- if value.nil?
621
- is_nullable = self.class.openapi_nullable.include?(attr)
622
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
623
- end
624
-
625
- hash[param] = _to_hash(value)
626
- end
627
- hash
628
- end
629
-
630
- # Outputs non-array value in the form of hash
631
- # For object, use to_hash. Otherwise, just return the value
632
- # @param [Object] value Any valid value
633
- # @return [Hash] Returns the value in the form of hash
634
- def _to_hash(value)
635
- if value.is_a?(Array)
636
- value.compact.map { |v| _to_hash(v) }
637
- elsif value.is_a?(Hash)
638
- {}.tap do |hash|
639
- value.each { |k, v| hash[k] = _to_hash(v) }
640
- end
641
- elsif value.respond_to? :to_hash
642
- value.to_hash
643
- else
644
- value
645
- end
646
- end
647
-
648
- end
649
-
650
- end