plaid 14.5.0 → 14.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (577) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +12 -0
  3. data/Dockerfile +4 -2
  4. data/Gemfile.lock +1 -1
  5. data/Makefile +1 -1
  6. data/README.md +4 -4
  7. data/doc/rdoc/.DS_Store +0 -0
  8. data/doc/rdoc/classes/Plaid/Models/Payment.html +17 -0
  9. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +17 -0
  10. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +23 -20
  11. data/doc/rdoc/classes/Plaid.html +1 -1
  12. data/doc/rdoc/created.rid +28 -28
  13. data/doc/rdoc/files/LICENSE_txt.html +1 -1
  14. data/doc/rdoc/files/README_md.html +1 -1
  15. data/doc/rdoc/files/lib/plaid/client_rb.html +1 -1
  16. data/doc/rdoc/files/lib/plaid/errors_rb.html +1 -1
  17. data/doc/rdoc/files/lib/plaid/middleware_rb.html +1 -1
  18. data/doc/rdoc/files/lib/plaid/models_rb.html +1 -1
  19. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +1 -1
  20. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +1 -1
  21. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +1 -1
  22. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +1 -1
  23. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +1 -1
  24. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +1 -1
  25. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +1 -1
  26. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +1 -1
  27. data/doc/rdoc/files/lib/plaid/products/income_rb.html +1 -1
  28. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +1 -1
  29. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +1 -1
  30. data/doc/rdoc/files/lib/plaid/products/item_rb.html +1 -1
  31. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +1 -1
  32. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +1 -1
  33. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +1 -1
  34. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +1 -1
  35. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +1 -1
  36. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +1 -1
  37. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +1 -1
  38. data/doc/rdoc/files/lib/plaid/version_rb.html +1 -1
  39. data/doc/rdoc/files/lib/plaid_rb.html +1 -1
  40. data/doc/rdoc/js/navigation.js.gz +0 -0
  41. data/doc/rdoc/js/search_index.js +1 -1
  42. data/doc/rdoc/js/search_index.js.gz +0 -0
  43. data/doc/rdoc/js/searcher.js.gz +0 -0
  44. data/lib/plaid/.DS_Store +0 -0
  45. data/lib/plaid/api/plaid_api.rb +619 -34
  46. data/lib/plaid/api_client.rb +2 -2
  47. data/lib/plaid/api_error.rb +1 -1
  48. data/lib/plaid/configuration.rb +1 -1
  49. data/lib/plaid/models/account_access.rb +17 -7
  50. data/lib/plaid/models/account_assets.rb +2 -2
  51. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  52. data/lib/plaid/models/account_balance.rb +3 -3
  53. data/lib/plaid/models/account_base.rb +1 -1
  54. data/lib/plaid/models/account_filter.rb +1 -1
  55. data/lib/plaid/models/account_filters_response.rb +1 -1
  56. data/lib/plaid/models/account_identity.rb +2 -2
  57. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  58. data/lib/plaid/models/account_product_access.rb +249 -0
  59. data/lib/plaid/models/account_product_access_nullable.rb +255 -0
  60. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  61. data/lib/plaid/models/account_subtype.rb +1 -2
  62. data/lib/plaid/models/account_type.rb +1 -1
  63. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  64. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  65. data/lib/plaid/models/accounts_get_request.rb +1 -1
  66. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  67. data/lib/plaid/models/accounts_get_response.rb +1 -1
  68. data/lib/plaid/models/ach_class.rb +1 -1
  69. data/lib/plaid/models/address.rb +1 -1
  70. data/lib/plaid/models/address_data.rb +3 -3
  71. data/lib/plaid/models/address_data_nullable.rb +3 -3
  72. data/lib/plaid/models/address_nullable.rb +1 -1
  73. data/lib/plaid/models/application.rb +1 -1
  74. data/lib/plaid/models/application_get_request.rb +1 -1
  75. data/lib/plaid/models/application_get_response.rb +1 -1
  76. data/lib/plaid/models/apr.rb +1 -1
  77. data/lib/plaid/models/asset_report.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  80. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  84. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  85. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  86. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_request.rb +3 -1
  89. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  90. data/lib/plaid/models/asset_report_item.rb +1 -1
  91. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  92. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  93. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  94. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  95. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  96. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  97. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  98. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  99. data/lib/plaid/models/asset_report_user.rb +1 -1
  100. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  101. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  102. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  103. data/lib/plaid/models/auth_get_request.rb +1 -1
  104. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  105. data/lib/plaid/models/auth_get_response.rb +1 -1
  106. data/lib/plaid/models/auth_metadata.rb +1 -1
  107. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  108. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  109. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  110. data/lib/plaid/models/bank_transfer.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep.rb +2 -23
  136. data/lib/plaid/models/bank_transfer_sweep_account.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -23
  138. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -30
  140. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  143. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  144. data/lib/plaid/models/categories_get_response.rb +1 -1
  145. data/lib/plaid/models/category.rb +1 -1
  146. data/lib/plaid/models/cause.rb +1 -1
  147. data/lib/plaid/models/connected_application.rb +1 -1
  148. data/lib/plaid/models/country_code.rb +2 -1
  149. data/lib/plaid/models/credit_card_liability.rb +1 -1
  150. data/lib/plaid/models/credit_filter.rb +1 -1
  151. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  152. data/lib/plaid/models/deductions.rb +35 -5
  153. data/lib/plaid/models/deductions_breakdown.rb +265 -0
  154. data/lib/plaid/models/deductions_total.rb +254 -0
  155. data/lib/plaid/models/default_update_webhook.rb +1 -1
  156. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  157. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  158. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  159. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  160. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  161. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  162. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  163. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  164. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  165. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  166. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  167. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  168. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  169. data/lib/plaid/models/depository_filter.rb +1 -1
  170. data/lib/plaid/models/distribution_breakdown.rb +296 -0
  171. data/lib/plaid/models/doc_type.rb +45 -0
  172. data/lib/plaid/models/document_metadata.rb +2 -37
  173. data/lib/plaid/models/earnings.rb +25 -5
  174. data/lib/plaid/models/earnings_breakdown.rb +297 -0
  175. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +45 -0
  176. data/lib/plaid/models/earnings_total.rb +46 -67
  177. data/lib/plaid/models/email.rb +1 -1
  178. data/lib/plaid/models/employee.rb +11 -11
  179. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  180. data/lib/plaid/models/employer.rb +1 -1
  181. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  182. data/lib/plaid/models/employer_verification.rb +1 -1
  183. data/lib/plaid/models/employers_search_request.rb +1 -1
  184. data/lib/plaid/models/employers_search_response.rb +1 -1
  185. data/lib/plaid/models/employment_details.rb +1 -1
  186. data/lib/plaid/models/employment_verification.rb +2 -37
  187. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  188. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  189. data/lib/plaid/models/employment_verification_status.rb +40 -0
  190. data/lib/plaid/models/error.rb +4 -4
  191. data/lib/plaid/models/external_payment_options.rb +18 -18
  192. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  193. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  194. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  195. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  196. data/lib/plaid/models/health_incident.rb +1 -1
  197. data/lib/plaid/models/historical_balance.rb +1 -1
  198. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  199. data/lib/plaid/models/holding.rb +1 -1
  200. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  201. data/lib/plaid/models/holdings_override.rb +1 -1
  202. data/lib/plaid/models/identity_get_request.rb +1 -1
  203. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  204. data/lib/plaid/models/identity_get_response.rb +1 -1
  205. data/lib/plaid/models/incident_update.rb +1 -1
  206. data/lib/plaid/models/income_breakdown.rb +2 -37
  207. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  208. data/lib/plaid/models/income_override.rb +1 -1
  209. data/lib/plaid/models/income_summary.rb +1 -1
  210. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  211. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  212. data/lib/plaid/models/income_verification_create_request.rb +14 -5
  213. data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
  214. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  215. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  216. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  217. data/lib/plaid/models/income_verification_paystub_get_response.rb +1 -1
  218. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  219. data/lib/plaid/models/income_verification_paystubs_get_response.rb +13 -13
  220. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  221. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  222. data/lib/plaid/models/income_verification_precheck_employer_address.rb +3 -3
  223. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  224. data/lib/plaid/models/income_verification_precheck_request.rb +14 -2
  225. data/lib/plaid/models/income_verification_precheck_response.rb +2 -37
  226. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  227. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  228. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  229. data/lib/plaid/models/income_verification_status_webhook.rb +18 -3
  230. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  231. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  232. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  233. data/lib/plaid/models/income_verification_taxforms_get_response.rb +18 -18
  234. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  235. data/lib/plaid/models/inflow_model.rb +2 -2
  236. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  237. data/lib/plaid/models/institution.rb +1 -1
  238. data/lib/plaid/models/institution_status.rb +1 -1
  239. data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
  240. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  241. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  242. data/lib/plaid/models/institutions_get_request.rb +2 -2
  243. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  244. data/lib/plaid/models/institutions_get_response.rb +1 -1
  245. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  246. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  247. data/lib/plaid/models/institutions_search_request.rb +2 -2
  248. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  249. data/lib/plaid/models/institutions_search_response.rb +1 -1
  250. data/lib/plaid/models/investment_filter.rb +2 -2
  251. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  252. data/lib/plaid/models/investment_transaction.rb +2 -2
  253. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  254. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  255. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  256. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  257. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  258. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  259. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  260. data/lib/plaid/models/item.rb +14 -2
  261. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  262. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  263. data/lib/plaid/models/item_application_list_request.rb +1 -1
  264. data/lib/plaid/models/item_application_list_response.rb +1 -1
  265. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  266. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  267. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  268. data/lib/plaid/models/item_error_webhook.rb +1 -1
  269. data/lib/plaid/models/item_get_request.rb +1 -1
  270. data/lib/plaid/models/item_get_response.rb +1 -1
  271. data/lib/plaid/models/item_import_request.rb +1 -1
  272. data/lib/plaid/models/item_import_request_options.rb +1 -1
  273. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  274. data/lib/plaid/models/item_import_response.rb +1 -1
  275. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  276. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  277. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  278. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  279. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  280. data/lib/plaid/models/item_remove_request.rb +1 -1
  281. data/lib/plaid/models/item_remove_response.rb +1 -1
  282. data/lib/plaid/models/item_status.rb +1 -1
  283. data/lib/plaid/models/item_status_investments.rb +1 -1
  284. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  285. data/lib/plaid/models/item_status_nullable.rb +1 -1
  286. data/lib/plaid/models/item_status_transactions.rb +1 -1
  287. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  288. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  289. data/lib/plaid/models/jwk_public_key.rb +1 -1
  290. data/lib/plaid/models/jwt_header.rb +1 -1
  291. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  292. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  293. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  294. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  295. data/lib/plaid/models/liabilities_object.rb +1 -1
  296. data/lib/plaid/models/liability_override.rb +1 -1
  297. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  298. data/lib/plaid/models/link_token_create_request.rb +14 -5
  299. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  300. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  301. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  302. data/lib/plaid/models/link_token_create_request_income_verification.rb +17 -5
  303. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  304. data/lib/plaid/models/link_token_create_request_transfer.rb +220 -0
  305. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  306. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  307. data/lib/plaid/models/link_token_create_response.rb +1 -1
  308. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  309. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  310. data/lib/plaid/models/link_token_get_request.rb +1 -1
  311. data/lib/plaid/models/link_token_get_response.rb +1 -1
  312. data/lib/plaid/models/loan_filter.rb +1 -1
  313. data/lib/plaid/models/location.rb +3 -3
  314. data/lib/plaid/models/meta.rb +1 -1
  315. data/lib/plaid/models/mfa.rb +1 -1
  316. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  317. data/lib/plaid/models/mortgage_liability.rb +1 -1
  318. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  319. data/lib/plaid/models/net_pay.rb +54 -10
  320. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  321. data/lib/plaid/models/numbers.rb +1 -1
  322. data/lib/plaid/models/numbers_ach.rb +2 -2
  323. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  324. data/lib/plaid/models/numbers_bacs.rb +1 -1
  325. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  326. data/lib/plaid/models/numbers_eft.rb +1 -1
  327. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  328. data/lib/plaid/models/numbers_international.rb +1 -1
  329. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  330. data/lib/plaid/models/override_account_type.rb +1 -1
  331. data/lib/plaid/models/override_accounts.rb +1 -1
  332. data/lib/plaid/models/owner.rb +1 -1
  333. data/lib/plaid/models/owner_override.rb +1 -1
  334. data/lib/plaid/models/pay.rb +1 -1
  335. data/lib/plaid/models/pay_frequency.rb +2 -37
  336. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  337. data/lib/plaid/models/pay_period_details.rb +95 -28
  338. data/lib/plaid/models/payment_amount.rb +1 -1
  339. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  340. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  341. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  342. data/lib/plaid/models/payment_initiation_payment.rb +11 -63
  343. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  344. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  345. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  346. data/lib/plaid/models/payment_initiation_payment_get_response.rb +11 -63
  347. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  348. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  349. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  350. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  351. data/lib/plaid/models/payment_initiation_payment_status.rb +46 -0
  352. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  353. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  354. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  355. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  356. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  357. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  358. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  359. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  360. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  361. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  362. data/lib/plaid/models/payment_initiation_refund.rb +1 -1
  363. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  364. data/lib/plaid/models/payment_meta.rb +1 -1
  365. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  366. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  367. data/lib/plaid/models/paystub.rb +45 -25
  368. data/lib/plaid/models/paystub_address.rb +40 -40
  369. data/lib/plaid/models/paystub_deduction.rb +1 -1
  370. data/lib/plaid/models/paystub_details.rb +2 -37
  371. data/lib/plaid/models/paystub_employer.rb +15 -15
  372. data/lib/plaid/models/paystub_override.rb +1 -1
  373. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  374. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  375. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  376. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  377. data/lib/plaid/models/{distribution_details.rb → paystub_verification.rb} +26 -53
  378. data/lib/plaid/models/paystub_verification_status.rb +41 -0
  379. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  380. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  381. data/lib/plaid/models/personal_finance_category.rb +1 -1
  382. data/lib/plaid/models/phone_number.rb +1 -1
  383. data/lib/plaid/models/platform_ids.rb +1 -1
  384. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  385. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  386. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  387. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  388. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  389. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  390. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  391. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  392. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  393. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  394. data/lib/plaid/models/processor_number.rb +1 -1
  395. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  396. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  397. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  398. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  399. data/lib/plaid/models/product_access.rb +5 -5
  400. data/lib/plaid/models/product_status.rb +2 -2
  401. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  402. data/lib/plaid/models/products.rb +1 -1
  403. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  404. data/lib/plaid/models/pslf_status.rb +1 -1
  405. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  406. data/lib/plaid/models/recipient_bacs.rb +1 -1
  407. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  408. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  409. data/lib/plaid/models/removed_transaction.rb +220 -0
  410. data/lib/plaid/models/requested_scopes.rb +1 -1
  411. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  412. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  413. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  414. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  415. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +17 -2
  416. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  417. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  418. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  419. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  420. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  421. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  422. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  423. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  424. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  425. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  426. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  427. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  428. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  429. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  430. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  431. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  432. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  433. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +254 -0
  434. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +239 -0
  435. data/lib/plaid/models/scopes.rb +1 -1
  436. data/lib/plaid/models/scopes_context.rb +1 -1
  437. data/lib/plaid/models/scopes_nullable.rb +1 -1
  438. data/lib/plaid/models/security.rb +1 -1
  439. data/lib/plaid/models/security_override.rb +1 -1
  440. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  441. data/lib/plaid/models/servicer_address_data.rb +1 -1
  442. data/lib/plaid/models/signal_address_data.rb +1 -1
  443. data/lib/plaid/models/signal_decision_report_request.rb +63 -5
  444. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  445. data/lib/plaid/models/signal_device.rb +1 -1
  446. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  447. data/lib/plaid/models/signal_evaluate_request.rb +22 -2
  448. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  449. data/lib/plaid/models/signal_person_name.rb +1 -1
  450. data/lib/plaid/models/signal_return_report_request.rb +31 -1
  451. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  452. data/lib/plaid/models/signal_scores.rb +1 -1
  453. data/lib/plaid/models/signal_user.rb +1 -1
  454. data/lib/plaid/models/standalone_account_type.rb +2 -2
  455. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  456. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  457. data/lib/plaid/models/student_loan.rb +1 -1
  458. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  459. data/lib/plaid/models/student_loan_status.rb +1 -1
  460. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  461. data/lib/plaid/models/taxform.rb +12 -2
  462. data/lib/plaid/models/taxpayer_id.rb +14 -2
  463. data/lib/plaid/models/total.rb +2 -37
  464. data/lib/plaid/models/total_canonical_description.rb +54 -0
  465. data/lib/plaid/models/transaction.rb +23 -23
  466. data/lib/plaid/models/transaction_all_of.rb +2 -24
  467. data/lib/plaid/models/transaction_base.rb +27 -5
  468. data/lib/plaid/models/transaction_code.rb +1 -1
  469. data/lib/plaid/models/transaction_data.rb +1 -1
  470. data/lib/plaid/models/transaction_override.rb +3 -3
  471. data/lib/plaid/models/transaction_stream.rb +1 -1
  472. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  473. data/lib/plaid/models/transactions_get_request.rb +1 -1
  474. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  475. data/lib/plaid/models/transactions_get_response.rb +1 -1
  476. data/lib/plaid/models/transactions_recurring_get_request.rb +11 -1
  477. data/lib/plaid/models/transactions_recurring_get_response.rb +6 -1
  478. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  479. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  480. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  481. data/lib/plaid/models/transactions_sync_request.rb +293 -0
  482. data/lib/plaid/models/transactions_sync_response.rb +306 -0
  483. data/lib/plaid/models/transfer.rb +12 -2
  484. data/lib/plaid/models/transfer_authorization.rb +1 -1
  485. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  486. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  487. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  488. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  489. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  490. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  491. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  492. data/lib/plaid/models/transfer_create_request.rb +1 -1
  493. data/lib/plaid/models/transfer_create_response.rb +1 -1
  494. data/lib/plaid/models/transfer_event.rb +26 -6
  495. data/lib/plaid/models/transfer_event_list_request.rb +12 -2
  496. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  497. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  498. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  499. data/lib/plaid/models/transfer_event_type.rb +3 -1
  500. data/lib/plaid/models/transfer_failure.rb +1 -1
  501. data/lib/plaid/models/transfer_get_request.rb +1 -1
  502. data/lib/plaid/models/transfer_get_response.rb +1 -1
  503. data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
  504. data/lib/plaid/models/transfer_intent_create_request.rb +376 -0
  505. data/lib/plaid/models/transfer_intent_create_response.rb +408 -0
  506. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +240 -0
  507. data/lib/plaid/models/transfer_intent_get_request.rb +255 -0
  508. data/lib/plaid/models/transfer_intent_get_response.rb +467 -0
  509. data/lib/plaid/models/transfer_list_request.rb +1 -1
  510. data/lib/plaid/models/transfer_list_response.rb +1 -1
  511. data/lib/plaid/models/transfer_network.rb +1 -1
  512. data/lib/plaid/models/transfer_status.rb +1 -1
  513. data/lib/plaid/models/transfer_sweep.rb +250 -0
  514. data/lib/plaid/models/transfer_sweep_get_request.rb +245 -0
  515. data/lib/plaid/models/transfer_sweep_get_response.rb +239 -0
  516. data/lib/plaid/models/transfer_sweep_list_request.rb +330 -0
  517. data/lib/plaid/models/transfer_sweep_list_response.rb +241 -0
  518. data/lib/plaid/models/transfer_sweep_status.rb +41 -0
  519. data/lib/plaid/models/transfer_type.rb +1 -1
  520. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  521. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  522. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  523. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  524. data/lib/plaid/models/user_custom_password.rb +1 -1
  525. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  526. data/lib/plaid/models/verification_attribute.rb +255 -0
  527. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  528. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  529. data/lib/plaid/models/verification_status.rb +1 -1
  530. data/lib/plaid/models/w2.rb +1 -1
  531. data/lib/plaid/models/w2_box12.rb +1 -1
  532. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  533. data/lib/plaid/models/wallet_balance.rb +240 -0
  534. data/lib/plaid/models/wallet_get_request.rb +266 -0
  535. data/lib/plaid/models/wallet_get_response.rb +250 -0
  536. data/lib/plaid/models/wallet_transaction.rb +346 -0
  537. data/lib/plaid/models/wallet_transaction_amount.rb +306 -0
  538. data/lib/plaid/models/wallet_transaction_counterparty.rb +260 -0
  539. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +288 -0
  540. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +224 -0
  541. data/lib/plaid/models/wallet_transaction_execute_request.rb +384 -0
  542. data/lib/plaid/models/wallet_transaction_execute_response.rb +254 -0
  543. data/lib/plaid/models/wallet_transaction_status.rb +41 -0
  544. data/lib/plaid/models/wallet_transactions_list_request.rb +331 -0
  545. data/lib/plaid/models/wallet_transactions_list_response.rb +252 -0
  546. data/lib/plaid/models/warning.rb +1 -1
  547. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  548. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  549. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  550. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  551. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  552. data/lib/plaid/version.rb +2 -2
  553. data/lib/plaid.rb +51 -2
  554. data/pkg/plaid-13.2.0.gem +0 -0
  555. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  556. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  557. data/pkg/plaid-14.0.0.gem +0 -0
  558. data/pkg/plaid-14.1.0.gem +0 -0
  559. data/pkg/plaid-14.3.0.gem +0 -0
  560. data/pkg/plaid-14.6.0.gem +0 -0
  561. data/plaid.gemspec +1 -1
  562. data/templates/ruby/api_client.mustache +1 -1
  563. data/test/test_income_verifications.rb +81 -0
  564. metadata +71 -27
  565. data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +0 -118
  566. data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +0 -118
  567. data/doc/rdoc/classes/Plaid/AddToken.html +0 -197
  568. data/pkg/plaid-10.0.0.gem +0 -0
  569. data/pkg/plaid-11.0.0.gem +0 -0
  570. data/pkg/plaid-12.0.0.gem +0 -0
  571. data/pkg/plaid-13.1.0.gem +0 -0
  572. data/pkg/plaid-14.4.0.gem +0 -0
  573. data/pkg/plaid-8.5.0.gem +0 -0
  574. data/pkg/plaid-8.6.0.gem +0 -0
  575. data/pkg/plaid-8.7.0.gem +0 -0
  576. data/pkg/plaid-8.8.0.gem +0 -0
  577. data/pkg/plaid-9.0.0.gem +0 -0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -15,33 +15,10 @@ require 'time'
