plaid 14.0.0.beta.5 → 14.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (473) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/CONTRIBUTING.md +1 -5
  4. data/Gemfile.lock +14 -4
  5. data/Makefile +1 -1
  6. data/README.md +10 -9
  7. data/doc/rdoc/.DS_Store +0 -0
  8. data/lib/plaid/.DS_Store +0 -0
  9. data/lib/plaid/api/plaid_api.rb +2257 -766
  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 +7 -11
  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 +2 -2
  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 +17 -2
  36. data/lib/plaid/models/application_get_request.rb +1 -1
  37. data/lib/plaid/models/application_get_response.rb +1 -1
  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 +1 -1
  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 +1 -1
  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 +8 -12
  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 +2 -9
  143. data/lib/plaid/models/external_payment_options.rb +61 -7
  144. data/lib/plaid/models/external_payment_refund_details.rb +7 -2
  145. data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +22 -26
  146. data/lib/plaid/models/external_payment_schedule_get.rb +20 -20
  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 +2 -2
  151. data/lib/plaid/models/holding.rb +3 -3
  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_override.rb +222 -0
  160. data/lib/plaid/models/income_summary.rb +26 -1
  161. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  162. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  163. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  164. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  165. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -10
  166. data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
  167. data/lib/plaid/models/income_verification_paystub_get_request.rb +17 -10
  168. data/lib/plaid/models/income_verification_paystub_get_response.rb +22 -2
  169. data/lib/plaid/models/income_verification_paystubs_get_request.rb +252 -0
  170. data/lib/plaid/models/income_verification_paystubs_get_response.rb +262 -0
  171. data/lib/plaid/models/income_verification_precheck_employer.rb +231 -0
  172. data/lib/plaid/models/income_verification_precheck_military_info.rb +265 -0
  173. data/lib/plaid/models/income_verification_precheck_request.rb +271 -0
  174. data/lib/plaid/models/income_verification_precheck_response.rb +289 -0
  175. data/lib/plaid/models/income_verification_precheck_user.rb +252 -0
  176. data/lib/plaid/models/income_verification_refresh_request.rb +252 -0
  177. data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
  178. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  179. data/lib/plaid/models/income_verification_summary_get_request.rb +17 -10
  180. data/lib/plaid/models/income_verification_summary_get_response.rb +12 -2
  181. data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
  182. data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
  183. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  184. data/lib/plaid/models/inflow_model.rb +1 -1
  185. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  186. data/lib/plaid/models/institution.rb +17 -7
  187. data/lib/plaid/models/institution_status.rb +30 -3
  188. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  189. data/lib/plaid/models/institutions_get_by_id_request_options.rb +15 -3
  190. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  191. data/lib/plaid/models/institutions_get_request.rb +1 -1
  192. data/lib/plaid/models/institutions_get_request_options.rb +15 -3
  193. data/lib/plaid/models/institutions_get_response.rb +1 -1
  194. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  195. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  196. data/lib/plaid/models/institutions_search_request.rb +2 -2
  197. data/lib/plaid/models/institutions_search_request_options.rb +15 -3
  198. data/lib/plaid/models/institutions_search_response.rb +1 -1
  199. data/lib/plaid/models/investment_filter.rb +2 -2
  200. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  201. data/lib/plaid/models/investment_transaction.rb +7 -7
  202. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  203. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  204. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  205. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  206. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  207. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  208. data/lib/plaid/models/investments_transactions_override.rb +319 -0
  209. data/lib/plaid/models/item.rb +5 -5
  210. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  211. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  212. data/lib/plaid/models/item_application_list_request.rb +241 -0
  213. data/lib/plaid/models/item_application_list_response.rb +237 -0
  214. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  215. data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
  216. data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
  217. data/lib/plaid/models/item_error_webhook.rb +1 -1
  218. data/lib/plaid/models/item_get_request.rb +1 -1
  219. data/lib/plaid/models/item_get_response.rb +2 -2
  220. data/lib/plaid/models/item_import_request.rb +1 -1
  221. data/lib/plaid/models/item_import_request_options.rb +1 -1
  222. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  223. data/lib/plaid/models/item_import_response.rb +1 -1
  224. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  225. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  226. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  227. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  228. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  229. data/lib/plaid/models/item_remove_request.rb +1 -1
  230. data/lib/plaid/models/item_remove_response.rb +1 -1
  231. data/lib/plaid/models/item_status.rb +7 -16
  232. data/lib/plaid/models/item_status_investments.rb +232 -0
  233. data/lib/plaid/models/{nullable_recipient_bacs.rb → item_status_last_webhook.rb} +22 -26
  234. data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +10 -19
  235. data/lib/plaid/models/item_status_transactions.rb +232 -0
  236. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  237. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  238. data/lib/plaid/models/jwk_public_key.rb +3 -1
  239. data/lib/plaid/models/jwt_header.rb +1 -1
  240. data/lib/plaid/models/liabilities_default_update_webhook.rb +27 -2
  241. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  242. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  243. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  244. data/lib/plaid/models/liabilities_object.rb +4 -4
  245. data/lib/plaid/models/liability_override.rb +4 -4
  246. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  247. data/lib/plaid/models/link_token_create_request.rb +25 -7
  248. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  249. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  250. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  251. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -3
  252. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +22 -1
  253. data/lib/plaid/models/link_token_create_request_update.rb +222 -0
  254. data/lib/plaid/models/link_token_create_request_user.rb +9 -9
  255. data/lib/plaid/models/link_token_create_response.rb +2 -2
  256. data/lib/plaid/models/link_token_eu_config.rb +220 -0
  257. data/lib/plaid/models/link_token_get_metadata_response.rb +11 -1
  258. data/lib/plaid/models/link_token_get_request.rb +1 -1
  259. data/lib/plaid/models/link_token_get_response.rb +13 -3
  260. data/lib/plaid/models/loan_filter.rb +2 -2
  261. data/lib/plaid/models/location.rb +1 -1
  262. data/lib/plaid/models/meta.rb +1 -1
  263. data/lib/plaid/models/mfa.rb +1 -1
  264. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  265. data/lib/plaid/models/mortgage_liability.rb +24 -10
  266. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  267. data/lib/plaid/models/net_pay.rb +230 -0
  268. data/lib/plaid/models/new_accounts_available_webhook.rb +250 -0
  269. data/lib/plaid/models/numbers.rb +1 -41
  270. data/lib/plaid/models/numbers_ach.rb +2 -2
  271. data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +5 -5
  272. data/lib/plaid/models/numbers_bacs.rb +1 -1
  273. data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +4 -4
  274. data/lib/plaid/models/numbers_eft.rb +1 -1
  275. data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +4 -4
  276. data/lib/plaid/models/numbers_international.rb +1 -1
  277. data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +4 -4
  278. data/lib/plaid/models/override_account_type.rb +41 -0
  279. data/lib/plaid/models/override_accounts.rb +33 -6
  280. data/lib/plaid/models/owner.rb +1 -1
  281. data/lib/plaid/models/owner_override.rb +1 -1
  282. data/lib/plaid/models/pay.rb +258 -0
  283. data/lib/plaid/models/pay_frequency.rb +1 -1
  284. data/lib/plaid/models/pay_period_details.rb +7 -7
  285. data/lib/plaid/models/payment_amount.rb +12 -1
  286. data/lib/plaid/models/payment_initiation_address.rb +118 -4
  287. data/lib/plaid/models/payment_initiation_metadata.rb +16 -1
  288. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +53 -1
  289. data/lib/plaid/models/payment_initiation_payment.rb +33 -3
  290. data/lib/plaid/models/payment_initiation_payment_create_request.rb +53 -3
  291. data/lib/plaid/models/payment_initiation_payment_create_response.rb +35 -1
  292. data/lib/plaid/models/payment_initiation_payment_get_request.rb +22 -1
  293. data/lib/plaid/models/payment_initiation_payment_get_response.rb +33 -3
  294. data/lib/plaid/models/payment_initiation_payment_list_request.rb +11 -2
  295. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  296. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
  297. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +289 -0
  298. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +22 -1
  299. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  300. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  301. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +49 -2
  302. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  303. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +22 -1
  304. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  305. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  306. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  307. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  308. data/lib/plaid/models/payment_initiation_refund.rb +303 -0
  309. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +16 -1
  310. data/lib/plaid/models/payment_meta.rb +1 -1
  311. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  312. data/lib/plaid/models/payment_status_update_webhook.rb +4 -4
  313. data/lib/plaid/models/paystub.rb +56 -25
  314. data/lib/plaid/models/paystub_address.rb +297 -0
  315. data/lib/plaid/models/paystub_deduction.rb +1 -1
  316. data/lib/plaid/models/paystub_details.rb +299 -0
  317. data/lib/plaid/models/paystub_employer.rb +229 -0
  318. data/lib/plaid/models/paystub_override.rb +248 -0
  319. data/lib/plaid/models/paystub_override_employee.rb +229 -0
  320. data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
  321. data/lib/plaid/models/{nullable_access_token.rb → paystub_override_employer.rb} +17 -6
  322. data/lib/plaid/models/paystub_ytd_details.rb +4 -11
  323. data/lib/plaid/models/pending_expiration_webhook.rb +3 -3
  324. data/lib/plaid/models/personal_finance_category.rb +240 -0
  325. data/lib/plaid/models/phone_number.rb +11 -3
  326. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  327. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  328. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  329. data/lib/plaid/models/processor_balance_get_request.rb +14 -5
  330. data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
  331. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  332. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  333. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  334. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  335. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  336. data/lib/plaid/models/processor_number.rb +5 -5
  337. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  338. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  339. data/lib/plaid/models/processor_token_create_request.rb +36 -2
  340. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  341. data/lib/plaid/models/product_access.rb +262 -0
  342. data/lib/plaid/models/product_status.rb +4 -4
  343. data/lib/plaid/models/product_status_breakdown.rb +1 -2
  344. data/lib/plaid/models/products.rb +3 -1
  345. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  346. data/lib/plaid/models/pslf_status.rb +3 -3
  347. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  348. data/lib/plaid/models/recipient_bacs.rb +53 -1
  349. data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
  350. data/lib/plaid/models/requested_scopes.rb +261 -0
  351. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  352. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  353. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  354. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  355. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
  356. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
  357. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  358. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  359. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  360. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  361. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  362. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  363. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  364. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  365. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  366. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  367. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  368. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  369. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +4 -4
  370. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  371. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
  372. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
  373. data/lib/plaid/models/scopes.rb +243 -0
  374. data/lib/plaid/models/scopes_context.rb +37 -0
  375. data/lib/plaid/models/scopes_nullable.rb +249 -0
  376. data/lib/plaid/models/security.rb +3 -3
  377. data/lib/plaid/models/security_override.rb +270 -0
  378. data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
  379. data/lib/plaid/models/servicer_address_data.rb +1 -1
  380. data/lib/plaid/models/signal_address_data.rb +263 -0
  381. data/lib/plaid/models/signal_decision_report_request.rb +260 -0
  382. data/lib/plaid/models/signal_decision_report_response.rb +225 -0
  383. data/lib/plaid/models/signal_device.rb +232 -0
  384. data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
  385. data/lib/plaid/models/signal_evaluate_request.rb +356 -0
  386. data/lib/plaid/models/signal_evaluate_response.rb +253 -0
  387. data/lib/plaid/models/signal_person_name.rb +265 -0
  388. data/lib/plaid/models/signal_return_report_request.rb +260 -0
  389. data/lib/plaid/models/signal_return_report_response.rb +225 -0
  390. data/lib/plaid/models/signal_scores.rb +228 -0
  391. data/lib/plaid/models/signal_user.rb +252 -0
  392. data/lib/plaid/models/standalone_account_type.rb +1 -1
  393. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  394. data/lib/plaid/models/standalone_investment_transaction_type.rb +3 -3
  395. data/lib/plaid/models/student_loan.rb +33 -13
  396. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  397. data/lib/plaid/models/student_loan_status.rb +3 -3
  398. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  399. data/lib/plaid/models/taxform.rb +233 -0
  400. data/lib/plaid/models/taxpayer_id.rb +257 -0
  401. data/lib/plaid/models/total.rb +284 -0
  402. data/lib/plaid/models/transaction.rb +190 -129
  403. data/lib/plaid/models/transaction_all_of.rb +333 -0
  404. data/lib/plaid/models/transaction_base.rb +436 -0
  405. data/lib/plaid/models/transaction_code.rb +1 -1
  406. data/lib/plaid/models/transaction_data.rb +3 -3
  407. data/lib/plaid/models/transaction_override.rb +5 -5
  408. data/lib/plaid/models/transactions_get_request.rb +1 -1
  409. data/lib/plaid/models/transactions_get_request_options.rb +30 -5
  410. data/lib/plaid/models/transactions_get_response.rb +1 -1
  411. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  412. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  413. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  414. data/lib/plaid/models/transfer.rb +417 -0
  415. data/lib/plaid/models/transfer_authorization.rb +313 -0
  416. data/lib/plaid/models/transfer_authorization_create_request.rb +350 -0
  417. data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
  418. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +274 -0
  419. data/lib/plaid/models/transfer_authorization_device.rb +230 -0
  420. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +312 -0
  421. data/lib/plaid/models/transfer_cancel_request.rb +245 -0
  422. data/lib/plaid/models/transfer_cancel_response.rb +225 -0
  423. data/lib/plaid/models/transfer_create_request.rb +451 -0
  424. data/lib/plaid/models/transfer_create_response.rb +239 -0
  425. data/lib/plaid/models/transfer_event.rb +355 -0
  426. data/lib/plaid/models/transfer_event_list_request.rb +411 -0
  427. data/lib/plaid/models/transfer_event_list_response.rb +241 -0
  428. data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
  429. data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
  430. data/lib/plaid/models/transfer_event_type.rb +40 -0
  431. data/lib/plaid/models/transfer_failure.rb +231 -0
  432. data/lib/plaid/models/transfer_get_request.rb +245 -0
  433. data/lib/plaid/models/transfer_get_response.rb +239 -0
  434. data/lib/plaid/models/transfer_list_request.rb +330 -0
  435. data/lib/plaid/models/transfer_list_response.rb +241 -0
  436. data/lib/plaid/models/transfer_network.rb +37 -0
  437. data/lib/plaid/models/transfer_status.rb +40 -0
  438. data/lib/plaid/models/transfer_type.rb +37 -0
  439. data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
  440. data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
  441. data/lib/plaid/models/transfer_user_in_request.rb +254 -0
  442. data/lib/plaid/models/transfer_user_in_response.rb +257 -0
  443. data/lib/plaid/models/user_custom_password.rb +1 -1
  444. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  445. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  446. data/lib/plaid/models/verification_refresh_status.rb +36 -0
  447. data/lib/plaid/models/verification_status.rb +1 -1
  448. data/lib/plaid/models/w2.rb +437 -0
  449. data/lib/plaid/models/w2_box12.rb +231 -0
  450. data/lib/plaid/models/w2_state_and_local_wages.rb +286 -0
  451. data/lib/plaid/models/warning.rb +35 -1
  452. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  453. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  454. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  455. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  456. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  457. data/lib/plaid/version.rb +2 -2
  458. data/lib/plaid.rb +137 -12
  459. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  460. data/pkg/plaid-14.0.0.gem +0 -0
  461. data/pkg/plaid-14.1.0.gem +0 -0
  462. data/plaid.gemspec +1 -1
  463. data/templates/ruby/api_client.mustache +3 -2
  464. data/templates/ruby/api_client_faraday_partial.mustache +2 -1
  465. data/templates/ruby/api_error.mustache +49 -0
  466. data/templates/ruby/configuration.mustache +3 -1
  467. data/test/test_accounts.rb +4 -8
  468. data/test/test_bank_transfers.rb +1 -1
  469. data/test/test_item.rb +0 -10
  470. data/test/test_payment_initiation.rb +1 -1
  471. data/test/test_processor.rb +1 -16
  472. metadata +146 -15
  473. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -16,12 +16,15 @@ require 'time'
