plaid 14.0.0.beta.5 → 14.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (387) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/CONTRIBUTING.md +1 -5
  4. data/Gemfile.lock +14 -4
  5. data/Makefile +1 -1
  6. data/README.md +5 -4
  7. data/doc/rdoc/.DS_Store +0 -0
  8. data/lib/plaid.rb +59 -13
  9. data/lib/plaid/.DS_Store +0 -0
  10. data/lib/plaid/api/plaid_api.rb +644 -61
  11. data/lib/plaid/api_client.rb +3 -2
  12. data/lib/plaid/api_error.rb +1 -1
  13. data/lib/plaid/configuration.rb +1 -1
  14. data/lib/plaid/models/account_access.rb +238 -0
  15. data/lib/plaid/models/account_assets.rb +16 -5
  16. data/lib/plaid/models/account_assets_all_of.rb +16 -4
  17. data/lib/plaid/models/account_balance.rb +6 -10
  18. data/lib/plaid/models/account_base.rb +1 -2
  19. data/lib/plaid/models/account_filter.rb +258 -0
  20. data/lib/plaid/models/account_filters_response.rb +1 -1
  21. data/lib/plaid/models/account_identity.rb +1 -2
  22. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  23. data/lib/plaid/models/account_selection_cardinality.rb +38 -0
  24. data/lib/plaid/models/account_subtype.rb +5 -1
  25. data/lib/plaid/models/account_type.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  30. data/lib/plaid/models/accounts_get_response.rb +1 -1
  31. data/lib/plaid/models/ach_class.rb +1 -1
  32. data/lib/plaid/models/address.rb +1 -2
  33. data/lib/plaid/models/address_data.rb +2 -6
  34. data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +5 -9
  35. data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +4 -5
  36. data/lib/plaid/models/application.rb +17 -2
  37. data/lib/plaid/models/application_get_request.rb +1 -1
  38. data/lib/plaid/models/application_get_response.rb +1 -1
  39. data/lib/plaid/models/apr.rb +1 -1
  40. data/lib/plaid/models/asset_report.rb +2 -2
  41. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  42. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  43. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  44. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  45. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  46. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  47. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  48. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  49. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  50. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  51. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  53. data/lib/plaid/models/asset_report_item.rb +2 -2
  54. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  56. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  57. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  60. data/lib/plaid/models/asset_report_transaction.rb +108 -187
  61. data/lib/plaid/models/asset_report_transaction_all_of.rb +6 -21
  62. data/lib/plaid/models/asset_report_user.rb +2 -2
  63. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  64. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  65. data/lib/plaid/models/auth_get_numbers.rb +21 -1
  66. data/lib/plaid/models/auth_get_request.rb +1 -1
  67. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  68. data/lib/plaid/models/auth_get_response.rb +1 -1
  69. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  70. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  71. data/lib/plaid/models/bank_transfer.rb +2 -2
  72. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  73. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  74. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  75. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  76. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  77. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  78. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  79. data/lib/plaid/models/bank_transfer_direction.rb +2 -1
  80. data/lib/plaid/models/bank_transfer_event.rb +2 -2
  81. data/lib/plaid/models/bank_transfer_event_list_request.rb +16 -4
  82. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  83. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  84. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  85. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  86. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  88. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  89. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  90. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  91. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  92. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  93. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_receiver_details.rb +3 -3
  95. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  98. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  99. data/lib/plaid/models/categories_get_response.rb +1 -1
  100. data/lib/plaid/models/category.rb +1 -1
  101. data/lib/plaid/models/cause.rb +1 -1
  102. data/lib/plaid/models/connected_application.rb +357 -0
  103. data/lib/plaid/models/country_code.rb +1 -1
  104. data/lib/plaid/models/credit_card_liability.rb +5 -9
  105. data/lib/plaid/models/credit_filter.rb +2 -2
  106. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  107. data/lib/plaid/models/default_update_webhook.rb +1 -1
  108. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  109. data/lib/plaid/models/deposit_switch_alt_create_request.rb +59 -5
  110. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  111. data/lib/plaid/models/deposit_switch_create_request.rb +59 -5
  112. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  113. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  114. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  115. data/lib/plaid/models/deposit_switch_get_response.rb +74 -7
  116. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
  117. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  118. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  119. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  120. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  121. data/lib/plaid/models/depository_filter.rb +2 -2
  122. data/lib/plaid/models/email.rb +1 -1
  123. data/lib/plaid/models/employee.rb +6 -17
  124. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  125. data/lib/plaid/models/employer.rb +7 -3
  126. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  127. data/lib/plaid/models/employers_search_request.rb +1 -1
  128. data/lib/plaid/models/employers_search_response.rb +1 -1
  129. data/lib/plaid/models/error.rb +2 -9
  130. data/lib/plaid/models/external_payment_options.rb +61 -7
  131. data/lib/plaid/models/external_payment_refund_details.rb +7 -2
  132. data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +21 -25
  133. data/lib/plaid/models/external_payment_schedule_get.rb +19 -19
  134. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  135. data/lib/plaid/models/health_incident.rb +18 -5
  136. data/lib/plaid/models/historical_balance.rb +3 -3
  137. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  138. data/lib/plaid/models/holding.rb +3 -3
  139. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  140. data/lib/plaid/models/identity_get_request.rb +1 -1
  141. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  142. data/lib/plaid/models/identity_get_response.rb +1 -1
  143. data/lib/plaid/models/incident_update.rb +4 -4
  144. data/lib/plaid/models/income_breakdown.rb +36 -2
  145. data/lib/plaid/models/income_summary.rb +26 -1
  146. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  147. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  148. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  149. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  150. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  151. data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
  152. data/lib/plaid/models/{income_verification_paystub_get_request.rb → income_verification_paystubs_get_request.rb} +5 -5
  153. data/lib/plaid/models/income_verification_paystubs_get_response.rb +241 -0
  154. data/lib/plaid/models/income_verification_refresh_request.rb +245 -0
  155. data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
  156. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  157. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  158. data/lib/plaid/models/income_verification_summary_get_response.rb +12 -2
  159. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  160. data/lib/plaid/models/inflow_model.rb +1 -1
  161. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  162. data/lib/plaid/models/institution.rb +2 -2
  163. data/lib/plaid/models/institution_status.rb +30 -3
  164. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  165. data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
  166. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  167. data/lib/plaid/models/institutions_get_request.rb +1 -1
  168. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  169. data/lib/plaid/models/institutions_get_response.rb +1 -1
  170. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  171. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  172. data/lib/plaid/models/institutions_search_request.rb +2 -2
  173. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  174. data/lib/plaid/models/institutions_search_response.rb +1 -1
  175. data/lib/plaid/models/investment_filter.rb +2 -2
  176. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  177. data/lib/plaid/models/investment_transaction.rb +5 -5
  178. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  179. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  180. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  181. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  182. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  183. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  184. data/lib/plaid/models/item.rb +5 -5
  185. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  186. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  187. data/lib/plaid/models/item_application_list_request.rb +241 -0
  188. data/lib/plaid/models/item_application_list_response.rb +237 -0
  189. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  190. data/lib/plaid/models/item_application_scopes_update_request.rb +274 -0
  191. data/lib/plaid/models/{income_verification_paystub_get_response.rb → item_application_scopes_update_response.rb} +11 -15
  192. data/lib/plaid/models/item_error_webhook.rb +1 -1
  193. data/lib/plaid/models/item_get_request.rb +1 -1
  194. data/lib/plaid/models/item_get_response.rb +2 -2
  195. data/lib/plaid/models/item_import_request.rb +1 -1
  196. data/lib/plaid/models/item_import_request_options.rb +1 -1
  197. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  198. data/lib/plaid/models/item_import_response.rb +1 -1
  199. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  200. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  201. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  202. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  203. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  204. data/lib/plaid/models/item_remove_request.rb +1 -1
  205. data/lib/plaid/models/item_remove_response.rb +1 -1
  206. data/lib/plaid/models/item_status.rb +7 -16
  207. data/lib/plaid/models/item_status_investments.rb +232 -0
  208. data/lib/plaid/models/{nullable_recipient_bacs.rb → item_status_last_webhook.rb} +22 -26
  209. data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +10 -19
  210. data/lib/plaid/models/item_status_transactions.rb +232 -0
  211. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  212. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  213. data/lib/plaid/models/jwk_public_key.rb +1 -1
  214. data/lib/plaid/models/jwt_header.rb +1 -1
  215. data/lib/plaid/models/liabilities_default_update_webhook.rb +27 -2
  216. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  217. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  218. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  219. data/lib/plaid/models/liabilities_object.rb +4 -4
  220. data/lib/plaid/models/liability_override.rb +3 -3
  221. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  222. data/lib/plaid/models/link_token_create_request.rb +12 -3
  223. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  224. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  225. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  226. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -3
  227. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +22 -1
  228. data/lib/plaid/models/link_token_create_request_user.rb +8 -8
  229. data/lib/plaid/models/link_token_create_response.rb +1 -1
  230. data/lib/plaid/models/link_token_eu_config.rb +220 -0
  231. data/lib/plaid/models/link_token_get_metadata_response.rb +11 -1
  232. data/lib/plaid/models/link_token_get_request.rb +1 -1
  233. data/lib/plaid/models/link_token_get_response.rb +11 -1
  234. data/lib/plaid/models/loan_filter.rb +2 -2
  235. data/lib/plaid/models/location.rb +1 -1
  236. data/lib/plaid/models/meta.rb +1 -1
  237. data/lib/plaid/models/mfa.rb +1 -1
  238. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  239. data/lib/plaid/models/mortgage_liability.rb +20 -6
  240. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  241. data/lib/plaid/models/numbers.rb +1 -41
  242. data/lib/plaid/models/numbers_ach.rb +2 -2
  243. data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +5 -5
  244. data/lib/plaid/models/numbers_bacs.rb +1 -1
  245. data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +4 -4
  246. data/lib/plaid/models/numbers_eft.rb +1 -1
  247. data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +4 -4
  248. data/lib/plaid/models/numbers_international.rb +1 -1
  249. data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +4 -4
  250. data/lib/plaid/models/override_account_type.rb +40 -0
  251. data/lib/plaid/models/override_accounts.rb +2 -2
  252. data/lib/plaid/models/owner.rb +1 -1
  253. data/lib/plaid/models/owner_override.rb +1 -1
  254. data/lib/plaid/models/pay_frequency.rb +1 -1
  255. data/lib/plaid/models/pay_period_details.rb +4 -4
  256. data/lib/plaid/models/payment_amount.rb +12 -1
  257. data/lib/plaid/models/payment_initiation_address.rb +118 -4
  258. data/lib/plaid/models/payment_initiation_metadata.rb +16 -1
  259. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +53 -1
  260. data/lib/plaid/models/payment_initiation_payment.rb +20 -2
  261. data/lib/plaid/models/payment_initiation_payment_create_request.rb +53 -3
  262. data/lib/plaid/models/payment_initiation_payment_create_response.rb +35 -1
  263. data/lib/plaid/models/payment_initiation_payment_get_request.rb +22 -1
  264. data/lib/plaid/models/payment_initiation_payment_get_response.rb +20 -2
  265. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -18
  266. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  267. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +22 -1
  268. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  269. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  270. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +49 -2
  271. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  272. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +22 -1
  273. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  274. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  275. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  276. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  277. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +16 -1
  278. data/lib/plaid/models/payment_meta.rb +1 -1
  279. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  280. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  281. data/lib/plaid/models/paystub.rb +3 -18
  282. data/lib/plaid/models/paystub_deduction.rb +1 -1
  283. data/lib/plaid/models/{nullable_access_token.rb → paystub_employer.rb} +17 -6
  284. data/lib/plaid/models/paystub_ytd_details.rb +2 -1
  285. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  286. data/lib/plaid/models/phone_number.rb +11 -3
  287. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  288. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  289. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  290. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  291. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  292. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  293. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  294. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  295. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  296. data/lib/plaid/models/processor_number.rb +5 -5
  297. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  298. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  299. data/lib/plaid/models/processor_token_create_request.rb +36 -2
  300. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  301. data/lib/plaid/models/product_access.rb +262 -0
  302. data/lib/plaid/models/product_status.rb +3 -3
  303. data/lib/plaid/models/product_status_breakdown.rb +1 -2
  304. data/lib/plaid/models/products.rb +2 -1
  305. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  306. data/lib/plaid/models/pslf_status.rb +2 -2
  307. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  308. data/lib/plaid/models/recipient_bacs.rb +53 -1
  309. data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
  310. data/lib/plaid/models/requested_scopes.rb +261 -0
  311. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  312. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  313. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  314. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  315. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
  316. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
  317. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  318. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  319. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  320. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  321. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  322. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  323. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  324. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  325. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  326. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  327. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  328. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  329. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +4 -4
  330. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  331. data/lib/plaid/models/scopes.rb +243 -0
  332. data/lib/plaid/models/scopes_nullable.rb +249 -0
  333. data/lib/plaid/models/security.rb +3 -3
  334. data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
  335. data/lib/plaid/models/servicer_address_data.rb +1 -1
  336. data/lib/plaid/models/signal_address_data.rb +263 -0
  337. data/lib/plaid/models/signal_decision_report_request.rb +259 -0
  338. data/lib/plaid/models/signal_decision_report_response.rb +224 -0
  339. data/lib/plaid/models/signal_device.rb +232 -0
  340. data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
  341. data/lib/plaid/models/signal_evaluate_request.rb +355 -0
  342. data/lib/plaid/models/signal_evaluate_response.rb +252 -0
  343. data/lib/plaid/models/signal_person_name.rb +265 -0
  344. data/lib/plaid/models/signal_return_report_request.rb +259 -0
  345. data/lib/plaid/models/signal_return_report_response.rb +224 -0
  346. data/lib/plaid/models/signal_scores.rb +227 -0
  347. data/lib/plaid/models/signal_user.rb +252 -0
  348. data/lib/plaid/models/standalone_account_type.rb +1 -1
  349. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  350. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +1 -1
  351. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  352. data/lib/plaid/models/student_loan.rb +27 -7
  353. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  354. data/lib/plaid/models/student_loan_status.rb +2 -2
  355. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  356. data/lib/plaid/models/transaction.rb +164 -124
  357. data/lib/plaid/models/transaction_all_of.rb +312 -0
  358. data/lib/plaid/models/transaction_base.rb +436 -0
  359. data/lib/plaid/models/transaction_code.rb +1 -1
  360. data/lib/plaid/models/transaction_data.rb +2 -2
  361. data/lib/plaid/models/transaction_override.rb +3 -3
  362. data/lib/plaid/models/transactions_get_request.rb +1 -1
  363. data/lib/plaid/models/transactions_get_request_options.rb +18 -5
  364. data/lib/plaid/models/transactions_get_response.rb +1 -1
  365. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  366. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  367. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  368. data/lib/plaid/models/user_custom_password.rb +1 -1
  369. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  370. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  371. data/lib/plaid/models/verification_refresh_status.rb +36 -0
  372. data/lib/plaid/models/verification_status.rb +1 -1
  373. data/lib/plaid/models/warning.rb +35 -1
  374. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  375. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  376. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  377. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  378. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  379. data/lib/plaid/version.rb +2 -2
  380. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  381. data/plaid.gemspec +1 -1
  382. data/templates/ruby/api_client.mustache +3 -1
  383. data/test/test_bank_transfers.rb +1 -1
  384. data/test/test_item.rb +0 -9
  385. data/test/test_payment_initiation.rb +1 -1
  386. data/test/test_processor.rb +1 -16
  387. metadata +65 -16