15
15
 
16
16
  module Plaid
17
17
  class PayFrequency
18
- # The frequency of the pay period.
19
18
  attr_accessor :value
20
19
 
21
20
  attr_accessor :verification_status
22
21
 
23
- class EnumAttributeValidator
24
- attr_reader :datatype
25
- attr_reader :allowable_values
26
-
27
- def initialize(datatype, allowable_values)
28
- @allowable_values = allowable_values.map do |value|
29
- case datatype.to_s
30
- when /Integer/i
31
- value.to_i
32
- when /Float/i
33
- value.to_f
34
- else
35
- value
36
- end
37
- end
38
- end
39
-
40
- def valid?(value)
41
- !value || allowable_values.include?(value)
42
- end
43
- end
44
-
45
22
  # Attribute mapping from ruby-style variable name to JSON key.
46
23
  def self.attribute_map
47
24
  {
@@ -58,7 +35,7 @@ module Plaid
58
35
  # Attribute type mapping.
59
36
  def self.openapi_types
60
37
  {
61
- :'value' => :'String',
38
+ :'value' => :'PayFrequencyValue',
62
39
  :'verification_status' => :'VerificationStatus'
63
40
  }
64
41
  end
@@ -112,22 +89,10 @@ module Plaid
112
89
  # @return true if the model is valid
113
90
  def valid?
114
91
  return false if @value.nil?
115
- value_validator = EnumAttributeValidator.new('String', ["monthly", "semimonthly", "weekly", "biweekly", "unknown", "null"])
116
- return false unless value_validator.valid?(@value)
117
92
  return false if @verification_status.nil?
118
93
  true
119
94
  end
120
95
 
121
- # Custom attribute writer method checking allowed values (enum).
122
- # @param [Object] value Object to be assigned
123
- def value=(value)
124
- validator = EnumAttributeValidator.new('String', ["monthly", "semimonthly", "weekly", "biweekly", "unknown", "null"])
125
- unless validator.valid?(value)
126
- fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
127
- end
128
- @value = value
129
- end
130
-
131
96
  # Checks equality by comparing each attribute.
132
97
  # @param [Object] Object to be compared
133
98
  def ==(o)
@@ -0,0 +1,43 @@
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.54.2
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 PayFrequencyValue
18
+ MONTHLY = "monthly".freeze
19
+ SEMIMONTHLY = "semimonthly".freeze
20
+ WEEKLY = "weekly".freeze
21
+ BIWEEKLY = "biweekly".freeze
22
+ UNKNOWN = "unknown".freeze
23
+ NULL = "null".freeze
24
+
25
+ # Builds the enum from string
26
+ # @param [String] The enum value in the form of the string
27
+ # @return [String] The enum value
28
+ def self.build_from_hash(value)
29
+ new.build_from_hash(value)
30
+ end
31
+
32
+ # Builds the enum from string
33
+ # @param [String] The enum value in the form of the string
34
+ # @return [String] The enum value
35
+ def build_from_hash(value)
36
+ # We do not validate that the value is one of the enums set in the OpenAPI
37
+ # file because we want to be able to add to our list of enums without
38
+ # breaking this client library.
39
+ value
40
+ end
41
+ end
42
+
43
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -16,29 +16,62 @@ require 'time'
16
16
  module Plaid
17
17
  # Details about the pay period.
18
18
  class PayPeriodDetails
19
- # The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
20
- attr_accessor :start_date
19
+ # The amount of the paycheck.
20
+ attr_accessor :check_amount
21
+
22
+ attr_accessor :distribution_breakdown
21
23
 
22
24
  # The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
23
25
  attr_accessor :end_date
24
26
 
27
+ # Total earnings before tax/deductions.
28
+ attr_accessor :gross_earnings
29
+
30
+ # The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
31
+ attr_accessor :pay_date
32
+
33
+ # The frequency at which an individual is paid.
34
+ attr_accessor :pay_frequency
35
+
25
36
  # The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
26
37
  attr_accessor :pay_day
27
38
 
28
- # Total earnings before tax.
29
- attr_accessor :gross_earnings
39
+ # The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
40
+ attr_accessor :start_date
30
41
 
31
- # The net amount of the paycheck.
32
- attr_accessor :check_amount
42
+ class EnumAttributeValidator
43
+ attr_reader :datatype
44
+ attr_reader :allowable_values
45
+
46
+ def initialize(datatype, allowable_values)
47
+ @allowable_values = allowable_values.map do |value|
48
+ case datatype.to_s
49
+ when /Integer/i
50
+ value.to_i
51
+ when /Float/i
52
+ value.to_f
53
+ else
54
+ value
55
+ end
56
+ end
57
+ end
58
+
59
+ def valid?(value)
60
+ !value || allowable_values.include?(value)
61
+ end
62
+ end
33
63
 
34
64
  # Attribute mapping from ruby-style variable name to JSON key.
35
65
  def self.attribute_map
36
66
  {
37
- :'start_date' => :'start_date',
67
+ :'check_amount' => :'check_amount',
68
+ :'distribution_breakdown' => :'distribution_breakdown',
38
69
  :'end_date' => :'end_date',
39
- :'pay_day' => :'pay_day',
40
70
  :'gross_earnings' => :'gross_earnings',
41
- :'check_amount' => :'check_amount'
71
+ :'pay_date' => :'pay_date',
72
+ :'pay_frequency' => :'pay_frequency',
73
+ :'pay_day' => :'pay_day',
74
+ :'start_date' => :'start_date'
42
75
  }
43
76
  end
44
77
 
@@ -50,22 +83,27 @@ module Plaid
50
83
  # Attribute type mapping.
51
84
  def self.openapi_types
52
85
  {
53
- :'start_date' => :'Date',
86
+ :'check_amount' => :'Float',
87
+ :'distribution_breakdown' => :'Array<DistributionBreakdown>',
54
88
  :'end_date' => :'Date',
55
- :'pay_day' => :'Date',
56
89
  :'gross_earnings' => :'Float',
57
- :'check_amount' => :'Float'
90
+ :'pay_date' => :'Date',
91
+ :'pay_frequency' => :'String',
92
+ :'pay_day' => :'Date',
93
+ :'start_date' => :'Date'
58
94
  }
59
95
  end
60
96
 
61
97
  # List of attributes with nullable: true
62
98
  def self.openapi_nullable
63
99
  Set.new([
64
- :'start_date',
100
+ :'check_amount',
65
101
  :'end_date',
66
- :'pay_day',
67
102
  :'gross_earnings',
68
- :'check_amount'
103
+ :'pay_date',
104
+ :'pay_frequency',
105
+ :'pay_day',
106
+ :'start_date'
69
107
  ])
70
108
  end
71
109
 
@@ -84,24 +122,38 @@ module Plaid
84
122
  h[k.to_sym] = v
85
123
  }