16
16
  module Plaid
17
17
  # Specifies optional parameters for `/institutions/get_by_id`. If provided, must not be `null`.
18
18
  class InstitutionsGetByIdRequestOptions
19
- # When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`. Note that you may need to contact your Plaid Account Manager to be enabled to use this flag. Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
19
+ # When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`. Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
20
20
  attr_accessor :include_optional_metadata
21
21
 
22
22
  # If `true`, the response will include status information about the institution. Default value is `false`.
23
23
  attr_accessor :include_status
24
24
 
25
+ # When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
26
+ attr_accessor :include_auth_metadata
27
+
25
28
  # When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
26
29
  attr_accessor :include_payment_initiation_metadata
27
30
 
@@ -30,6 +33,7 @@ module Plaid
30
33
  {
31
34
  :'include_optional_metadata' => :'include_optional_metadata',
32
35
  :'include_status' => :'include_status',
36
+ :'include_auth_metadata' => :'include_auth_metadata',
33
37
  :'include_payment_initiation_metadata' => :'include_payment_initiation_metadata'
34
38
  }
35
39
  end
@@ -44,6 +48,7 @@ module Plaid
44
48
  {
45
49
  :'include_optional_metadata' => :'Boolean',
46
50
  :'include_status' => :'Boolean',
51
+ :'include_auth_metadata' => :'Boolean',
47
52
  :'include_payment_initiation_metadata' => :'Boolean'
48
53
  }