@@ -0,0 +1,232 @@
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.20.6
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
+ # User authentication parameters, for clients making a request without an `access_token`. This is only allowed for select clients and will not be supported in the future. Most clients should call /item/import to obtain an access token before making a request.
18
+ class ItemApplicationListUserAuth
19
+ # Account username.
20
+ attr_accessor :user_id
21
+
22
+ # Account username hashed by FI.
23
+ attr_accessor :fi_username_hash
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'user_id' => :'user_id',
29
+ :'fi_username_hash' => :'fi_username_hash'
30
+ }
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'user_id' => :'String',
42
+ :'fi_username_hash' => :'String'
43
+ }
44
+ end
45
+
46
+ # List of attributes with nullable: true
47
+ def self.openapi_nullable
48
+ Set.new([
49
+ :'user_id',
50
+ :'fi_username_hash'
51
+ ])
52
+ end
53
+
54
+ # Initializes the object
55
+ # @param [Hash] attributes Model attributes in the form of hash
56
+ def initialize(attributes = {})
57
+ if (!attributes.is_a?(Hash))
58
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ItemApplicationListUserAuth` initialize method"
59
+ end
60
+
61
+ # check to see if the attribute exists and convert string to symbol for hash key
62
+ attributes = attributes.each_with_object({}) { |(k, v), h|
63
+ if (!self.class.attribute_map.key?(k.to_sym))
64
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::ItemApplicationListUserAuth`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
65
+ end
66
+ h[k.to_sym] = v
67
+ }
68
+
69
+ if attributes.key?(:'user_id')
70
+ self.user_id = attributes[:'user_id']
71
+ end
72
+
73
+ if attributes.key?(:'fi_username_hash')
74
+ self.fi_username_hash = attributes[:'fi_username_hash']
75
+ end
76
+ end
77
+
78
+ # Show invalid properties with the reasons. Usually used together with valid?
79
+ # @return Array for valid properties with the reasons
80
+ def list_invalid_properties
81
+ invalid_properties = Array.new
82
+ invalid_properties
83
+ end
84
+
85
+ # Check to see if the all the properties in the model are valid
86
+ # @return true if the model is valid
87
+ def valid?
88
+ true
89
+ end
90
+
91
+ # Checks equality by comparing each attribute.
92
+ # @param [Object] Object to be compared
93
+ def ==(o)
94
+ return true if self.equal?(o)
95
+ self.class == o.class &&
96
+ user_id == o.user_id &&
97
+ fi_username_hash == o.fi_username_hash
98
+ end
99
+
100
+ # @see the `==` method
101
+ # @param [Object] Object to be compared
102
+ def eql?(o)
103
+ self == o
104
+ end
105
+
106
+ # Calculates hash code according to all attributes.
107
+ # @return [Integer] Hash code
108
+ def hash
109
+ [user_id, fi_username_hash].hash
110
+ end
111
+
112
+ # Builds the object from hash
113
+ # @param [Hash] attributes Model attributes in the form of hash
114
+ # @return [Object] Returns the model itself
115
+ def self.build_from_hash(attributes)
116
+ new.build_from_hash(attributes)
117
+ end
118
+
119
+ # Builds the object from hash
120
+ # @param [Hash] attributes Model attributes in the form of hash
121
+ # @return [Object] Returns the model itself
122
+ def build_from_hash(attributes)
123
+ return nil unless attributes.is_a?(Hash)
124
+ self.class.openapi_types.each_pair do |key, type|
125
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
126
+ self.send("#{key}=", nil)
127
+ elsif type =~ /\AArray<(.*)>/i
128
+ # check to ensure the input is an array given that the attribute
129
+ # is documented as an array but the input is not
130
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
131
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
132
+ end
133
+ elsif !attributes[self.class.attribute_map[key]].nil?
134
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
135
+ end
136
+ end
137
+
138
+ self
139
+ end
140
+
141
+ # Deserializes the data based on type
142
+ # @param string type Data type
143
+ # @param string value Value to be deserialized
144
+ # @return [Object] Deserialized data
145
+ def _deserialize(type, value)
146
+ case type.to_sym
147
+ when :Time
148
+ Time.parse(value)
149
+ when :Date
150
+ Date.parse(value)
151
+ when :String
152
+ value.to_s
153
+ when :Integer
154
+ value.to_i
155
+ when :Float
156
+ value.to_f
157
+ when :Boolean
158
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
159
+ true
160
+ else
161
+ false
162
+ end
163
+ when :Object
164
+ # generic object (usually a Hash), return directly
165
+ value
166
+ when /\AArray<(?<inner_type>.+)>\z/
167
+ inner_type = Regexp.last_match[:inner_type]
168
+ value.map { |v| _deserialize(inner_type, v) }
169
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
170
+ k_type = Regexp.last_match[:k_type]
171
+ v_type = Regexp.last_match[:v_type]
172
+ {}.tap do |hash|
173
+ value.each do |k, v|
174
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
175
+ end
176
+ end
177
+ else # model
178
+ # models (e.g. Pet) or oneOf
179
+ klass = Plaid.const_get(type)
180
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
181
+ end
182
+ end
183
+
184
+ # Returns the string representation of the object
185
+ # @return [String] String presentation of the object
186
+ def to_s
187
+ to_hash.to_s
188
+ end
189
+
190
+ # to_body is an alias to to_hash (backward compatibility)
191
+ # @return [Hash] Returns the object in the form of hash
192
+ def to_body
193
+ to_hash
194
+ end
195
+
196
+ # Returns the object in the form of hash
197
+ # @return [Hash] Returns the object in the form of hash
198
+ def to_hash
199
+ hash = {}
200
+ self.class.attribute_map.each_pair do |attr, param|
201
+ value = self.send(attr)
202
+ if value.nil?
203
+ is_nullable = self.class.openapi_nullable.include?(attr)
204
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
205
+ end
206
+
207
+ hash[param] = _to_hash(value)
208
+ end
209
+ hash
210
+ end
211
+
212
+ # Outputs non-array value in the form of hash
213
+ # For object, use to_hash. Otherwise, just return the value
214
+ # @param [Object] value Any valid value
215
+ # @return [Hash] Returns the value in the form of hash
216
+ def _to_hash(value)
217
+ if value.is_a?(Array)
218
+ value.compact.map { |v| _to_hash(v) }
219
+ elsif value.is_a?(Hash)
220
+ {}.tap do |hash|
221
+ value.each { |k, v| hash[k] = _to_hash(v) }
222
+ end
223
+ elsif value.respond_to? :to_hash
224
+ value.to_hash
225
+ else
226
+ value
227
+ end
228
+ end
229
+
230
+ end
231
+
232
+ end
@@ -0,0 +1,274 @@
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.20.6
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
+ # ItemApplicationScopesUpdateRequest defines the request schema for `/item/application/scopes/update`
18
+ class ItemApplicationScopesUpdateRequest
19
+ # 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.
20
+ attr_accessor :client_id
21
+
22
+ # 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.
23
+ attr_accessor :secret
24
+
25
+ # The access token associated with the Item data is being requested for.
26
+ attr_accessor :access_token
27
+
28
+ # This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.
29
+ attr_accessor :application_id
30
+
31
+ attr_accessor :scopes
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'client_id' => :'client_id',
37
+ :'secret' => :'secret',
38
+ :'access_token' => :'access_token',
39
+ :'application_id' => :'application_id',
40
+ :'scopes' => :'scopes'
41
+ }
42
+ end
43
+
44
+ # Returns all the JSON keys this model knows about
45
+ def self.acceptable_attributes
46
+ attribute_map.values
47
+ end
48
+
49
+ # Attribute type mapping.
50
+ def self.openapi_types
51
+ {
52
+ :'client_id' => :'String',
53
+ :'secret' => :'String',
54
+ :'access_token' => :'String',
55
+ :'application_id' => :'String',
56
+ :'scopes' => :'Scopes'
57
+ }
58
+ end
59
+
60
+ # List of attributes with nullable: true
61
+ def self.openapi_nullable
62
+ Set.new([
63
+ ])
64
+ end
65
+
66
+ # Initializes the object
67
+ # @param [Hash] attributes Model attributes in the form of hash
68
+ def initialize(attributes = {})
69
+ if (!attributes.is_a?(Hash))
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ItemApplicationScopesUpdateRequest` initialize method"
71
+ end
72
+
73
+ # check to see if the attribute exists and convert string to symbol for hash key
74
+ attributes = attributes.each_with_object({}) { |(k, v), h|
75
+ if (!self.class.attribute_map.key?(k.to_sym))
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::ItemApplicationScopesUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
+ end
78
+ h[k.to_sym] = v
79
+ }
80
+
81
+ if attributes.key?(:'client_id')
82
+ self.client_id = attributes[:'client_id']
83
+ end
84
+
85
+ if attributes.key?(:'secret')
86
+ self.secret = attributes[:'secret']
87
+ end
88
+
89
+ if attributes.key?(:'access_token')
90
+ self.access_token = attributes[:'access_token']
91
+ end
92
+
93
+ if attributes.key?(:'application_id')
94
+ self.application_id = attributes[:'application_id']
95
+ end
96
+
97
+ if attributes.key?(:'scopes')
98
+ self.scopes = attributes[:'scopes']
99
+ end
100
+ end
101
+
102
+ # Show invalid properties with the reasons. Usually used together with valid?
103
+ # @return Array for valid properties with the reasons
104
+ def list_invalid_properties
105
+ invalid_properties = Array.new
106
+ if @access_token.nil?
107
+ invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
108
+ end
109
+
110
+ if @application_id.nil?
111
+ invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
112
+ end
113
+
114
+ if @scopes.nil?
115
+ invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
116
+ end
117
+
118
+ invalid_properties
119
+ end
120
+
121
+ # Check to see if the all the properties in the model are valid
122
+ # @return true if the model is valid
123
+ def valid?
124
+ return false if @access_token.nil?
125
+ return false if @application_id.nil?
126
+ return false if @scopes.nil?
127
+ true
128
+ end
129
+
130
+ # Checks equality by comparing each attribute.
131
+ # @param [Object] Object to be compared
132
+ def ==(o)
133
+ return true if self.equal?(o)
134
+ self.class == o.class &&
135
+ client_id == o.client_id &&
136
+ secret == o.secret &&
137
+ access_token == o.access_token &&
138
+ application_id == o.application_id &&
139
+ scopes == o.scopes
140
+ end
141
+
142
+ # @see the `==` method
143
+ # @param [Object] Object to be compared
144
+ def eql?(o)
145
+ self == o
146
+ end
147
+
148
+ # Calculates hash code according to all attributes.
149
+ # @return [Integer] Hash code
150
+ def hash
151
+ [client_id, secret, access_token, application_id, scopes].hash
152
+ end
153
+
154
+ # Builds the object from hash
155
+ # @param [Hash] attributes Model attributes in the form of hash
156
+ # @return [Object] Returns the model itself
157
+ def self.build_from_hash(attributes)
158
+ new.build_from_hash(attributes)
159
+ end
160
+
161
+ # Builds the object from hash
162
+ # @param [Hash] attributes Model attributes in the form of hash
163
+ # @return [Object] Returns the model itself
164
+ def build_from_hash(attributes)
165
+ return nil unless attributes.is_a?(Hash)
166
+ self.class.openapi_types.each_pair do |key, type|
167
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
168
+ self.send("#{key}=", nil)
169
+ elsif type =~ /\AArray<(.*)>/i
170
+ # check to ensure the input is an array given that the attribute
171
+ # is documented as an array but the input is not
172
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
173
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
174
+ end
175
+ elsif !attributes[self.class.attribute_map[key]].nil?
176
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
177
+ end
178
+ end
179
+
180
+ self
181
+ end
182
+
183
+ # Deserializes the data based on type
184
+ # @param string type Data type
185
+ # @param string value Value to be deserialized
186
+ # @return [Object] Deserialized data
187
+ def _deserialize(type, value)
188
+ case type.to_sym
189
+ when :Time
190
+ Time.parse(value)
191
+ when :Date
192
+ Date.parse(value)
193
+ when :String
194
+ value.to_s
195
+ when :Integer
196
+ value.to_i
197
+ when :Float
198
+ value.to_f
199
+ when :Boolean
200
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
201
+ true
202
+ else
203
+ false
204
+ end
205
+ when :Object
206
+ # generic object (usually a Hash), return directly
207
+ value
208
+ when /\AArray<(?<inner_type>.+)>\z/
209
+ inner_type = Regexp.last_match[:inner_type]
210
+ value.map { |v| _deserialize(inner_type, v) }
211
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
212
+ k_type = Regexp.last_match[:k_type]
213
+ v_type = Regexp.last_match[:v_type]
214
+ {}.tap do |hash|
215
+ value.each do |k, v|
216
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
217
+ end
218
+ end
219
+ else # model
220
+ # models (e.g. Pet) or oneOf
221
+ klass = Plaid.const_get(type)
222
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
223
+ end
224
+ end
225
+
226
+ # Returns the string representation of the object
227
+ # @return [String] String presentation of the object
228
+ def to_s
229
+ to_hash.to_s
230
+ end
231
+
232
+ # to_body is an alias to to_hash (backward compatibility)
233
+ # @return [Hash] Returns the object in the form of hash
234
+ def to_body
235
+ to_hash
236
+ end
237
+
238
+ # Returns the object in the form of hash
239
+ # @return [Hash] Returns the object in the form of hash
240
+ def to_hash
241
+ hash = {}
242
+ self.class.attribute_map.each_pair do |attr, param|
243
+ value = self.send(attr)
244
+ if value.nil?
245
+ is_nullable = self.class.openapi_nullable.include?(attr)
246
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
247
+ end
248
+
249
+ hash[param] = _to_hash(value)
250
+ end
251
+ hash
252
+ end
253
+
254
+ # Outputs non-array value in the form of hash
255
+ # For object, use to_hash. Otherwise, just return the value
256
+ # @param [Object] value Any valid value
257
+ # @return [Hash] Returns the value in the form of hash
258
+ def _to_hash(value)
259
+ if value.is_a?(Array)
260
+ value.compact.map { |v| _to_hash(v) }
261
+ elsif value.is_a?(Hash)
262
+ {}.tap do |hash|
263
+ value.each { |k, v| hash[k] = _to_hash(v) }
264
+ end
265
+ elsif value.respond_to? :to_hash
266
+ value.to_hash
267
+ else
268
+ value
269
+ end
270
+ end
271
+
272
+ end
273
+
274
+ end