plaid 15.1.0 → 15.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (654) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +84 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/README.md +1 -1
  6. data/lib/plaid/api/plaid_api.rb +355 -30
  7. data/lib/plaid/api_client.rb +3 -3
  8. data/lib/plaid/api_error.rb +2 -2
  9. data/lib/plaid/configuration.rb +2 -2
  10. data/lib/plaid/models/account_access.rb +2 -2
  11. data/lib/plaid/models/account_assets.rb +2 -2
  12. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  13. data/lib/plaid/models/account_balance.rb +2 -2
  14. data/lib/plaid/models/account_base.rb +2 -2
  15. data/lib/plaid/models/account_filter.rb +2 -2
  16. data/lib/plaid/models/account_filters_response.rb +2 -2
  17. data/lib/plaid/models/account_identity.rb +2 -2
  18. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  19. data/lib/plaid/models/account_product_access.rb +2 -2
  20. data/lib/plaid/models/account_product_access_nullable.rb +2 -2
  21. data/lib/plaid/models/account_selection_cardinality.rb +2 -2
  22. data/lib/plaid/models/account_subtype.rb +2 -2
  23. data/lib/plaid/models/account_type.rb +2 -2
  24. data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
  25. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  26. data/lib/plaid/models/accounts_get_request.rb +2 -2
  27. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  28. data/lib/plaid/models/accounts_get_response.rb +2 -2
  29. data/lib/plaid/models/ach_class.rb +2 -2
  30. data/lib/plaid/models/address.rb +2 -2
  31. data/lib/plaid/models/address_data.rb +2 -2
  32. data/lib/plaid/models/address_data_nullable.rb +2 -2
  33. data/lib/plaid/models/address_nullable.rb +2 -2
  34. data/lib/plaid/models/application.rb +73 -7
  35. data/lib/plaid/models/application_get_request.rb +2 -2
  36. data/lib/plaid/models/application_get_response.rb +2 -2
  37. data/lib/plaid/models/apr.rb +2 -2
  38. data/lib/plaid/models/asset_report.rb +2 -2
  39. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
  40. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  41. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +2 -2
  42. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +2 -2
  43. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  44. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  45. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  46. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  47. data/lib/plaid/models/asset_report_filter_request.rb +2 -2
  48. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  49. data/lib/plaid/models/asset_report_get_request.rb +2 -2
  50. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  51. data/lib/plaid/models/asset_report_item.rb +2 -2
  52. data/lib/plaid/models/asset_report_pdf_get_request.rb +2 -2
  53. data/lib/plaid/models/asset_report_refresh_request.rb +2 -2
  54. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  55. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  56. data/lib/plaid/models/asset_report_relay_create_request.rb +2 -2
  57. data/lib/plaid/models/asset_report_relay_create_response.rb +2 -2
  58. data/lib/plaid/models/asset_report_relay_get_request.rb +2 -2
  59. data/lib/plaid/models/asset_report_relay_refresh_request.rb +2 -2
  60. data/lib/plaid/models/asset_report_relay_refresh_response.rb +2 -2
  61. data/lib/plaid/models/asset_report_relay_remove_request.rb +2 -2
  62. data/lib/plaid/models/asset_report_relay_remove_response.rb +2 -2
  63. data/lib/plaid/models/asset_report_remove_request.rb +2 -2
  64. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  65. data/lib/plaid/models/asset_report_transaction.rb +2 -2
  66. data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
  67. data/lib/plaid/models/asset_report_user.rb +2 -2
  68. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  69. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  70. data/lib/plaid/models/assets_relay_webhook.rb +2 -2
  71. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  72. data/lib/plaid/models/auth_get_request.rb +2 -2
  73. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  74. data/lib/plaid/models/auth_get_response.rb +2 -2
  75. data/lib/plaid/models/auth_metadata.rb +2 -2
  76. data/lib/plaid/models/auth_supported_methods.rb +2 -2
  77. data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
  78. data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
  79. data/lib/plaid/models/bank_transfer.rb +2 -2
  80. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  81. data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
  82. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  83. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  84. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_create_request.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_event.rb +2 -2
  89. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +2 -2
  90. data/lib/plaid/models/bank_transfer_event_list_direction.rb +2 -2
  91. data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
  92. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  93. data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
  94. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  95. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  96. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  97. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  98. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  99. data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
  100. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  101. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +13 -3
  102. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  103. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  104. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  105. data/lib/plaid/models/bank_transfer_sweep.rb +2 -2
  106. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
  107. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +2 -2
  108. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -2
  109. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +2 -2
  110. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  111. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  112. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +2 -2
  113. data/lib/plaid/models/categories_get_response.rb +2 -2
  114. data/lib/plaid/models/category.rb +2 -2
  115. data/lib/plaid/models/cause.rb +156 -19
  116. data/lib/plaid/models/cause_all_of.rb +219 -0
  117. data/lib/plaid/models/client_provided_enhanced_transaction.rb +2 -2
  118. data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
  119. data/lib/plaid/models/connected_application.rb +7 -95
  120. data/lib/plaid/models/country_code.rb +2 -2
  121. data/lib/plaid/models/credit_account_subtype.rb +2 -2
  122. data/lib/plaid/models/credit_bank_income.rb +2 -2
  123. data/lib/plaid/models/credit_bank_income_account.rb +2 -2
  124. data/lib/plaid/models/credit_bank_income_account_type.rb +2 -2
  125. data/lib/plaid/models/credit_bank_income_category.rb +2 -2
  126. data/lib/plaid/models/credit_bank_income_cause.rb +2 -2
  127. data/lib/plaid/models/credit_bank_income_error_type.rb +2 -2
  128. data/lib/plaid/models/credit_bank_income_get_request.rb +2 -2
  129. data/lib/plaid/models/credit_bank_income_get_request_options.rb +2 -2
  130. data/lib/plaid/models/credit_bank_income_get_response.rb +2 -2
  131. data/lib/plaid/models/credit_bank_income_historical_summary.rb +2 -2
  132. data/lib/plaid/models/credit_bank_income_item.rb +2 -2
  133. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +2 -2
  134. data/lib/plaid/models/credit_bank_income_source.rb +2 -2
  135. data/lib/plaid/models/credit_bank_income_summary.rb +2 -2
  136. data/lib/plaid/models/credit_bank_income_transaction.rb +2 -2
  137. data/lib/plaid/models/credit_bank_income_warning.rb +2 -2
  138. data/lib/plaid/models/credit_bank_income_warning_code.rb +3 -2
  139. data/lib/plaid/models/credit_bank_income_warning_type.rb +2 -2
  140. data/lib/plaid/models/credit_card_liability.rb +2 -2
  141. data/lib/plaid/models/credit_document_metadata.rb +258 -0
  142. data/lib/plaid/models/credit_employer_verification.rb +221 -0
  143. data/lib/plaid/models/credit_employment_get_request.rb +245 -0
  144. data/lib/plaid/models/credit_employment_get_response.rb +242 -0
  145. data/lib/plaid/models/credit_employment_verification.rb +282 -0
  146. data/lib/plaid/models/credit_filter.rb +2 -2
  147. data/lib/plaid/models/credit_payroll_income_get_request.rb +240 -0
  148. data/lib/plaid/models/credit_payroll_income_get_response.rb +261 -0
  149. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +272 -0
  150. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +239 -0
  151. data/lib/plaid/models/credit_platform_ids.rb +243 -0
  152. data/lib/plaid/models/credit_w2.rb +486 -0
  153. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  154. data/lib/plaid/models/deductions.rb +2 -2
  155. data/lib/plaid/models/deductions_breakdown.rb +2 -2
  156. data/lib/plaid/models/deductions_total.rb +2 -2
  157. data/lib/plaid/models/default_update_webhook.rb +2 -2
  158. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  159. data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
  160. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  161. data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
  162. data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
  163. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  164. data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
  165. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  166. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +2 -2
  167. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  168. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  169. data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
  170. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  171. data/lib/plaid/models/depository_account_subtype.rb +2 -2
  172. data/lib/plaid/models/depository_filter.rb +2 -2
  173. data/lib/plaid/models/distribution_breakdown.rb +2 -2
  174. data/lib/plaid/models/doc_type.rb +2 -2
  175. data/lib/plaid/models/document_metadata.rb +2 -2
  176. data/lib/plaid/models/earnings.rb +2 -2
  177. data/lib/plaid/models/earnings_breakdown.rb +2 -2
  178. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +2 -2
  179. data/lib/plaid/models/earnings_total.rb +2 -2
  180. data/lib/plaid/models/email.rb +2 -2
  181. data/lib/plaid/models/employee.rb +2 -2
  182. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  183. data/lib/plaid/models/employer.rb +2 -2
  184. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  185. data/lib/plaid/models/employer_verification.rb +2 -2
  186. data/lib/plaid/models/employers_search_request.rb +2 -2
  187. data/lib/plaid/models/employers_search_response.rb +2 -2
  188. data/lib/plaid/models/employment_details.rb +2 -2
  189. data/lib/plaid/models/employment_verification.rb +2 -2
  190. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  191. data/lib/plaid/models/employment_verification_get_response.rb +2 -2
  192. data/lib/plaid/models/employment_verification_status.rb +2 -2
  193. data/lib/plaid/models/enhancements.rb +4 -4
  194. data/lib/plaid/models/error.rb +2 -2
  195. data/lib/plaid/models/external_payment_initiation_consent_options.rb +2 -2
  196. data/lib/plaid/models/external_payment_options.rb +2 -2
  197. data/lib/plaid/models/external_payment_refund_details.rb +2 -2
  198. data/lib/plaid/models/external_payment_schedule_base.rb +2 -2
  199. data/lib/plaid/models/external_payment_schedule_get.rb +2 -2
  200. data/lib/plaid/models/external_payment_schedule_request.rb +2 -2
  201. data/lib/plaid/models/health_incident.rb +2 -2
  202. data/lib/plaid/models/historical_balance.rb +2 -2
  203. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  204. data/lib/plaid/models/holding.rb +2 -2
  205. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  206. data/lib/plaid/models/holdings_override.rb +2 -2
  207. data/lib/plaid/models/identity_default_update_webhook.rb +2 -2
  208. data/lib/plaid/models/identity_get_request.rb +2 -2
  209. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  210. data/lib/plaid/models/identity_get_response.rb +2 -2
  211. data/lib/plaid/models/identity_update_types.rb +2 -2
  212. data/lib/plaid/models/incident_update.rb +2 -2
  213. data/lib/plaid/models/income_breakdown.rb +2 -2
  214. data/lib/plaid/models/income_breakdown_type.rb +2 -2
  215. data/lib/plaid/models/income_override.rb +2 -2
  216. data/lib/plaid/models/income_summary.rb +2 -2
  217. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  218. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  219. data/lib/plaid/models/income_verification_create_request.rb +2 -2
  220. data/lib/plaid/models/income_verification_create_request_options.rb +2 -2
  221. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  222. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  223. data/lib/plaid/models/income_verification_payroll_flow_type.rb +2 -2
  224. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  225. data/lib/plaid/models/income_verification_paystubs_get_response.rb +2 -2
  226. data/lib/plaid/models/income_verification_precheck_confidence.rb +2 -2
  227. data/lib/plaid/models/income_verification_precheck_employer.rb +2 -2
  228. data/lib/plaid/models/income_verification_precheck_employer_address.rb +26 -26
  229. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +26 -26
  230. data/lib/plaid/models/income_verification_precheck_military_info.rb +2 -2
  231. data/lib/plaid/models/income_verification_precheck_request.rb +2 -2
  232. data/lib/plaid/models/income_verification_precheck_response.rb +2 -2
  233. data/lib/plaid/models/income_verification_precheck_user.rb +2 -2
  234. data/lib/plaid/models/income_verification_refresh_request.rb +2 -2
  235. data/lib/plaid/models/income_verification_refresh_response.rb +2 -2
  236. data/lib/plaid/models/income_verification_source_type.rb +2 -2
  237. data/lib/plaid/models/income_verification_status_webhook.rb +4 -19
  238. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  239. data/lib/plaid/models/income_verification_taxforms_get_response.rb +2 -2
  240. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  241. data/lib/plaid/models/inflow_model.rb +2 -2
  242. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  243. data/lib/plaid/models/institution.rb +2 -2
  244. data/lib/plaid/models/institution_status.rb +2 -2
  245. data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
  246. data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
  247. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  248. data/lib/plaid/models/institutions_get_request.rb +2 -2
  249. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  250. data/lib/plaid/models/institutions_get_response.rb +2 -2
  251. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  252. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +18 -7
  253. data/lib/plaid/models/institutions_search_request.rb +2 -2
  254. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  255. data/lib/plaid/models/institutions_search_response.rb +2 -2
  256. data/lib/plaid/models/investment_account_subtype.rb +2 -2
  257. data/lib/plaid/models/investment_filter.rb +2 -2
  258. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  259. data/lib/plaid/models/investment_transaction.rb +2 -2
  260. data/lib/plaid/models/investment_transaction_subtype.rb +2 -2
  261. data/lib/plaid/models/investment_transaction_type.rb +2 -2
  262. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  263. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  264. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  265. data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
  266. data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
  267. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  268. data/lib/plaid/models/investments_transactions_override.rb +2 -2
  269. data/lib/plaid/models/item.rb +2 -2
  270. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  271. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  272. data/lib/plaid/models/item_application_list_request.rb +2 -2
  273. data/lib/plaid/models/item_application_list_response.rb +2 -2
  274. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  275. data/lib/plaid/models/item_application_scopes_update_request.rb +2 -2
  276. data/lib/plaid/models/item_application_scopes_update_response.rb +2 -2
  277. data/lib/plaid/models/item_error_webhook.rb +2 -2
  278. data/lib/plaid/models/item_get_request.rb +2 -2
  279. data/lib/plaid/models/item_get_response.rb +2 -2
  280. data/lib/plaid/models/item_import_request.rb +2 -2
  281. data/lib/plaid/models/item_import_request_options.rb +2 -2
  282. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  283. data/lib/plaid/models/item_import_response.rb +2 -2
  284. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  285. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  286. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  287. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  288. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  289. data/lib/plaid/models/item_remove_request.rb +2 -2
  290. data/lib/plaid/models/item_remove_response.rb +2 -2
  291. data/lib/plaid/models/item_status.rb +2 -2
  292. data/lib/plaid/models/item_status_investments.rb +2 -2
  293. data/lib/plaid/models/item_status_last_webhook.rb +2 -2
  294. data/lib/plaid/models/item_status_nullable.rb +2 -2
  295. data/lib/plaid/models/item_status_transactions.rb +2 -2
  296. data/lib/plaid/models/item_webhook_update_request.rb +3 -3
  297. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  298. data/lib/plaid/models/jwk_public_key.rb +2 -2
  299. data/lib/plaid/models/jwt_header.rb +2 -2
  300. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  301. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  302. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  303. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  304. data/lib/plaid/models/liabilities_object.rb +2 -2
  305. data/lib/plaid/models/liability_override.rb +2 -2
  306. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  307. data/lib/plaid/models/link_token_create_credit_filter.rb +2 -2
  308. data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
  309. data/lib/plaid/models/link_token_create_investment_filter.rb +2 -2
  310. data/lib/plaid/models/link_token_create_loan_filter.rb +2 -2
  311. data/lib/plaid/models/link_token_create_request.rb +2 -2
  312. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  313. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  314. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  315. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  316. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
  317. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +2 -2
  318. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  319. data/lib/plaid/models/link_token_create_request_transfer.rb +2 -2
  320. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  321. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  322. data/lib/plaid/models/link_token_create_response.rb +2 -2
  323. data/lib/plaid/models/link_token_eu_config.rb +2 -2
  324. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  325. data/lib/plaid/models/link_token_get_request.rb +2 -2
  326. data/lib/plaid/models/link_token_get_response.rb +2 -2
  327. data/lib/plaid/models/loan_account_subtype.rb +2 -2
  328. data/lib/plaid/models/loan_filter.rb +2 -2
  329. data/lib/plaid/models/location.rb +2 -2
  330. data/lib/plaid/models/meta.rb +2 -2
  331. data/lib/plaid/models/mfa.rb +2 -2
  332. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  333. data/lib/plaid/models/mortgage_liability.rb +2 -2
  334. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  335. data/lib/plaid/models/net_pay.rb +2 -2
  336. data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
  337. data/lib/plaid/models/numbers.rb +2 -2
  338. data/lib/plaid/models/numbers_ach.rb +2 -2
  339. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  340. data/lib/plaid/models/numbers_bacs.rb +2 -2
  341. data/lib/plaid/models/numbers_bacs_nullable.rb +2 -2
  342. data/lib/plaid/models/numbers_eft.rb +2 -2
  343. data/lib/plaid/models/numbers_eft_nullable.rb +2 -2
  344. data/lib/plaid/models/numbers_international.rb +2 -2
  345. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  346. data/lib/plaid/models/override_account_type.rb +2 -2
  347. data/lib/plaid/models/override_accounts.rb +2 -2
  348. data/lib/plaid/models/owner.rb +2 -2
  349. data/lib/plaid/models/owner_override.rb +2 -2
  350. data/lib/plaid/models/pay.rb +2 -2
  351. data/lib/plaid/models/pay_frequency.rb +2 -2
  352. data/lib/plaid/models/pay_frequency_value.rb +2 -2
  353. data/lib/plaid/models/pay_period_details.rb +2 -2
  354. data/lib/plaid/models/pay_stub.rb +329 -0
  355. data/lib/plaid/models/pay_stub_address.rb +265 -0
  356. data/lib/plaid/models/pay_stub_deductions.rb +240 -0
  357. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +265 -0
  358. data/lib/plaid/models/pay_stub_deductions_total.rb +254 -0
  359. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +287 -0
  360. data/lib/plaid/models/{requested_scopes.rb → pay_stub_earnings.rb} +29 -22
  361. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +298 -0
  362. data/lib/plaid/models/pay_stub_earnings_total.rb +265 -0
  363. data/lib/plaid/models/pay_stub_employee.rb +260 -0
  364. data/lib/plaid/models/pay_stub_employer.rb +235 -0
  365. data/lib/plaid/models/pay_stub_net_pay.rb +265 -0
  366. data/lib/plaid/models/pay_stub_pay_period_details.rb +314 -0
  367. data/lib/plaid/models/pay_stub_taxpayer_id.rb +232 -0
  368. data/lib/plaid/models/pay_stub_verification.rb +237 -0
  369. data/lib/plaid/models/pay_stub_verification_attribute.rb +221 -0
  370. data/lib/plaid/models/payment_amount.rb +2 -2
  371. data/lib/plaid/models/payment_amount_currency.rb +2 -2
  372. data/lib/plaid/models/payment_channel.rb +2 -2
  373. data/lib/plaid/models/payment_consent_max_payment_amount.rb +2 -2
  374. data/lib/plaid/models/payment_consent_periodic_alignment.rb +2 -2
  375. data/lib/plaid/models/payment_consent_periodic_amount.rb +2 -2
  376. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +2 -2
  377. data/lib/plaid/models/payment_consent_periodic_interval.rb +2 -2
  378. data/lib/plaid/models/payment_consent_valid_date_time.rb +4 -2
  379. data/lib/plaid/models/payment_initiation_address.rb +2 -2
  380. data/lib/plaid/models/payment_initiation_consent.rb +2 -2
  381. data/lib/plaid/models/payment_initiation_consent_constraints.rb +3 -2
  382. data/lib/plaid/models/payment_initiation_consent_create_request.rb +2 -2
  383. data/lib/plaid/models/payment_initiation_consent_create_response.rb +2 -2
  384. data/lib/plaid/models/payment_initiation_consent_get_request.rb +2 -2
  385. data/lib/plaid/models/payment_initiation_consent_get_response.rb +2 -2
  386. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
  387. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +2 -2
  388. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +2 -2
  389. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
  390. data/lib/plaid/models/payment_initiation_consent_scope.rb +2 -2
  391. data/lib/plaid/models/payment_initiation_consent_status.rb +2 -2
  392. data/lib/plaid/models/payment_initiation_metadata.rb +2 -2
  393. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +2 -2
  394. data/lib/plaid/models/payment_initiation_payment.rb +2 -2
  395. data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
  396. data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
  397. data/lib/plaid/models/payment_initiation_payment_create_status.rb +2 -2
  398. data/lib/plaid/models/payment_initiation_payment_get_request.rb +2 -2
  399. data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -2
  400. data/lib/plaid/models/payment_initiation_payment_list_request.rb +2 -2
  401. data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
  402. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +2 -2
  403. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
  404. data/lib/plaid/models/payment_initiation_payment_status.rb +2 -2
  405. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +2 -2
  406. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  407. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  408. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  409. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  410. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +2 -2
  411. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  412. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +2 -2
  413. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +2 -2
  414. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  415. data/lib/plaid/models/payment_initiation_refund.rb +2 -2
  416. data/lib/plaid/models/payment_initiation_refund_status.rb +2 -2
  417. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -2
  418. data/lib/plaid/models/payment_meta.rb +2 -2
  419. data/lib/plaid/models/payment_schedule_interval.rb +2 -2
  420. data/lib/plaid/models/payment_scheme.rb +2 -2
  421. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  422. data/lib/plaid/models/payroll_income_object.rb +255 -0
  423. data/lib/plaid/models/payroll_item.rb +241 -0
  424. data/lib/plaid/models/paystub.rb +2 -2
  425. data/lib/plaid/models/paystub_address.rb +2 -2
  426. data/lib/plaid/models/paystub_deduction.rb +2 -2
  427. data/lib/plaid/models/paystub_details.rb +2 -2
  428. data/lib/plaid/models/paystub_employer.rb +2 -2
  429. data/lib/plaid/models/paystub_override.rb +2 -2
  430. data/lib/plaid/models/paystub_override_employee.rb +2 -2
  431. data/lib/plaid/models/paystub_override_employee_address.rb +2 -2
  432. data/lib/plaid/models/paystub_override_employer.rb +2 -2
  433. data/lib/plaid/models/paystub_pay_frequency.rb +2 -2
  434. data/lib/plaid/models/paystub_verification.rb +2 -2
  435. data/lib/plaid/models/paystub_verification_status.rb +2 -2
  436. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  437. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  438. data/lib/plaid/models/personal_finance_category.rb +2 -2
  439. data/lib/plaid/models/phone_number.rb +2 -2
  440. data/lib/plaid/models/plaid_error.rb +2 -2
  441. data/lib/plaid/models/platform_ids.rb +2 -2
  442. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  443. data/lib/plaid/models/processor_auth_get_request.rb +2 -2
  444. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  445. data/lib/plaid/models/processor_balance_get_request.rb +2 -2
  446. data/lib/plaid/models/processor_balance_get_request_options.rb +2 -2
  447. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  448. data/lib/plaid/models/processor_bank_transfer_create_request.rb +2 -2
  449. data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
  450. data/lib/plaid/models/processor_identity_get_request.rb +2 -2
  451. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  452. data/lib/plaid/models/processor_number.rb +2 -2
  453. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +2 -2
  454. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  455. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  456. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  457. data/lib/plaid/models/product_access.rb +2 -2
  458. data/lib/plaid/models/product_status.rb +2 -2
  459. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  460. data/lib/plaid/models/products.rb +2 -2
  461. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  462. data/lib/plaid/models/pslf_status.rb +2 -2
  463. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  464. data/lib/plaid/models/recipient_bacs.rb +3 -3
  465. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  466. data/lib/plaid/models/recurring_transaction_frequency.rb +2 -2
  467. data/lib/plaid/models/relay_event.rb +2 -2
  468. data/lib/plaid/models/removed_transaction.rb +2 -2
  469. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  470. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  471. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  472. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  473. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +2 -2
  474. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +2 -2
  475. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +15 -6
  476. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  477. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  478. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  479. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  480. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  481. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +2 -2
  482. data/lib/plaid/models/sandbox_processor_token_create_request.rb +2 -2
  483. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  484. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  485. data/lib/plaid/models/sandbox_public_token_create_request.rb +2 -2
  486. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  487. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  488. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  489. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +245 -0
  490. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +225 -0
  491. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +2 -2
  492. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +2 -2
  493. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
  494. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +2 -2
  495. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  496. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +2 -2
  497. data/lib/plaid/models/scopes.rb +2 -2
  498. data/lib/plaid/models/scopes_context.rb +2 -2
  499. data/lib/plaid/models/scopes_nullable.rb +2 -2
  500. data/lib/plaid/models/security.rb +2 -2
  501. data/lib/plaid/models/security_override.rb +2 -2
  502. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  503. data/lib/plaid/models/servicer_address_data.rb +2 -2
  504. data/lib/plaid/models/signal_address_data.rb +2 -2
  505. data/lib/plaid/models/signal_decision_report_request.rb +2 -2
  506. data/lib/plaid/models/signal_decision_report_response.rb +2 -2
  507. data/lib/plaid/models/signal_device.rb +2 -2
  508. data/lib/plaid/models/signal_evaluate_core_attributes.rb +326 -7
  509. data/lib/plaid/models/signal_evaluate_request.rb +2 -2
  510. data/lib/plaid/models/signal_evaluate_response.rb +2 -2
  511. data/lib/plaid/models/signal_person_name.rb +2 -2
  512. data/lib/plaid/models/signal_return_report_request.rb +2 -2
  513. data/lib/plaid/models/signal_return_report_response.rb +2 -2
  514. data/lib/plaid/models/signal_scores.rb +2 -2
  515. data/lib/plaid/models/signal_user.rb +2 -2
  516. data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
  517. data/lib/plaid/models/standalone_account_type.rb +2 -2
  518. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  519. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  520. data/lib/plaid/models/student_loan.rb +2 -2
  521. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  522. data/lib/plaid/models/student_loan_status.rb +2 -2
  523. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  524. data/lib/plaid/models/taxform.rb +2 -2
  525. data/lib/plaid/models/taxpayer_id.rb +2 -2
  526. data/lib/plaid/models/total.rb +2 -2
  527. data/lib/plaid/models/total_canonical_description.rb +2 -2
  528. data/lib/plaid/models/transaction.rb +2 -2
  529. data/lib/plaid/models/transaction_all_of.rb +2 -2
  530. data/lib/plaid/models/transaction_base.rb +2 -2
  531. data/lib/plaid/models/transaction_code.rb +2 -2
  532. data/lib/plaid/models/transaction_data.rb +2 -2
  533. data/lib/plaid/models/transaction_override.rb +2 -2
  534. data/lib/plaid/models/transaction_stream.rb +2 -2
  535. data/lib/plaid/models/transaction_stream_amount.rb +2 -2
  536. data/lib/plaid/models/transaction_stream_status.rb +2 -2
  537. data/lib/plaid/models/transactions_category_rule.rb +2 -2
  538. data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
  539. data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
  540. data/lib/plaid/models/transactions_get_request.rb +2 -2
  541. data/lib/plaid/models/transactions_get_request_options.rb +4 -4
  542. data/lib/plaid/models/transactions_get_response.rb +2 -2
  543. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  544. data/lib/plaid/models/transactions_recurring_get_response.rb +2 -2
  545. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  546. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  547. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  548. data/lib/plaid/models/transactions_rule_details.rb +2 -2
  549. data/lib/plaid/models/transactions_rule_field.rb +2 -2
  550. data/lib/plaid/models/transactions_rule_type.rb +2 -2
  551. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  552. data/lib/plaid/models/transactions_rules_create_response.rb +2 -2
  553. data/lib/plaid/models/transactions_rules_list_request.rb +2 -2
  554. data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
  555. data/lib/plaid/models/transactions_rules_remove_request.rb +2 -2
  556. data/lib/plaid/models/transactions_rules_remove_response.rb +2 -2
  557. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  558. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  559. data/lib/plaid/models/transfer.rb +2 -2
  560. data/lib/plaid/models/transfer_authorization.rb +2 -2
  561. data/lib/plaid/models/transfer_authorization_create_request.rb +2 -2
  562. data/lib/plaid/models/transfer_authorization_create_response.rb +2 -2
  563. data/lib/plaid/models/transfer_authorization_decision.rb +2 -2
  564. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +2 -2
  565. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +2 -2
  566. data/lib/plaid/models/transfer_authorization_device.rb +2 -2
  567. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +2 -2
  568. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +2 -2
  569. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +2 -2
  570. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
  571. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  572. data/lib/plaid/models/transfer_cancel_response.rb +2 -2
  573. data/lib/plaid/models/transfer_create_request.rb +2 -2
  574. data/lib/plaid/models/transfer_create_response.rb +2 -2
  575. data/lib/plaid/models/transfer_event.rb +2 -2
  576. data/lib/plaid/models/transfer_event_list_request.rb +2 -2
  577. data/lib/plaid/models/transfer_event_list_response.rb +2 -2
  578. data/lib/plaid/models/transfer_event_list_transfer_type.rb +2 -2
  579. data/lib/plaid/models/transfer_event_sync_request.rb +2 -2
  580. data/lib/plaid/models/transfer_event_sync_response.rb +2 -2
  581. data/lib/plaid/models/transfer_event_type.rb +2 -2
  582. data/lib/plaid/models/transfer_failure.rb +2 -2
  583. data/lib/plaid/models/transfer_get_request.rb +2 -2
  584. data/lib/plaid/models/transfer_get_response.rb +2 -2
  585. data/lib/plaid/models/transfer_intent_authorization_decision.rb +2 -2
  586. data/lib/plaid/models/transfer_intent_create.rb +2 -2
  587. data/lib/plaid/models/transfer_intent_create_mode.rb +2 -2
  588. data/lib/plaid/models/transfer_intent_create_request.rb +11 -2
  589. data/lib/plaid/models/transfer_intent_create_response.rb +2 -2
  590. data/lib/plaid/models/transfer_intent_get.rb +2 -2
  591. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
  592. data/lib/plaid/models/transfer_intent_get_request.rb +2 -2
  593. data/lib/plaid/models/transfer_intent_get_response.rb +2 -2
  594. data/lib/plaid/models/transfer_intent_status.rb +2 -2
  595. data/lib/plaid/models/transfer_list_request.rb +2 -2
  596. data/lib/plaid/models/transfer_list_response.rb +2 -2
  597. data/lib/plaid/models/transfer_migrate_account_request.rb +285 -0
  598. data/lib/plaid/models/transfer_migrate_account_response.rb +255 -0
  599. data/lib/plaid/models/transfer_network.rb +2 -2
  600. data/lib/plaid/models/transfer_repayment.rb +2 -2
  601. data/lib/plaid/models/transfer_repayment_list_request.rb +2 -2
  602. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  603. data/lib/plaid/models/transfer_repayment_return.rb +2 -2
  604. data/lib/plaid/models/transfer_repayment_return_list_request.rb +2 -2
  605. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  606. data/lib/plaid/models/transfer_status.rb +2 -2
  607. data/lib/plaid/models/transfer_sweep.rb +2 -2
  608. data/lib/plaid/models/transfer_sweep_get_request.rb +2 -2
  609. data/lib/plaid/models/transfer_sweep_get_response.rb +2 -2
  610. data/lib/plaid/models/transfer_sweep_list_request.rb +2 -2
  611. data/lib/plaid/models/transfer_sweep_list_response.rb +2 -2
  612. data/lib/plaid/models/transfer_sweep_status.rb +2 -2
  613. data/lib/plaid/models/transfer_type.rb +2 -2
  614. data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
  615. data/lib/plaid/models/transfer_user_address_in_response.rb +2 -2
  616. data/lib/plaid/models/transfer_user_in_request.rb +2 -2
  617. data/lib/plaid/models/transfer_user_in_response.rb +2 -2
  618. data/lib/plaid/models/user_create_request.rb +2 -2
  619. data/lib/plaid/models/user_create_response.rb +2 -2
  620. data/lib/plaid/models/user_custom_password.rb +2 -2
  621. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  622. data/lib/plaid/models/verification_attribute.rb +2 -2
  623. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  624. data/lib/plaid/models/verification_refresh_status.rb +2 -2
  625. data/lib/plaid/models/verification_status.rb +2 -2
  626. data/lib/plaid/models/w2.rb +2 -2
  627. data/lib/plaid/models/w2_box12.rb +2 -2
  628. data/lib/plaid/models/w2_state_and_local_wages.rb +2 -2
  629. data/lib/plaid/models/wallet_balance.rb +2 -2
  630. data/lib/plaid/models/wallet_get_request.rb +2 -2
  631. data/lib/plaid/models/wallet_get_response.rb +15 -6
  632. data/lib/plaid/models/wallet_numbers.rb +220 -0
  633. data/lib/plaid/models/wallet_transaction.rb +2 -2
  634. data/lib/plaid/models/wallet_transaction_amount.rb +2 -2
  635. data/lib/plaid/models/wallet_transaction_counterparty.rb +2 -2
  636. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
  637. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  638. data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
  639. data/lib/plaid/models/wallet_transaction_execute_response.rb +2 -2
  640. data/lib/plaid/models/wallet_transaction_status.rb +2 -2
  641. data/lib/plaid/models/wallet_transactions_list_request.rb +2 -2
  642. data/lib/plaid/models/wallet_transactions_list_response.rb +2 -2
  643. data/lib/plaid/models/warning.rb +2 -2
  644. data/lib/plaid/models/{connected_application_status.rb → webhook_type.rb} +9 -5
  645. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  646. data/lib/plaid/models/webhook_verification_key_get_request.rb +2 -2
  647. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  648. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  649. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  650. data/lib/plaid/version.rb +3 -3
  651. data/lib/plaid.rb +38 -4
  652. data/plaid.gemspec +2 -2
  653. metadata +38 -5
  654. data/test/test_income_verifications.rb +0 -76