49
54
  end
@@ -81,6 +86,12 @@ module Plaid
81
86
  self.include_status = false
82
87
  end
83
88
 
89
+ if attributes.key?(:'include_auth_metadata')
90
+ self.include_auth_metadata = attributes[:'include_auth_metadata']
91
+ else
92
+ self.include_auth_metadata = false
93
+ end
94
+
84
95
  if attributes.key?(:'include_payment_initiation_metadata')
85
96
  self.include_payment_initiation_metadata = attributes[:'include_payment_initiation_metadata']
86
97
  else
@@ -108,6 +119,7 @@ module Plaid
108
119
  self.class == o.class &&
109
120
  include_optional_metadata == o.include_optional_metadata &&
110
121
  include_status == o.include_status &&
122
+ include_auth_metadata == o.include_auth_metadata &&
111
123
  include_payment_initiation_metadata == o.include_payment_initiation_metadata
112
124
  end
113
125
 
@@ -120,7 +132,7 @@ module Plaid
120
132
  # Calculates hash code according to all attributes.
121
133
  # @return [Integer] Hash code
122
134
  def hash
123
- [include_optional_metadata, include_status, include_payment_initiation_metadata].hash
135
+ [include_optional_metadata, include_status, include_auth_metadata, include_payment_initiation_metadata].hash
124
136
  end