86
124
 
87
- if attributes.key?(:'start_date')
88
- self.start_date = attributes[:'start_date']
125
+ if attributes.key?(:'check_amount')
126
+ self.check_amount = attributes[:'check_amount']
89
127
  end
90
128
 
91
- if attributes.key?(:'end_date')
92
- self.end_date = attributes[:'end_date']
129
+ if attributes.key?(:'distribution_breakdown')
130
+ if (value = attributes[:'distribution_breakdown']).is_a?(Array)
131
+ self.distribution_breakdown = value
132
+ end
93
133
  end
94
134
 
95
- if attributes.key?(:'pay_day')
96
- self.pay_day = attributes[:'pay_day']
135
+ if attributes.key?(:'end_date')
136
+ self.end_date = attributes[:'end_date']
97
137
  end
98
138
 
99
139
  if attributes.key?(:'gross_earnings')
100
140
  self.gross_earnings = attributes[:'gross_earnings']
101
141
  end
102
142
 
103
- if attributes.key?(:'check_amount')
104
- self.check_amount = attributes[:'check_amount']
143
+ if attributes.key?(:'pay_date')
144
+ self.pay_date = attributes[:'pay_date']
145
+ end
146
+
147
+ if attributes.key?(:'pay_frequency')
148
+ self.pay_frequency = attributes[:'pay_frequency']
149
+ end
150
+
151
+ if attributes.key?(:'pay_day')
152
+ self.pay_day = attributes[:'pay_day']
153
+ end
154
+
155
+ if attributes.key?(:'start_date')
156
+ self.start_date = attributes[:'start_date']
105
157
  end