@@ -0,0 +1,298 @@
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.94.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ # An object representing the earnings line items for the pay period.
18
+ class PayStubEarningsBreakdown
19
+ # Commonly used term to describe the earning line item.
20
+ attr_accessor :canonical_description
21
+
22
+ # Raw amount of the earning line item.
23
+ attr_accessor :current_amount
24
+
25
+ # Description of the earning line item.
26
+ attr_accessor :description
27
+
28
+ # Number of hours applicable for this earning.
29
+ attr_accessor :hours
30
+
31
+ # The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
32
+ attr_accessor :iso_currency_code
33
+
34
+ # Hourly rate applicable for this earning.
35
+ attr_accessor :rate
36
+
37
+ # The unofficial currency code associated with the line item. 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.
38
+ attr_accessor :unofficial_currency_code
39
+
40
+ # The year-to-date amount of the deduction.
41
+ attr_accessor :ytd_amount
42
+
43
+ # Attribute mapping from ruby-style variable name to JSON key.
44
+ def self.attribute_map
45
+ {
46
+ :'canonical_description' => :'canonical_description',
47
+ :'current_amount' => :'current_amount',
48
+ :'description' => :'description',
49
+ :'hours' => :'hours',
50
+ :'iso_currency_code' => :'iso_currency_code',
51
+ :'rate' => :'rate',
52
+ :'unofficial_currency_code' => :'unofficial_currency_code',
53
+ :'ytd_amount' => :'ytd_amount'
54
+ }
55
+ end
56
+
57
+ # Returns all the JSON keys this model knows about
58
+ def self.acceptable_attributes
59
+ attribute_map.values
60
+ end
61
+
62
+ # Attribute type mapping.
63
+ def self.openapi_types
64
+ {
65
+ :'canonical_description' => :'String',
66
+ :'current_amount' => :'Float',
67
+ :'description' => :'String',
68
+ :'hours' => :'Float',
69
+ :'iso_currency_code' => :'String',
70
+ :'rate' => :'Float',
71
+ :'unofficial_currency_code' => :'String',
72
+ :'ytd_amount' => :'Float'
73
+ }
74
+ end
75
+
76
+ # List of attributes with nullable: true
77
+ def self.openapi_nullable
78
+ Set.new([
79
+ :'canonical_description',
80
+ :'current_amount',
81
+ :'description',
82
+ :'hours',
83
+ :'iso_currency_code',
84
+ :'rate',
85
+ :'unofficial_currency_code',
86
+ :'ytd_amount'
87
+ ])
88
+ end
89
+
90
+ # Initializes the object
91
+ # @param [Hash] attributes Model attributes in the form of hash
92
+ def initialize(attributes = {})
93
+ if (!attributes.is_a?(Hash))
94
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PayStubEarningsBreakdown` initialize method"
95
+ end
96
+
97
+ # check to see if the attribute exists and convert string to symbol for hash key
98
+ attributes = attributes.each_with_object({}) { |(k, v), h|
99
+ if (!self.class.attribute_map.key?(k.to_sym))
100
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::PayStubEarningsBreakdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
101
+ end
102
+ h[k.to_sym] = v
103
+ }
104
+
105
+ if attributes.key?(:'canonical_description')
106
+ self.canonical_description = attributes[:'canonical_description']
107
+ end
108
+
109
+ if attributes.key?(:'current_amount')
110
+ self.current_amount = attributes[:'current_amount']
111
+ end
112
+
113
+ if attributes.key?(:'description')
114
+ self.description = attributes[:'description']
115
+ end
116
+
117
+ if attributes.key?(:'hours')
118
+ self.hours = attributes[:'hours']
119
+ end
120
+
121
+ if attributes.key?(:'iso_currency_code')
122
+ self.iso_currency_code = attributes[:'iso_currency_code']
123
+ end
124
+
125
+ if attributes.key?(:'rate')
126
+ self.rate = attributes[:'rate']
127
+ end
128
+
129
+ if attributes.key?(:'unofficial_currency_code')
130
+ self.unofficial_currency_code = attributes[:'unofficial_currency_code']
131
+ end
132
+
133
+ if attributes.key?(:'ytd_amount')
134
+ self.ytd_amount = attributes[:'ytd_amount']
135
+ end
136
+ end
137
+
138
+ # Show invalid properties with the reasons. Usually used together with valid?
139
+ # @return Array for valid properties with the reasons
140
+ def list_invalid_properties
141
+ invalid_properties = Array.new
142
+ invalid_properties
143
+ end
144
+
145
+ # Check to see if the all the properties in the model are valid
146
+ # @return true if the model is valid
147
+ def valid?
148
+ true
149
+ end
150
+
151
+ # Checks equality by comparing each attribute.
152
+ # @param [Object] Object to be compared
153
+ def ==(o)
154
+ return true if self.equal?(o)
155
+ self.class == o.class &&
156
+ canonical_description == o.canonical_description &&
157
+ current_amount == o.current_amount &&
158
+ description == o.description &&
159
+ hours == o.hours &&
160
+ iso_currency_code == o.iso_currency_code &&
161
+ rate == o.rate &&
162
+ unofficial_currency_code == o.unofficial_currency_code &&
163
+ ytd_amount == o.ytd_amount
164
+ end
165
+
166
+ # @see the `==` method
167
+ # @param [Object] Object to be compared
168
+ def eql?(o)
169
+ self == o
170
+ end
171
+
172
+ # Calculates hash code according to all attributes.
173
+ # @return [Integer] Hash code
174
+ def hash
175
+ [canonical_description, current_amount, description, hours, iso_currency_code, rate, unofficial_currency_code, ytd_amount].hash
176
+ end
177
+
178
+ # Builds the object from hash
179
+ # @param [Hash] attributes Model attributes in the form of hash
180
+ # @return [Object] Returns the model itself
181
+ def self.build_from_hash(attributes)
182
+ new.build_from_hash(attributes)
183
+ end
184
+
185
+ # Builds the object from hash
186
+ # @param [Hash] attributes Model attributes in the form of hash
187
+ # @return [Object] Returns the model itself
188
+ def build_from_hash(attributes)
189
+ return nil unless attributes.is_a?(Hash)
190
+ self.class.openapi_types.each_pair do |key, type|
191
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
192
+ self.send("#{key}=", nil)
193
+ elsif type =~ /\AArray<(.*)>/i
194
+ # check to ensure the input is an array given that the attribute
195
+ # is documented as an array but the input is not
196
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
197
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
198
+ end
199
+ elsif !attributes[self.class.attribute_map[key]].nil?
200
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
201
+ end
202
+ end
203
+
204
+ self
205
+ end
206
+
207
+ # Deserializes the data based on type
208
+ # @param string type Data type
209
+ # @param string value Value to be deserialized
210
+ # @return [Object] Deserialized data
211
+ def _deserialize(type, value)
212
+ case type.to_sym
213
+ when :Time
214
+ Time.parse(value)
215
+ when :Date
216
+ Date.parse(value)
217
+ when :String
218
+ value.to_s
219
+ when :Integer
220
+ value.to_i
221
+ when :Float
222
+ value.to_f
223
+ when :Boolean
224
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
225
+ true
226
+ else
227
+ false
228
+ end
229
+ when :Object
230
+ # generic object (usually a Hash), return directly
231
+ value
232
+ when /\AArray<(?<inner_type>.+)>\z/
233
+ inner_type = Regexp.last_match[:inner_type]
234
+ value.map { |v| _deserialize(inner_type, v) }
235
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
236
+ k_type = Regexp.last_match[:k_type]
237
+ v_type = Regexp.last_match[:v_type]
238
+ {}.tap do |hash|
239
+ value.each do |k, v|
240
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
241
+ end
242
+ end
243
+ else # model
244
+ # models (e.g. Pet) or oneOf
245
+ klass = Plaid.const_get(type)
246
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
247
+ end
248
+ end
249
+
250
+ # Returns the string representation of the object
251
+ # @return [String] String presentation of the object
252
+ def to_s
253
+ to_hash.to_s
254
+ end
255
+
256
+ # to_body is an alias to to_hash (backward compatibility)
257
+ # @return [Hash] Returns the object in the form of hash
258
+ def to_body
259
+ to_hash
260
+ end
261
+
262
+ # Returns the object in the form of hash
263
+ # @return [Hash] Returns the object in the form of hash
264
+ def to_hash
265
+ hash = {}
266
+ self.class.attribute_map.each_pair do |attr, param|
267
+ value = self.send(attr)
268
+ if value.nil?
269
+ is_nullable = self.class.openapi_nullable.include?(attr)
270
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
271
+ end
272
+
273
+ hash[param] = _to_hash(value)
274
+ end
275
+ hash
276
+ end
277
+
278
+ # Outputs non-array value in the form of hash
279
+ # For object, use to_hash. Otherwise, just return the value
280
+ # @param [Object] value Any valid value
281
+ # @return [Hash] Returns the value in the form of hash
282
+ def _to_hash(value)
283
+ if value.is_a?(Array)
284
+ value.compact.map { |v| _to_hash(v) }
285
+ elsif value.is_a?(Hash)
286
+ {}.tap do |hash|
287
+ value.each { |k, v| hash[k] = _to_hash(v) }
288
+ end
289
+ elsif value.respond_to? :to_hash
290
+ value.to_hash
291
+ else
292
+ value
293
+ end
294
+ end
295
+
296
+ end
297
+
298
+ end
@@ -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.94.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ # An object representing both the current pay period and year to date amount for an earning category.
18
+ class PayStubEarningsTotal
19
+ # Total amount of the earnings for this pay period.
20
+ attr_accessor :current_amount
21
+
22
+ # Total number of hours worked for this pay period.
23
+ attr_accessor :hours
24
+
25
+ # The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
26
+ attr_accessor :iso_currency_code
27
+
28
+ # The unofficial currency code associated with the security. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
29
+ attr_accessor :unofficial_currency_code
30
+
31
+ # The total year-to-date amount of the earnings.
32
+ attr_accessor :ytd_amount
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'current_amount' => :'current_amount',
38
+ :'hours' => :'hours',
39
+ :'iso_currency_code' => :'iso_currency_code',
40
+ :'unofficial_currency_code' => :'unofficial_currency_code',
41
+ :'ytd_amount' => :'ytd_amount'
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
+ :'current_amount' => :'Float',
54
+ :'hours' => :'Float',
55
+ :'iso_currency_code' => :'String',
56
+ :'unofficial_currency_code' => :'String',
57
+ :'ytd_amount' => :'Float'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'current_amount',
65
+ :'hours',
66
+ :'iso_currency_code',
67
+ :'unofficial_currency_code',
68
+ :'ytd_amount'
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::PayStubEarningsTotal` 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::PayStubEarningsTotal`. 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?(:'current_amount')
88
+ self.current_amount = attributes[:'current_amount']
89
+ end
90
+
91
+ if attributes.key?(:'hours')
92
+ self.hours = attributes[:'hours']
93
+ end
94
+
95
+ if attributes.key?(:'iso_currency_code')
96
+ self.iso_currency_code = attributes[:'iso_currency_code']
97
+ end
98
+
99
+ if attributes.key?(:'unofficial_currency_code')
100
+ self.unofficial_currency_code = attributes[:'unofficial_currency_code']
101
+ end
102
+
103
+ if attributes.key?(:'ytd_amount')
104
+ self.ytd_amount = attributes[:'ytd_amount']
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
+ current_amount == o.current_amount &&
127
+ hours == o.hours &&
128
+ iso_currency_code == o.iso_currency_code &&
129
+ unofficial_currency_code == o.unofficial_currency_code &&
130
+ ytd_amount == o.ytd_amount
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
+ [current_amount, hours, iso_currency_code, unofficial_currency_code, ytd_amount].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