125
137
 
126
138
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -25,9 +25,12 @@ module Plaid
25
25
  # Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes.
26
26
  attr_accessor :oauth
27
27
 
28
- # When `true`, return the institution's homepage URL, logo and primary brand color. Note that you may need to contact your Plaid Account Manager to be enabled to use this flag. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
28
+ # When `true`, return the institution's homepage URL, logo and primary brand color. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
29
29
  attr_accessor :include_optional_metadata
30
30
 
31
+ # When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
32
+ attr_accessor :include_auth_metadata
33
+
31
34
  # When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
32
35
  attr_accessor :include_payment_initiation_metadata
33
36
 
@@ -38,6 +41,7 @@ module Plaid
38
41
  :'routing_numbers' => :'routing_numbers',
39
42
  :'oauth' => :'oauth',
40
43
  :'include_optional_metadata' => :'include_optional_metadata',
44
+ :'include_auth_metadata' => :'include_auth_metadata',
41
45
  :'include_payment_initiation_metadata' => :'include_payment_initiation_metadata'
42
46
  }
43
47
  end
@@ -54,6 +58,7 @@ module Plaid
54
58
  :'routing_numbers' => :'Array<String>',
55
59
  :'oauth' => :'Boolean',
56
60
  :'include_optional_metadata' => :'Boolean',