106
158
  end
107
159
 
@@ -115,19 +167,34 @@ module Plaid
115
167
  # Check to see if the all the properties in the model are valid
116
168
  # @return true if the model is valid
117
169
  def valid?
170
+ pay_frequency_validator = EnumAttributeValidator.new('String', ["PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null"])
171
+ return false unless pay_frequency_validator.valid?(@pay_frequency)
118
172
  true
119
173
  end
120
174
 
175
+ # Custom attribute writer method checking allowed values (enum).
176
+ # @param [Object] pay_frequency Object to be assigned
177
+ def pay_frequency=(pay_frequency)
178
+ validator = EnumAttributeValidator.new('String', ["PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null"])
179
+ unless validator.valid?(pay_frequency)
180
+ fail ArgumentError, "invalid value for \"pay_frequency\", must be one of #{validator.allowable_values}."
181
+ end
182
+ @pay_frequency = pay_frequency
183
+ end
184
+
121
185
  # Checks equality by comparing each attribute.
122
186
  # @param [Object] Object to be compared
123
187
  def ==(o)
124
188
  return true if self.equal?(o)
125
189
  self.class == o.class &&
126
- start_date == o.start_date &&
190
+ check_amount == o.check_amount &&
191
+ distribution_breakdown == o.distribution_breakdown &&
127
192
  end_date == o.end_date &&
