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,265 @@
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
+ # The user's legal name
18
+ class SignalPersonName
19
+ # The user's name prefix (e.g. \"Mr.\")
20
+ attr_accessor :prefix
21
+
22
+ # The user's given name. If the user has a one-word name, it should be provided in this field.
23
+ attr_accessor :given_name
24
+
25
+ # The user's middle name
26
+ attr_accessor :middle_name
27
+
28
+ # The user's family name / surname
29
+ attr_accessor :family_name
30
+
31
+ # The user's name suffix (e.g. \"II\")
32
+ attr_accessor :suffix
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'prefix' => :'prefix',
38
+ :'given_name' => :'given_name',
39
+ :'middle_name' => :'middle_name',
40
+ :'family_name' => :'family_name',
41
+ :'suffix' => :'suffix'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'prefix' => :'String',
54
+ :'given_name' => :'String',
55
+ :'middle_name' => :'String',
56
+ :'family_name' => :'String',
57
+ :'suffix' => :'String'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'prefix',
65
+ :'given_name',
66
+ :'middle_name',
67
+ :'family_name',
68
+ :'suffix'
69
+ ])
70
+ end
71
+
72
+ # Initializes the object
73
+ # @param [Hash] attributes Model attributes in the form of hash
74
+ def initialize(attributes = {})
75
+ if (!attributes.is_a?(Hash))
76
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SignalPersonName` initialize method"
77
+ end
78
+
79
+ # check to see if the attribute exists and convert string to symbol for hash key
80
+ attributes = attributes.each_with_object({}) { |(k, v), h|
81
+ if (!self.class.attribute_map.key?(k.to_sym))
82
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::SignalPersonName`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
83
+ end
84
+ h[k.to_sym] = v
85
+ }
86
+
87
+ if attributes.key?(:'prefix')
88
+ self.prefix = attributes[:'prefix']
89
+ end
90
+
91
+ if attributes.key?(:'given_name')
92
+ self.given_name = attributes[:'given_name']
93
+ end
94
+
95
+ if attributes.key?(:'middle_name')
96
+ self.middle_name = attributes[:'middle_name']
97
+ end
98
+
99
+ if attributes.key?(:'family_name')
100
+ self.family_name = attributes[:'family_name']
101
+ end
102
+
103
+ if attributes.key?(:'suffix')
104
+ self.suffix = attributes[:'suffix']
105
+ end
106
+ end
107
+
108
+ # Show invalid properties with the reasons. Usually used together with valid?
109
+ # @return Array for valid properties with the reasons
110
+ def list_invalid_properties
111
+ invalid_properties = Array.new
112
+ invalid_properties
113
+ end
114
+
115
+ # Check to see if the all the properties in the model are valid
116
+ # @return true if the model is valid
117
+ def valid?
118
+ true
119
+ end
120
+
121
+ # Checks equality by comparing each attribute.
122
+ # @param [Object] Object to be compared
123
+ def ==(o)
124
+ return true if self.equal?(o)
125
+ self.class == o.class &&
126
+ prefix == o.prefix &&
127
+ given_name == o.given_name &&
128
+ middle_name == o.middle_name &&
129
+ family_name == o.family_name &&
130
+ suffix == o.suffix
131
+ end
132
+
133
+ # @see the `==` method
134
+ # @param [Object] Object to be compared
135
+ def eql?(o)
136
+ self == o
137
+ end
138
+
139
+ # Calculates hash code according to all attributes.
140
+ # @return [Integer] Hash code
141
+ def hash
142
+ [prefix, given_name, middle_name, family_name, suffix].hash
143
+ end
144
+
145
+ # Builds the object from hash
146
+ # @param [Hash] attributes Model attributes in the form of hash
147
+ # @return [Object] Returns the model itself
148
+ def self.build_from_hash(attributes)
149
+ new.build_from_hash(attributes)
150
+ end
151
+
152
+ # Builds the object from hash
153
+ # @param [Hash] attributes Model attributes in the form of hash
154
+ # @return [Object] Returns the model itself
155
+ def build_from_hash(attributes)
156
+ return nil unless attributes.is_a?(Hash)
157
+ self.class.openapi_types.each_pair do |key, type|
158
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
159
+ self.send("#{key}=", nil)
160
+ elsif type =~ /\AArray<(.*)>/i
161
+ # check to ensure the input is an array given that the attribute
162
+ # is documented as an array but the input is not
163
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
164
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
165
+ end
166
+ elsif !attributes[self.class.attribute_map[key]].nil?
167
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
168
+ end
169
+ end
170
+
171
+ self
172
+ end
173
+
174
+ # Deserializes the data based on type
175
+ # @param string type Data type
176
+ # @param string value Value to be deserialized
177
+ # @return [Object] Deserialized data
178
+ def _deserialize(type, value)
179
+ case type.to_sym
180
+ when :Time
181
+ Time.parse(value)
182
+ when :Date
183
+ Date.parse(value)
184
+ when :String
185
+ value.to_s
186
+ when :Integer
187
+ value.to_i
188
+ when :Float
189
+ value.to_f
190
+ when :Boolean
191
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
192
+ true
193
+ else
194
+ false
195
+ end
196
+ when :Object
197
+ # generic object (usually a Hash), return directly
198
+ value
199
+ when /\AArray<(?<inner_type>.+)>\z/
200
+ inner_type = Regexp.last_match[:inner_type]
201
+ value.map { |v| _deserialize(inner_type, v) }
202
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
203
+ k_type = Regexp.last_match[:k_type]
204
+ v_type = Regexp.last_match[:v_type]
205
+ {}.tap do |hash|
206
+ value.each do |k, v|
207
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
208
+ end
209
+ end
210
+ else # model
211
+ # models (e.g. Pet) or oneOf
212
+ klass = Plaid.const_get(type)
213
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
214
+ end
215
+ end
216
+
217
+ # Returns the string representation of the object
218
+ # @return [String] String presentation of the object
219
+ def to_s
220
+ to_hash.to_s
221
+ end
222
+
223
+ # to_body is an alias to to_hash (backward compatibility)
224
+ # @return [Hash] Returns the object in the form of hash
225
+ def to_body
226
+ to_hash
227
+ end
228
+
229
+ # Returns the object in the form of hash
230
+ # @return [Hash] Returns the object in the form of hash
231
+ def to_hash
232
+ hash = {}
233
+ self.class.attribute_map.each_pair do |attr, param|
234
+ value = self.send(attr)
235
+ if value.nil?
236
+ is_nullable = self.class.openapi_nullable.include?(attr)
237
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
238
+ end
239
+
240
+ hash[param] = _to_hash(value)
241
+ end
242
+ hash
243
+ end
244
+
245
+ # Outputs non-array value in the form of hash
246
+ # For object, use to_hash. Otherwise, just return the value
247
+ # @param [Object] value Any valid value
248
+ # @return [Hash] Returns the value in the form of hash
249
+ def _to_hash(value)
250
+ if value.is_a?(Array)
251
+ value.compact.map { |v| _to_hash(v) }
252
+ elsif value.is_a?(Hash)
253
+ {}.tap do |hash|
254
+ value.each { |k, v| hash[k] = _to_hash(v) }
255
+ end
256
+ elsif value.respond_to? :to_hash
257
+ value.to_hash
258
+ else
259
+ value
260
+ end
261
+ end
262
+
263
+ end
264
+
265
+ end
@@ -0,0 +1,259 @@
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
+ class SignalReturnReportRequest
18
+ # 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.
19
+ attr_accessor :client_id
20
+
21
+ # 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.
22
+ attr_accessor :secret
23
+
24
+ # Must be the same as the `client_transaction_id` supplied when calling `/signal/evaluate`
25
+ attr_accessor :client_transaction_id
26
+
27
+ # Must be a valid ACH return code (e.g. \"R01\")
28
+ attr_accessor :return_code
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'client_id' => :'client_id',
34
+ :'secret' => :'secret',
35
+ :'client_transaction_id' => :'client_transaction_id',
36
+ :'return_code' => :'return_code'
37
+ }
38
+ end
39
+
40
+ # Returns all the JSON keys this model knows about
41
+ def self.acceptable_attributes
42
+ attribute_map.values
43
+ end
44
+
45
+ # Attribute type mapping.
46
+ def self.openapi_types
47
+ {
48
+ :'client_id' => :'String',
49
+ :'secret' => :'String',
50
+ :'client_transaction_id' => :'String',
51
+ :'return_code' => :'String'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ if (!attributes.is_a?(Hash))
65
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SignalReturnReportRequest` initialize method"
66
+ end
67
+
68
+ # check to see if the attribute exists and convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}) { |(k, v), h|
70
+ if (!self.class.attribute_map.key?(k.to_sym))
71
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::SignalReturnReportRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
+ end
73
+ h[k.to_sym] = v
74
+ }
75
+
76
+ if attributes.key?(:'client_id')
77
+ self.client_id = attributes[:'client_id']
78
+ end
79
+
80
+ if attributes.key?(:'secret')
81
+ self.secret = attributes[:'secret']
82
+ end
83
+
84
+ if attributes.key?(:'client_transaction_id')
85
+ self.client_transaction_id = attributes[:'client_transaction_id']
86
+ end
87
+
88
+ if attributes.key?(:'return_code')
89
+ self.return_code = attributes[:'return_code']
90
+ end
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properties with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+ if @client_transaction_id.nil?
98
+ invalid_properties.push('invalid value for "client_transaction_id", client_transaction_id cannot be nil.')
99
+ end
100
+
101
+ if @return_code.nil?
102
+ invalid_properties.push('invalid value for "return_code", return_code cannot be nil.')
103
+ end
104
+
105
+ invalid_properties
106
+ end
107
+
108
+ # Check to see if the all the properties in the model are valid
109
+ # @return true if the model is valid
110
+ def valid?
111
+ return false if @client_transaction_id.nil?
112
+ return false if @return_code.nil?
113
+ true
114
+ end
115
+
116
+ # Checks equality by comparing each attribute.
117
+ # @param [Object] Object to be compared
118
+ def ==(o)
119
+ return true if self.equal?(o)
120
+ self.class == o.class &&
121
+ client_id == o.client_id &&
122
+ secret == o.secret &&
123
+ client_transaction_id == o.client_transaction_id &&
124
+ return_code == o.return_code
125
+ end
126
+
127
+ # @see the `==` method
128
+ # @param [Object] Object to be compared
129
+ def eql?(o)
130
+ self == o
131
+ end
132
+
133
+ # Calculates hash code according to all attributes.
134
+ # @return [Integer] Hash code
135
+ def hash
136
+ [client_id, secret, client_transaction_id, return_code].hash
137
+ end
138
+
139
+ # Builds the object from hash
140
+ # @param [Hash] attributes Model attributes in the form of hash
141
+ # @return [Object] Returns the model itself
142
+ def self.build_from_hash(attributes)
143
+ new.build_from_hash(attributes)
144
+ end
145
+
146
+ # Builds the object from hash
147
+ # @param [Hash] attributes Model attributes in the form of hash
148
+ # @return [Object] Returns the model itself
149
+ def build_from_hash(attributes)
150
+ return nil unless attributes.is_a?(Hash)
151
+ self.class.openapi_types.each_pair do |key, type|
152
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
153
+ self.send("#{key}=", nil)
154
+ elsif type =~ /\AArray<(.*)>/i
155
+ # check to ensure the input is an array given that the attribute
156
+ # is documented as an array but the input is not
157
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
158
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
159
+ end
160
+ elsif !attributes[self.class.attribute_map[key]].nil?
161
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
162
+ end
163
+ end
164
+
165
+ self
166
+ end
167
+
168
+ # Deserializes the data based on type
169
+ # @param string type Data type
170
+ # @param string value Value to be deserialized
171
+ # @return [Object] Deserialized data
172
+ def _deserialize(type, value)
173
+ case type.to_sym
174
+ when :Time
175
+ Time.parse(value)
176
+ when :Date
177
+ Date.parse(value)
178
+ when :String
179
+ value.to_s
180
+ when :Integer
181
+ value.to_i
182
+ when :Float
183
+ value.to_f
184
+ when :Boolean
185
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
186
+ true
187
+ else
188
+ false
189
+ end
190
+ when :Object
191
+ # generic object (usually a Hash), return directly
192
+ value
193
+ when /\AArray<(?<inner_type>.+)>\z/
194
+ inner_type = Regexp.last_match[:inner_type]
195
+ value.map { |v| _deserialize(inner_type, v) }
196
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
197
+ k_type = Regexp.last_match[:k_type]
198
+ v_type = Regexp.last_match[:v_type]
199
+ {}.tap do |hash|
200
+ value.each do |k, v|
201
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
202
+ end
203
+ end
204
+ else # model
205
+ # models (e.g. Pet) or oneOf
206
+ klass = Plaid.const_get(type)
207
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
208
+ end
209
+ end
210
+
211
+ # Returns the string representation of the object
212
+ # @return [String] String presentation of the object
213
+ def to_s
214
+ to_hash.to_s
215
+ end
216
+
217
+ # to_body is an alias to to_hash (backward compatibility)
218
+ # @return [Hash] Returns the object in the form of hash
219
+ def to_body
220
+ to_hash
221
+ end
222
+
223
+ # Returns the object in the form of hash
224
+ # @return [Hash] Returns the object in the form of hash
225
+ def to_hash
226
+ hash = {}
227
+ self.class.attribute_map.each_pair do |attr, param|
228
+ value = self.send(attr)
229
+ if value.nil?
230
+ is_nullable = self.class.openapi_nullable.include?(attr)
231
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
232
+ end
233
+
234
+ hash[param] = _to_hash(value)
235
+ end
236
+ hash
237
+ end
238
+
239
+ # Outputs non-array value in the form of hash
240
+ # For object, use to_hash. Otherwise, just return the value
241
+ # @param [Object] value Any valid value
242
+ # @return [Hash] Returns the value in the form of hash
243
+ def _to_hash(value)
244
+ if value.is_a?(Array)
245
+ value.compact.map { |v| _to_hash(v) }
246
+ elsif value.is_a?(Hash)
247
+ {}.tap do |hash|
248
+ value.each { |k, v| hash[k] = _to_hash(v) }
249
+ end
250
+ elsif value.respond_to? :to_hash
251
+ value.to_hash
252
+ else
253
+ value
254
+ end
255
+ end
256
+
257
+ end
258
+
259
+ end