61
+ :'include_auth_metadata' => :'Boolean',
57
62
  :'include_payment_initiation_metadata' => :'Boolean'
58
63
  }
59
64
  end
@@ -99,6 +104,12 @@ module Plaid
99
104
  self.include_optional_metadata = attributes[:'include_optional_metadata']
100
105
  end
101
106
 
107
+ if attributes.key?(:'include_auth_metadata')
108
+ self.include_auth_metadata = attributes[:'include_auth_metadata']
109
+ else
110
+ self.include_auth_metadata = false
111
+ end
112
+
102
113
  if attributes.key?(:'include_payment_initiation_metadata')
103
114
  self.include_payment_initiation_metadata = attributes[:'include_payment_initiation_metadata']
104
115
  else
@@ -128,6 +139,7 @@ module Plaid
128
139
  routing_numbers == o.routing_numbers &&
129
140
  oauth == o.oauth &&
130
141
  include_optional_metadata == o.include_optional_metadata &&
142
+ include_auth_metadata == o.include_auth_metadata &&
131
143
  include_payment_initiation_metadata == o.include_payment_initiation_metadata
132
144
  end
133
145
 
@@ -140,7 +152,7 @@ module Plaid
140
152
  # Calculates hash code according to all attributes.
141
153
  # @return [Integer] Hash code
142
154
  def hash
143
- [products, routing_numbers, oauth, include_optional_metadata, include_payment_initiation_metadata].hash
155
+ [products, routing_numbers, oauth, include_optional_metadata, include_auth_metadata, include_payment_initiation_metadata].hash
144
156
  end
145
157
 
146
158
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -25,7 +25,7 @@ module Plaid
25
25
  # The search query. Institutions with names matching the query are returned
26
26
  attr_accessor :query
27
27
 
28
- # Filter the Institutions based on whether they support all products listed in products. Provide `null` to get institutions regardless of supported products
28
+ # Filter the Institutions based on whether they support all products listed in `products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array.
29
29
  attr_accessor :products
30
30
 
31
31
  # Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -19,9 +19,12 @@ module Plaid
19
19
  # Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes
20
20
  attr_accessor :oauth
21
21
 
22
- # When true, return the institution's homepage URL, logo and primary brand color. Note that you may need to contact your Plaid Account Manager to be enabled to use this flag.
22
+ # When true, return the institution's homepage URL, logo and primary brand color.
23
23
  attr_accessor :include_optional_metadata
24
24
 
25
+ # When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
26
+ attr_accessor :include_auth_metadata
27
+
25
28
  # When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
26
29
  attr_accessor :include_payment_initiation_metadata
27
30
 
@@ -32,6 +35,7 @@ module Plaid
32
35
  {
33
36
  :'oauth' => :'oauth',
34
37
  :'include_optional_metadata' => :'include_optional_metadata',
38
+ :'include_auth_metadata' => :'include_auth_metadata',
35
39
  :'include_payment_initiation_metadata' => :'include_payment_initiation_metadata',
36
40
  :'payment_initiation' => :'payment_initiation'
37
41
  }