128
- pay_day == o.pay_day &&
129
193
  gross_earnings == o.gross_earnings &&
130
- check_amount == o.check_amount
194
+ pay_date == o.pay_date &&
195
+ pay_frequency == o.pay_frequency &&
196
+ pay_day == o.pay_day &&
197
+ start_date == o.start_date
131
198
  end
132
199
 
133
200
  # @see the `==` method
@@ -139,7 +206,7 @@ module Plaid
139
206
  # Calculates hash code according to all attributes.
140
207
  # @return [Integer] Hash code
141
208
  def hash
142
- [start_date, end_date, pay_day, gross_earnings, check_amount].hash
209
+ [check_amount, distribution_breakdown, end_date, gross_earnings, pay_date, pay_frequency, pay_day, start_date].hash
143
210
  end
144
211
 
145
212
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -21,7 +21,6 @@ module Plaid
21
21
 
22
22
  attr_accessor :amount
23
23
 
24
- # The status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
25
24
  attr_accessor :status
26
25
 
27
26
  # The ID of the recipient
@@ -48,30 +47,8 @@ module Plaid
48
47
  # Initiated refunds associated with the payment.
49
48
  attr_accessor :initiated_refunds
50
49
 
51
- # The EMI (E-Money Institution) account that this payment is associated with, if any. This EMI account is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
52
- attr_accessor :emi_account_id
53
-
54
- class EnumAttributeValidator
55
- attr_reader :datatype
56
- attr_reader :allowable_values
57
-
58
- def initialize(datatype, allowable_values)
59
- @allowable_values = allowable_values.map do |value|
60
- case datatype.to_s
61
- when /Integer/i
62
- value.to_i
63
- when /Float/i
64
- value.to_f
65
- else
66
- value
67
- end
68
- end
69
- end
70
-
71
- def valid?(value)
72
- !value || allowable_values.include?(value)
73
- end
74
- end
50
+ # The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
51
+ attr_accessor :wallet_id
75
52
 