@@ -47,6 +51,7 @@ module Plaid
47
51
  {
48
52
  :'oauth' => :'Boolean',
49
53
  :'include_optional_metadata' => :'Boolean',
54
+ :'include_auth_metadata' => :'Boolean',
50
55
  :'include_payment_initiation_metadata' => :'Boolean',
51
56
  :'payment_initiation' => :'InstitutionsSearchPaymentInitiationOptions'
52
57
  }
@@ -82,6 +87,12 @@ module Plaid
82
87
  self.include_optional_metadata = attributes[:'include_optional_metadata']
83
88
  end
84
89
 
90
+ if attributes.key?(:'include_auth_metadata')
91
+ self.include_auth_metadata = attributes[:'include_auth_metadata']
92
+ else
93
+ self.include_auth_metadata = false
94
+ end
95
+
85
96
  if attributes.key?(:'include_payment_initiation_metadata')
86
97
  self.include_payment_initiation_metadata = attributes[:'include_payment_initiation_metadata']
87
98
  else
@@ -113,6 +124,7 @@ module Plaid
113
124
  self.class == o.class &&
114
125
  oauth == o.oauth &&
115
126
  include_optional_metadata == o.include_optional_metadata &&
127
+ include_auth_metadata == o.include_auth_metadata &&
116
128
  include_payment_initiation_metadata == o.include_payment_initiation_metadata &&
117
129
  payment_initiation == o.payment_initiation
118
130
  end
@@ -126,7 +138,7 @@ module Plaid
126
138
  # Calculates hash code according to all attributes.
127
139
  # @return [Integer] Hash code
128
140
  def hash
129
- [oauth, include_optional_metadata, include_payment_initiation_metadata, payment_initiation].hash
141
+ [oauth, include_optional_metadata, include_auth_metadata, include_payment_initiation_metadata, payment_initiation].hash
130
142
  end
131
143
 
132
144
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -16,7 +16,7 @@ require 'time'
16
16
  module Plaid
17
17
  # A filter to apply to `investment`-type accounts
18
18
  class InvestmentFilter
19
- # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema).
19
+ # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#accounts-schema).
20
20
  attr_accessor :account_subtypes
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -28,13 +28,13 @@ module Plaid
28
28
  # The `security_id` to which this transaction is related.
29
29
  attr_accessor :security_id
30
30
 
31
- # The ISO-8601 posting date for the transaction, or transacted date for pending transactions.
31
+ # The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the transaction, or transacted date for pending transactions.
32
32
  attr_accessor :date
33
33
 
34
34
  # The institution’s description of the transaction.
35
35
  attr_accessor :name
36
36
 
37
- # The number of units of the security involved in this transactions
37
+ # The number of units of the security involved in this transaction.
38
38
  attr_accessor :quantity
39
39
 
40
40
  # The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.
@@ -46,16 +46,16 @@ module Plaid
46
46
  # The combined value of all fees applied to this transaction
47
47
  attr_accessor :fees
48
48
 
49
- # Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
49
+ # Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
50
50
  attr_accessor :type
51
51
 
52
- # For descriptions of possible transaction subtypes, see [Investment transaction subtypes schema](/docs/api/accounts/#investment-transaction-subtypes-schema).
52
+ # For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
53
53
  attr_accessor :subtype
54
54
 
55
55
  # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-`null`.
56
56
  attr_accessor :iso_currency_code
57
57
 
58
- # The unofficial currency code associated with the holding. 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.
58
+ # The unofficial currency code associated with the holding. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
59
59
  attr_accessor :unofficial_currency_code
60
60
 
61
61
  class EnumAttributeValidator
@@ -112,7 +112,7 @@ module Plaid
112
112
  :'cancel_transaction_id' => :'String',
113
113
  :'account_id' => :'String',
114
114
  :'security_id' => :'String',
115
- :'date' => :'String',
115
+ :'date' => :'Date',
116
116
  :'name' => :'String',
117
117
  :'quantity' => :'Float',