76
53
  # Attribute mapping from ruby-style variable name to JSON key.
77
54
  def self.attribute_map
@@ -88,7 +65,7 @@ module Plaid
88
65
  :'bacs' => :'bacs',
89
66
  :'iban' => :'iban',
90
67
  :'initiated_refunds' => :'initiated_refunds',
91
- :'emi_account_id' => :'emi_account_id'
68
+ :'wallet_id' => :'wallet_id'
92
69
  }
93
70
  end
94
71
 
@@ -102,7 +79,7 @@ module Plaid
102
79
  {
103
80
  :'payment_id' => :'String',
104
81
  :'amount' => :'PaymentAmount',
105
- :'status' => :'String',
82
+ :'status' => :'PaymentInitiationPaymentStatus',
106
83
  :'recipient_id' => :'String',
107
84
  :'reference' => :'String',
108
85
  :'adjusted_reference' => :'String',
@@ -112,7 +89,7 @@ module Plaid
112
89
  :'bacs' => :'SenderBACSNullable',
113
90
  :'iban' => :'String',
114
91
  :'initiated_refunds' => :'Array<PaymentInitiationRefund>',
115
- :'emi_account_id' => :'String'
92
+ :'wallet_id' => :'String'
116
93
  }
117
94
  end
118
95
 
@@ -124,7 +101,7 @@ module Plaid
124
101
  :'refund_details',
125
102
  :'bacs',
126
103
  :'iban',
127
- :'emi_account_id'
104
+ :'wallet_id'
128
105
  ])
129
106
  end
130
107
 
@@ -193,8 +170,8 @@ module Plaid
193
170
  end
194
171
  end
195
172
 
196
- if attributes.key?(:'emi_account_id')
197
- self.emi_account_id = attributes[:'emi_account_id']
173
+ if attributes.key?(:'wallet_id')
174
+ self.wallet_id = attributes[:'wallet_id']
198
175
  end
199
176
  end
200
177
 
@@ -226,11 +203,6 @@ module Plaid
226
203
  invalid_properties.push('invalid value for "last_status_update", last_status_update cannot be nil.')
227
204
  end
228
205
 
229
- if !@emi_account_id.nil? && @emi_account_id.to_s.length < 1
230
- invalid_properties.push('invalid value for "emi_account_id", the character length must be great than or equal to 1.')
231
- end
232
-
233
-
234
206
  invalid_properties
235
207
  end
236
208
 
@@ -240,36 +212,12 @@ module Plaid
240
212
  return false if @payment_id.nil?
241
213
  return false if @amount.nil?
242
214
  return false if @status.nil?