118
118
  :'amount' => :'Float',
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.16.6
6
+ The version of the OpenAPI document: 2020-09-14_1.33.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -0,0 +1,319 @@
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.33.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
+ # Specify the list of investments transactions on the account.
18
+ class InvestmentsTransactionsOverride
19
+ # Posting date for the transaction. Must be formatted as an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date.
20
+ attr_accessor :date
21
+
22
+ # The institution's description of the transaction.
23
+ attr_accessor :name
24
+
25
+ # The number of units of the security involved in this transaction. Must be positive if the type is a buy and negative if the type is a sell.
26
+ attr_accessor :quantity
27
+
28
+ # The price of the security at which this transaction occurred.
29
+ attr_accessor :price
30
+
31
+ # The combined value of all fees applied to this transaction.
32
+ attr_accessor :fees
33
+
34
+ # The type of the investment transaction. Possible values are: `buy`: Buying an investment `sell`: Selling an investment `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
35
+ attr_accessor :type
36
+
37
+ # Either a valid `iso_currency_code` or `unofficial_currency_code`
38
+ attr_accessor :currency
39
+
40
+ attr_accessor :security
41
+
42
+ # Attribute mapping from ruby-style variable name to JSON key.
43
+ def self.attribute_map
44
+ {
45
+ :'date' => :'date',
46
+ :'name' => :'name',
47
+ :'quantity' => :'quantity',
48
+ :'price' => :'price',
49
+ :'fees' => :'fees',
50
+ :'type' => :'type',
51
+ :'currency' => :'currency',
52
+ :'security' => :'security'
53
+ }
54
+ end
55
+
56
+ # Returns all the JSON keys this model knows about
57
+ def self.acceptable_attributes
58
+ attribute_map.values
59
+ end
60
+
61
+ # Attribute type mapping.
62
+ def self.openapi_types
63
+ {
64
+ :'date' => :'Date',
65
+ :'name' => :'String',
66
+ :'quantity' => :'Float',
67
+ :'price' => :'Float',
68
+ :'fees' => :'Float',
69
+ :'type' => :'String',
70
+ :'currency' => :'String',
71
+ :'security' => :'SecurityOverride'
72
+ }
73
+ end
74
+
75
+ # List of attributes with nullable: true
76
+ def self.openapi_nullable
77
+ Set.new([
78
+ ])
79
+ end
80
+
81
+ # Initializes the object
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ def initialize(attributes = {})
84
+ if (!attributes.is_a?(Hash))
85
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InvestmentsTransactionsOverride` initialize method"
86
+ end
87
+
88
+ # check to see if the attribute exists and convert string to symbol for hash key
89
+ attributes = attributes.each_with_object({}) { |(k, v), h|
90
+ if (!self.class.attribute_map.key?(k.to_sym))
91
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::InvestmentsTransactionsOverride`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
92
+ end
93
+ h[k.to_sym] = v
94
+ }
95
+
96
+ if attributes.key?(:'date')
97
+ self.date = attributes[:'date']
98
+ end
99
+
100
+ if attributes.key?(:'name')
101
+ self.name = attributes[:'name']
102
+ end
103
+
104
+ if attributes.key?(:'quantity')
105
+ self.quantity = attributes[:'quantity']
106
+ end
107
+
108
+ if attributes.key?(:'price')
109
+ self.price = attributes[:'price']
110
+ end
111
+
112
+ if attributes.key?(:'fees')
113
+ self.fees = attributes[:'fees']
114
+ end
115
+
116
+ if attributes.key?(:'type')
117
+ self.type = attributes[:'type']
118
+ end
119
+
120
+ if attributes.key?(:'currency')
121
+ self.currency = attributes[:'currency']
122
+ end
123
+
124
+ if attributes.key?(:'security')
125
+ self.security = attributes[:'security']
126
+ end
127
+ end
128
+
129
+ # Show invalid properties with the reasons. Usually used together with valid?
130
+ # @return Array for valid properties with the reasons
131
+ def list_invalid_properties
132
+ invalid_properties = Array.new
133
+ if @date.nil?
134
+ invalid_properties.push('invalid value for "date", date cannot be nil.')
135
+ end
136
+
137
+ if @name.nil?
138
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
139
+ end
140
+
141
+ if @quantity.nil?
142
+ invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
143
+ end
144
+
145
+ if @price.nil?
146
+ invalid_properties.push('invalid value for "price", price cannot be nil.')
147
+ end
148
+
149
+ if @type.nil?
150
+ invalid_properties.push('invalid value for "type", type cannot be nil.')
151
+ end
152
+
153
+ if @currency.nil?
154
+ invalid_properties.push('invalid value for "currency", currency cannot be nil.')
155
+ end
156
+
157
+ invalid_properties
158
+ end
159
+
160
+ # Check to see if the all the properties in the model are valid
161
+ # @return true if the model is valid
162
+ def valid?
163
+ return false if @date.nil?
164
+ return false if @name.nil?
165
+ return false if @quantity.nil?
166
+ return false if @price.nil?
167
+ return false if @type.nil?
168
+ return false if @currency.nil?
169
+ true
170
+ end
171
+
172
+ # Checks equality by comparing each attribute.
173
+ # @param [Object] Object to be compared
174
+ def ==(o)
175
+ return true if self.equal?(o)
176
+ self.class == o.class &&
177
+ date == o.date &&
178
+ name == o.name &&
179
+ quantity == o.quantity &&
180
+ price == o.price &&
181
+ fees == o.fees &&
182
+ type == o.type &&
183
+ currency == o.currency &&
184
+ security == o.security
185
+ end
186
+
187
+ # @see the `==` method
188
+ # @param [Object] Object to be compared
189
+ def eql?(o)
190
+ self == o
191
+ end
192
+
193
+ # Calculates hash code according to all attributes.
194
+ # @return [Integer] Hash code
195
+ def hash
196
+ [date, name, quantity, price, fees, type, currency, security].hash
197
+ end
198
+
199
+ # Builds the object from hash
200
+ # @param [Hash] attributes Model attributes in the form of hash
201
+ # @return [Object] Returns the model itself
202
+ def self.build_from_hash(attributes)
203
+ new.build_from_hash(attributes)
204
+ end
205
+
206
+ # Builds the object from hash
207
+ # @param [Hash] attributes Model attributes in the form of hash
208
+ # @return [Object] Returns the model itself
209
+ def build_from_hash(attributes)
210
+ return nil unless attributes.is_a?(Hash)
211
+ self.class.openapi_types.each_pair do |key, type|
212
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
213
+ self.send("#{key}=", nil)
214
+ elsif type =~ /\AArray<(.*)>/i
215
+ # check to ensure the input is an array given that the attribute
216
+ # is documented as an array but the input is not
217
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
218
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
219
+ end
220
+ elsif !attributes[self.class.attribute_map[key]].nil?
221
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
222
+ end
223
+ end
224
+
225
+ self
226
+ end
227
+
228
+ # Deserializes the data based on type
229
+ # @param string type Data type
230
+ # @param string value Value to be deserialized
231
+ # @return [Object] Deserialized data
232
+ def _deserialize(type, value)
233
+ case type.to_sym
234
+ when :Time
235
+ Time.parse(value)
236
+ when :Date
237
+ Date.parse(value)
238
+ when :String
239
+ value.to_s
240
+ when :Integer
241
+ value.to_i
242
+ when :Float
243
+ value.to_f
244
+ when :Boolean
245
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
246
+ true
247
+ else
248
+ false
249
+ end
250
+ when :Object
251
+ # generic object (usually a Hash), return directly
252
+ value
253
+ when /\AArray<(?<inner_type>.+)>\z/
254
+ inner_type = Regexp.last_match[:inner_type]
255
+ value.map { |v| _deserialize(inner_type, v) }
256
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
257
+ k_type = Regexp.last_match[:k_type]
258
+ v_type = Regexp.last_match[:v_type]
259
+ {}.tap do |hash|
260
+ value.each do |k, v|
261
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
262
+ end
263
+ end
264
+ else # model
265
+ # models (e.g. Pet) or oneOf
266
+ klass = Plaid.const_get(type)
267
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
268
+ end
269
+ end
270
+
271
+ # Returns the string representation of the object
272
+ # @return [String] String presentation of the object
273
+ def to_s
274
+ to_hash.to_s
275
+ end
276
+
277
+ # to_body is an alias to to_hash (backward compatibility)
278
+ # @return [Hash] Returns the object in the form of hash
279
+ def to_body
280
+ to_hash
281
+ end
282
+
283
+ # Returns the object in the form of hash
284
+ # @return [Hash] Returns the object in the form of hash
285
+ def to_hash
286
+ hash = {}
287
+ self.class.attribute_map.each_pair do |attr, param|
288
+ value = self.send(attr)
289
+ if value.nil?
290
+ is_nullable = self.class.openapi_nullable.include?(attr)
291
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
292
+ end
293
+
294
+ hash[param] = _to_hash(value)
295
+ end
296
+ hash
297
+ end
298
+
299
+ # Outputs non-array value in the form of hash
300
+ # For object, use to_hash. Otherwise, just return the value
301
+ # @param [Object] value Any valid value
302
+ # @return [Hash] Returns the value in the form of hash
303
+ def _to_hash(value)
304
+ if value.is_a?(Array)
305
+ value.compact.map { |v| _to_hash(v) }
306
+ elsif value.is_a?(Hash)
307
+ {}.tap do |hash|
308
+ value.each { |k, v| hash[k] = _to_hash(v) }
309
+ end
310
+ elsif value.respond_to? :to_hash
311
+ value.to_hash
312
+ else
313
+ value
314
+ end
315
+ end
316
+
317
+ end
318
+
319
+ end