243
- status_validator = EnumAttributeValidator.new('String', ["PAYMENT_STATUS_INPUT_NEEDED", "PAYMENT_STATUS_PROCESSING", "PAYMENT_STATUS_INITIATED", "PAYMENT_STATUS_COMPLETED", "PAYMENT_STATUS_INSUFFICIENT_FUNDS", "PAYMENT_STATUS_FAILED", "PAYMENT_STATUS_BLOCKED", "PAYMENT_STATUS_UNKNOWN"])
244
- return false unless status_validator.valid?(@status)
245
215
  return false if @recipient_id.nil?
246
216
  return false if @reference.nil?
247
217
  return false if @last_status_update.nil?
248
- return false if !@emi_account_id.nil? && @emi_account_id.to_s.length < 1
249
218
  true
250
219
  end
251
220
 
252
- # Custom attribute writer method checking allowed values (enum).
253
- # @param [Object] status Object to be assigned
254
- def status=(status)
255
- validator = EnumAttributeValidator.new('String', ["PAYMENT_STATUS_INPUT_NEEDED", "PAYMENT_STATUS_PROCESSING", "PAYMENT_STATUS_INITIATED", "PAYMENT_STATUS_COMPLETED", "PAYMENT_STATUS_INSUFFICIENT_FUNDS", "PAYMENT_STATUS_FAILED", "PAYMENT_STATUS_BLOCKED", "PAYMENT_STATUS_UNKNOWN"])
256
- unless validator.valid?(status)
257
- fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
258
- end
259
- @status = status
260
- end
261
-
262
- # Custom attribute writer method with validation
263
- # @param [Object] emi_account_id Value to be assigned
264
- def emi_account_id=(emi_account_id)
265
- if !emi_account_id.nil? && emi_account_id.to_s.length < 1
266
- fail ArgumentError, 'invalid value for "emi_account_id", the character length must be great than or equal to 1.'
267
- end
268
-
269
-
270
- @emi_account_id = emi_account_id
271
- end
272
-
273
221
  # Checks equality by comparing each attribute.
274
222
  # @param [Object] Object to be compared
275
223
  def ==(o)
@@ -287,7 +235,7 @@ module Plaid
287
235
  bacs == o.bacs &&
288
236
  iban == o.iban &&
289
237
  initiated_refunds == o.initiated_refunds &&
290
- emi_account_id == o.emi_account_id
238
+ wallet_id == o.wallet_id
291
239
  end
292
240
 
293
241
  # @see the `==` method
@@ -299,7 +247,7 @@ module Plaid
299
247
  # Calculates hash code according to all attributes.
300
248
  # @return [Integer] Hash code
301
249
  def hash
302
- [payment_id, amount, status, recipient_id, reference, adjusted_reference, last_status_update, schedule, refund_details, bacs, iban, initiated_refunds, emi_account_id].hash
250
+ [payment_id, amount, status, recipient_id, reference, adjusted_reference, last_status_update, schedule, refund_details, bacs, iban, initiated_refunds, wallet_id].hash
303
251
  end
304
252
 
305
253
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0