plaid 14.1.0 → 14.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (532) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +17 -2
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/PUBLISH.md +4 -3
  6. data/README.md +5 -5
  7. data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +118 -0
  8. data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +118 -0
  9. data/doc/rdoc/classes/Plaid/AddToken.html +197 -0
  10. data/doc/rdoc/classes/Plaid/Models/Payment.html +0 -17
  11. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +0 -17
  12. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +20 -23
  13. data/doc/rdoc/classes/Plaid.html +1 -1
  14. data/doc/rdoc/created.rid +28 -28
  15. data/doc/rdoc/files/LICENSE_txt.html +1 -1
  16. data/doc/rdoc/files/README_md.html +1 -1
  17. data/doc/rdoc/files/lib/plaid/client_rb.html +1 -1
  18. data/doc/rdoc/files/lib/plaid/errors_rb.html +1 -1
  19. data/doc/rdoc/files/lib/plaid/middleware_rb.html +1 -1
  20. data/doc/rdoc/files/lib/plaid/models_rb.html +1 -1
  21. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +1 -1
  22. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +1 -1
  23. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +1 -1
  24. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +1 -1
  25. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +1 -1
  26. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +1 -1
  27. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +1 -1
  28. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +1 -1
  29. data/doc/rdoc/files/lib/plaid/products/income_rb.html +1 -1
  30. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +1 -1
  31. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +1 -1
  32. data/doc/rdoc/files/lib/plaid/products/item_rb.html +1 -1
  33. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +1 -1
  34. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +1 -1
  35. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +1 -1
  36. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +1 -1
  37. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +1 -1
  38. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +1 -1
  39. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +1 -1
  40. data/doc/rdoc/files/lib/plaid/version_rb.html +1 -1
  41. data/doc/rdoc/files/lib/plaid_rb.html +1 -1
  42. data/doc/rdoc/js/navigation.js.gz +0 -0
  43. data/doc/rdoc/js/search_index.js +1 -1
  44. data/doc/rdoc/js/search_index.js.gz +0 -0
  45. data/doc/rdoc/js/searcher.js.gz +0 -0
  46. data/lib/plaid/api/plaid_api.rb +353 -28
  47. data/lib/plaid/api_client.rb +4 -4
  48. data/lib/plaid/api_error.rb +3 -3
  49. data/lib/plaid/configuration.rb +5 -4
  50. data/lib/plaid/models/account_access.rb +1 -1
  51. data/lib/plaid/models/account_assets.rb +1 -1
  52. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  53. data/lib/plaid/models/account_balance.rb +3 -3
  54. data/lib/plaid/models/account_base.rb +1 -1
  55. data/lib/plaid/models/account_filter.rb +1 -1
  56. data/lib/plaid/models/account_filters_response.rb +1 -1
  57. data/lib/plaid/models/account_identity.rb +1 -1
  58. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  59. data/lib/plaid/models/account_selection_cardinality.rb +5 -3
  60. data/lib/plaid/models/account_subtype.rb +6 -3
  61. data/lib/plaid/models/account_type.rb +5 -3
  62. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  63. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  64. data/lib/plaid/models/accounts_get_request.rb +1 -1
  65. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  66. data/lib/plaid/models/accounts_get_response.rb +1 -1
  67. data/lib/plaid/models/ach_class.rb +5 -3
  68. data/lib/plaid/models/address.rb +1 -1
  69. data/lib/plaid/models/address_data.rb +1 -1
  70. data/lib/plaid/models/address_data_nullable.rb +1 -1
  71. data/lib/plaid/models/address_nullable.rb +1 -1
  72. data/lib/plaid/models/application.rb +1 -1
  73. data/lib/plaid/models/application_get_request.rb +1 -1
  74. data/lib/plaid/models/application_get_response.rb +1 -1
  75. data/lib/plaid/models/apr.rb +1 -1
  76. data/lib/plaid/models/asset_report.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  79. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  80. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  82. data/lib/plaid/models/asset_report_create_request.rb +6 -6
  83. data/lib/plaid/models/asset_report_create_request_options.rb +3 -1
  84. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  85. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  86. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  87. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_item.rb +1 -1
  90. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  91. data/lib/plaid/models/asset_report_refresh_request.rb +7 -6
  92. data/lib/plaid/models/asset_report_refresh_request_options.rb +3 -1
  93. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  94. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  95. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  96. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  97. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  98. data/lib/plaid/models/asset_report_user.rb +1 -1
  99. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  100. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  101. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  102. data/lib/plaid/models/auth_get_request.rb +1 -1
  103. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  104. data/lib/plaid/models/auth_get_response.rb +1 -1
  105. data/lib/plaid/models/{income_verification_documents_download_response.rb → auth_metadata.rb} +13 -17
  106. data/lib/plaid/models/auth_supported_methods.rb +255 -0
  107. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  108. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  109. data/lib/plaid/models/bank_transfer.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_direction.rb +5 -3
  118. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_type.rb +5 -3
  124. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_network.rb +5 -3
  132. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_status.rb +5 -3
  134. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep_account.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
  137. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +330 -0
  139. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
  140. data/lib/plaid/models/bank_transfer_type.rb +5 -3
  141. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  142. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  143. data/lib/plaid/models/categories_get_response.rb +1 -1
  144. data/lib/plaid/models/category.rb +1 -1
  145. data/lib/plaid/models/cause.rb +1 -1
  146. data/lib/plaid/models/connected_application.rb +1 -1
  147. data/lib/plaid/models/country_code.rb +5 -3
  148. data/lib/plaid/models/credit_card_liability.rb +17 -2
  149. data/lib/plaid/models/credit_filter.rb +1 -1
  150. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  151. data/lib/plaid/models/deductions.rb +1 -1
  152. data/lib/plaid/models/default_update_webhook.rb +1 -1
  153. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  154. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  155. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  156. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  157. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  158. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  159. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  160. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  161. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  162. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  163. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  164. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  165. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  166. data/lib/plaid/models/depository_filter.rb +1 -1
  167. data/lib/plaid/models/distribution_details.rb +1 -1
  168. data/lib/plaid/models/document_metadata.rb +49 -5
  169. data/lib/plaid/models/earnings.rb +1 -1
  170. data/lib/plaid/models/earnings_total.rb +3 -3
  171. data/lib/plaid/models/email.rb +1 -1
  172. data/lib/plaid/models/employee.rb +1 -1
  173. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  174. data/lib/plaid/models/employer.rb +1 -1
  175. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  176. data/lib/plaid/models/employer_verification.rb +221 -0
  177. data/lib/plaid/models/employers_search_request.rb +1 -1
  178. data/lib/plaid/models/employers_search_response.rb +1 -1
  179. data/lib/plaid/models/employment_details.rb +1 -1
  180. data/lib/plaid/models/employment_verification.rb +306 -0
  181. data/lib/plaid/models/employment_verification_get_request.rb +245 -0
  182. data/lib/plaid/models/employment_verification_get_response.rb +252 -0
  183. data/lib/plaid/models/error.rb +1 -1
  184. data/lib/plaid/models/external_payment_options.rb +1 -1
  185. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  186. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  187. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  188. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  189. data/lib/plaid/models/health_incident.rb +1 -1
  190. data/lib/plaid/models/historical_balance.rb +1 -1
  191. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  192. data/lib/plaid/models/holding.rb +1 -1
  193. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  194. data/lib/plaid/models/holdings_override.rb +1 -1
  195. data/lib/plaid/models/identity_get_request.rb +1 -1
  196. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  197. data/lib/plaid/models/identity_get_response.rb +1 -1
  198. data/lib/plaid/models/incident_update.rb +1 -1
  199. data/lib/plaid/models/income_breakdown.rb +2 -2
  200. data/lib/plaid/models/income_override.rb +222 -0
  201. data/lib/plaid/models/income_summary.rb +1 -1
  202. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  203. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  204. data/lib/plaid/models/income_verification_create_request.rb +15 -5
  205. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  206. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -6
  207. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  208. data/lib/plaid/models/income_verification_paystub_get_response.rb +249 -0
  209. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  210. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  211. data/lib/plaid/models/income_verification_precheck_employer.rb +252 -0
  212. data/lib/plaid/models/income_verification_precheck_employer_address.rb +280 -0
  213. data/lib/plaid/models/{transfer_receiver_details.rb → income_verification_precheck_military_info.rb} +32 -22
  214. data/lib/plaid/models/income_verification_precheck_request.rb +271 -0
  215. data/lib/plaid/models/income_verification_precheck_response.rb +289 -0
  216. data/lib/plaid/models/income_verification_precheck_user.rb +252 -0
  217. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  218. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  219. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  220. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  221. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  222. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  223. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  224. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  225. data/lib/plaid/models/inflow_model.rb +1 -1
  226. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  227. data/lib/plaid/models/institution.rb +16 -6
  228. data/lib/plaid/models/institution_status.rb +1 -1
  229. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  230. data/lib/plaid/models/institutions_get_by_id_request_options.rb +14 -2
  231. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  232. data/lib/plaid/models/institutions_get_request.rb +1 -1
  233. data/lib/plaid/models/institutions_get_request_options.rb +14 -2
  234. data/lib/plaid/models/institutions_get_response.rb +1 -1
  235. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  236. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  237. data/lib/plaid/models/institutions_search_request.rb +1 -1
  238. data/lib/plaid/models/institutions_search_request_options.rb +14 -2
  239. data/lib/plaid/models/institutions_search_response.rb +1 -1
  240. data/lib/plaid/models/investment_filter.rb +1 -1
  241. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  242. data/lib/plaid/models/investment_transaction.rb +1 -1
  243. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  244. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  245. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  246. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  247. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  248. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  249. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  250. data/lib/plaid/models/item.rb +1 -1
  251. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  252. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  253. data/lib/plaid/models/item_application_list_request.rb +1 -1
  254. data/lib/plaid/models/item_application_list_response.rb +1 -1
  255. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  256. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  257. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  258. data/lib/plaid/models/item_error_webhook.rb +1 -1
  259. data/lib/plaid/models/item_get_request.rb +1 -1
  260. data/lib/plaid/models/item_get_response.rb +1 -1
  261. data/lib/plaid/models/item_import_request.rb +1 -1
  262. data/lib/plaid/models/item_import_request_options.rb +1 -1
  263. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  264. data/lib/plaid/models/item_import_response.rb +1 -1
  265. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  266. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  267. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  268. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  269. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  270. data/lib/plaid/models/item_remove_request.rb +1 -1
  271. data/lib/plaid/models/item_remove_response.rb +1 -1
  272. data/lib/plaid/models/item_status.rb +1 -1
  273. data/lib/plaid/models/item_status_investments.rb +1 -1
  274. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  275. data/lib/plaid/models/item_status_nullable.rb +1 -1
  276. data/lib/plaid/models/item_status_transactions.rb +1 -1
  277. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  278. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  279. data/lib/plaid/models/jwk_public_key.rb +1 -1
  280. data/lib/plaid/models/jwt_header.rb +1 -1
  281. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  282. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  283. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  284. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  285. data/lib/plaid/models/liabilities_object.rb +1 -1
  286. data/lib/plaid/models/liability_override.rb +1 -1
  287. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  288. data/lib/plaid/models/link_token_create_request.rb +15 -6
  289. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  290. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  291. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  292. data/lib/plaid/models/link_token_create_request_income_verification.rb +15 -10
  293. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  294. data/lib/plaid/models/link_token_create_request_update.rb +222 -0
  295. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  296. data/lib/plaid/models/link_token_create_response.rb +1 -1
  297. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  298. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  299. data/lib/plaid/models/link_token_get_request.rb +1 -1
  300. data/lib/plaid/models/link_token_get_response.rb +1 -1
  301. data/lib/plaid/models/loan_filter.rb +1 -1
  302. data/lib/plaid/models/location.rb +1 -1
  303. data/lib/plaid/models/meta.rb +1 -1
  304. data/lib/plaid/models/mfa.rb +1 -1
  305. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  306. data/lib/plaid/models/mortgage_liability.rb +1 -1
  307. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  308. data/lib/plaid/models/net_pay.rb +1 -1
  309. data/lib/plaid/models/new_accounts_available_webhook.rb +250 -0
  310. data/lib/plaid/models/numbers.rb +1 -1
  311. data/lib/plaid/models/numbers_ach.rb +1 -1
  312. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  313. data/lib/plaid/models/numbers_bacs.rb +1 -1
  314. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  315. data/lib/plaid/models/numbers_eft.rb +1 -1
  316. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  317. data/lib/plaid/models/numbers_international.rb +1 -1
  318. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  319. data/lib/plaid/models/override_account_type.rb +6 -3
  320. data/lib/plaid/models/override_accounts.rb +14 -5
  321. data/lib/plaid/models/owner.rb +1 -1
  322. data/lib/plaid/models/owner_override.rb +1 -1
  323. data/lib/plaid/models/pay.rb +1 -1
  324. data/lib/plaid/models/pay_frequency.rb +1 -1
  325. data/lib/plaid/models/pay_period_details.rb +1 -1
  326. data/lib/plaid/models/payment_amount.rb +1 -1
  327. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  328. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  329. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  330. data/lib/plaid/models/payment_initiation_payment.rb +14 -2
  331. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  332. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  333. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  334. data/lib/plaid/models/payment_initiation_payment_get_response.rb +14 -2
  335. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  336. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  337. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
  338. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +289 -0
  339. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  340. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  341. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  342. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  343. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  344. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  345. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  346. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  347. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  348. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  349. data/lib/plaid/models/payment_initiation_refund.rb +303 -0
  350. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  351. data/lib/plaid/models/payment_meta.rb +1 -1
  352. data/lib/plaid/models/payment_schedule_interval.rb +5 -3
  353. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  354. data/lib/plaid/models/paystub.rb +1 -1
  355. data/lib/plaid/models/paystub_address.rb +1 -1
  356. data/lib/plaid/models/paystub_deduction.rb +1 -1
  357. data/lib/plaid/models/paystub_details.rb +1 -1
  358. data/lib/plaid/models/paystub_employer.rb +1 -1
  359. data/lib/plaid/models/paystub_override.rb +248 -0
  360. data/lib/plaid/models/paystub_override_employee.rb +229 -0
  361. data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
  362. data/lib/plaid/models/paystub_override_employer.rb +220 -0
  363. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  364. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  365. data/lib/plaid/models/personal_finance_category.rb +240 -0
  366. data/lib/plaid/models/phone_number.rb +1 -1
  367. data/lib/plaid/models/platform_ids.rb +243 -0
  368. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  369. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  370. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  371. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  372. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  373. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  374. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  375. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  376. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  377. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  378. data/lib/plaid/models/processor_number.rb +1 -1
  379. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  380. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  381. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  382. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  383. data/lib/plaid/models/product_access.rb +1 -1
  384. data/lib/plaid/models/product_status.rb +1 -1
  385. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  386. data/lib/plaid/models/products.rb +6 -3
  387. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  388. data/lib/plaid/models/pslf_status.rb +1 -1
  389. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  390. data/lib/plaid/models/recipient_bacs.rb +1 -1
  391. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  392. data/lib/plaid/models/{transfer_direction.rb → recurring_transaction_frequency.rb} +11 -7
  393. data/lib/plaid/models/requested_scopes.rb +1 -1
  394. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  395. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  396. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  397. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  398. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  399. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  400. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  401. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  402. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  403. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  404. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  405. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  406. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  407. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  408. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  409. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  410. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  411. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  412. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  413. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  414. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  415. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  416. data/lib/plaid/models/scopes.rb +1 -1
  417. data/lib/plaid/models/scopes_context.rb +5 -3
  418. data/lib/plaid/models/scopes_nullable.rb +1 -1
  419. data/lib/plaid/models/security.rb +1 -1
  420. data/lib/plaid/models/security_override.rb +1 -1
  421. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  422. data/lib/plaid/models/servicer_address_data.rb +1 -1
  423. data/lib/plaid/models/signal_address_data.rb +1 -1
  424. data/lib/plaid/models/signal_decision_report_request.rb +2 -1
  425. data/lib/plaid/models/signal_decision_report_response.rb +2 -1
  426. data/lib/plaid/models/signal_device.rb +1 -1
  427. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  428. data/lib/plaid/models/signal_evaluate_request.rb +2 -1
  429. data/lib/plaid/models/signal_evaluate_response.rb +2 -6
  430. data/lib/plaid/models/signal_person_name.rb +1 -1
  431. data/lib/plaid/models/signal_return_report_request.rb +2 -1
  432. data/lib/plaid/models/signal_return_report_response.rb +2 -1
  433. data/lib/plaid/models/signal_scores.rb +2 -1
  434. data/lib/plaid/models/signal_user.rb +1 -1
  435. data/lib/plaid/models/standalone_account_type.rb +1 -1
  436. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  437. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  438. data/lib/plaid/models/student_loan.rb +1 -1
  439. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  440. data/lib/plaid/models/student_loan_status.rb +1 -1
  441. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  442. data/lib/plaid/models/taxform.rb +1 -1
  443. data/lib/plaid/models/taxpayer_id.rb +1 -1
  444. data/lib/plaid/models/total.rb +3 -3
  445. data/lib/plaid/models/transaction.rb +16 -6
  446. data/lib/plaid/models/transaction_all_of.rb +16 -6
  447. data/lib/plaid/models/transaction_base.rb +1 -1
  448. data/lib/plaid/models/transaction_code.rb +5 -3
  449. data/lib/plaid/models/transaction_data.rb +1 -1
  450. data/lib/plaid/models/transaction_override.rb +1 -1
  451. data/lib/plaid/models/transaction_stream.rb +377 -0
  452. data/lib/plaid/models/transaction_stream_amount.rb +242 -0
  453. data/lib/plaid/models/transactions_get_request.rb +1 -1
  454. data/lib/plaid/models/transactions_get_request_options.rb +18 -6
  455. data/lib/plaid/models/transactions_get_response.rb +1 -1
  456. data/lib/plaid/models/transactions_recurring_get_request.rb +252 -0
  457. data/lib/plaid/models/transactions_recurring_get_response.rb +254 -0
  458. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  459. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  460. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  461. data/lib/plaid/models/transfer.rb +5 -41
  462. data/lib/plaid/models/transfer_authorization.rb +1 -1
  463. data/lib/plaid/models/transfer_authorization_create_request.rb +2 -53
  464. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  465. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  466. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  467. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -32
  468. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  469. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  470. data/lib/plaid/models/transfer_create_request.rb +7 -45
  471. data/lib/plaid/models/transfer_create_response.rb +1 -1
  472. data/lib/plaid/models/transfer_event.rb +6 -41
  473. data/lib/plaid/models/transfer_event_list_request.rb +6 -29
  474. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  475. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  476. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  477. data/lib/plaid/models/transfer_event_type.rb +5 -5
  478. data/lib/plaid/models/transfer_failure.rb +1 -1
  479. data/lib/plaid/models/transfer_get_request.rb +1 -1
  480. data/lib/plaid/models/transfer_get_response.rb +1 -1
  481. data/lib/plaid/models/transfer_list_request.rb +6 -16
  482. data/lib/plaid/models/transfer_list_response.rb +1 -1
  483. data/lib/plaid/models/transfer_network.rb +5 -3
  484. data/lib/plaid/models/transfer_status.rb +5 -3
  485. data/lib/plaid/models/transfer_type.rb +5 -3
  486. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  487. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  488. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  489. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  490. data/lib/plaid/models/user_custom_password.rb +1 -1
  491. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  492. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  493. data/lib/plaid/models/verification_refresh_status.rb +5 -3
  494. data/lib/plaid/models/verification_status.rb +5 -3
  495. data/lib/plaid/models/w2.rb +1 -1
  496. data/lib/plaid/models/w2_box12.rb +1 -1
  497. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  498. data/lib/plaid/models/warning.rb +1 -1
  499. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  500. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  501. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  502. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  503. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  504. data/lib/plaid/version.rb +2 -2
  505. data/lib/plaid.rb +33 -4
  506. data/pkg/plaid-10.0.0.gem +0 -0
  507. data/pkg/plaid-11.0.0.gem +0 -0
  508. data/pkg/plaid-12.0.0.gem +0 -0
  509. data/pkg/plaid-13.1.0.gem +0 -0
  510. data/pkg/plaid-14.3.0.gem +0 -0
  511. data/pkg/plaid-14.4.0.gem +0 -0
  512. data/pkg/plaid-8.5.0.gem +0 -0
  513. data/pkg/plaid-8.6.0.gem +0 -0
  514. data/pkg/plaid-8.7.0.gem +0 -0
  515. data/pkg/plaid-8.8.0.gem +0 -0
  516. data/pkg/plaid-9.0.0.gem +0 -0
  517. data/plaid.gemspec +1 -1
  518. data/templates/ruby/api_client.mustache +1 -2
  519. data/templates/ruby/api_client_faraday_partial.mustache +2 -1
  520. data/templates/ruby/api_error.mustache +49 -0
  521. data/templates/ruby/configuration.mustache +5 -3
  522. data/templates/ruby/partial_model_enum_class.mustache +22 -0
  523. data/test/test_accounts.rb +4 -8
  524. data/test/test_item.rb +0 -1
  525. metadata +61 -22
  526. data/doc/rdoc/.DS_Store +0 -0
  527. data/lib/plaid/.DS_Store +0 -0
  528. data/pkg/plaid-13.2.0.gem +0 -0
  529. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  530. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  531. data/pkg/plaid-14.0.0.gem +0 -0
  532. data/pkg/plaid-14.1.0.gem +0 -0
@@ -0,0 +1,221 @@
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.37.4
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
+ # An object containing employer data.
18
+ class EmployerVerification
19
+ # Name of employer.
20
+ attr_accessor :name
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'name' => :'name'
26
+ }
27
+ end
28
+
29
+ # Returns all the JSON keys this model knows about
30
+ def self.acceptable_attributes
31
+ attribute_map.values
32
+ end
33
+
34
+ # Attribute type mapping.
35
+ def self.openapi_types
36
+ {
37
+ :'name' => :'String'
38
+ }
39
+ end
40
+
41
+ # List of attributes with nullable: true
42
+ def self.openapi_nullable
43
+ Set.new([
44
+ :'name'
45
+ ])
46
+ end
47
+
48
+ # Initializes the object
49
+ # @param [Hash] attributes Model attributes in the form of hash
50
+ def initialize(attributes = {})
51
+ if (!attributes.is_a?(Hash))
52
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::EmployerVerification` initialize method"
53
+ end
54
+
55
+ # check to see if the attribute exists and convert string to symbol for hash key
56
+ attributes = attributes.each_with_object({}) { |(k, v), h|
57
+ if (!self.class.attribute_map.key?(k.to_sym))
58
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::EmployerVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
+ end
60
+ h[k.to_sym] = v
61
+ }
62
+
63
+ if attributes.key?(:'name')
64
+ self.name = attributes[:'name']
65
+ end
66
+ end
67
+
68
+ # Show invalid properties with the reasons. Usually used together with valid?
69
+ # @return Array for valid properties with the reasons
70
+ def list_invalid_properties
71
+ invalid_properties = Array.new
72
+ invalid_properties
73
+ end
74
+
75
+ # Check to see if the all the properties in the model are valid
76
+ # @return true if the model is valid
77
+ def valid?
78
+ true
79
+ end
80
+
81
+ # Checks equality by comparing each attribute.
82
+ # @param [Object] Object to be compared
83
+ def ==(o)
84
+ return true if self.equal?(o)
85
+ self.class == o.class &&
86
+ name == o.name
87
+ end
88
+
89
+ # @see the `==` method
90
+ # @param [Object] Object to be compared
91
+ def eql?(o)
92
+ self == o
93
+ end
94
+
95
+ # Calculates hash code according to all attributes.
96
+ # @return [Integer] Hash code
97
+ def hash
98
+ [name].hash
99
+ end
100
+
101
+ # Builds the object from hash
102
+ # @param [Hash] attributes Model attributes in the form of hash
103
+ # @return [Object] Returns the model itself
104
+ def self.build_from_hash(attributes)
105
+ new.build_from_hash(attributes)
106
+ end
107
+
108
+ # Builds the object from hash
109
+ # @param [Hash] attributes Model attributes in the form of hash
110
+ # @return [Object] Returns the model itself
111
+ def build_from_hash(attributes)
112
+ return nil unless attributes.is_a?(Hash)
113
+ self.class.openapi_types.each_pair do |key, type|
114
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
115
+ self.send("#{key}=", nil)
116
+ elsif type =~ /\AArray<(.*)>/i
117
+ # check to ensure the input is an array given that the attribute
118
+ # is documented as an array but the input is not
119
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
120
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
121
+ end
122
+ elsif !attributes[self.class.attribute_map[key]].nil?
123
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
124
+ end
125
+ end
126
+
127
+ self
128
+ end
129
+
130
+ # Deserializes the data based on type
131
+ # @param string type Data type
132
+ # @param string value Value to be deserialized
133
+ # @return [Object] Deserialized data
134
+ def _deserialize(type, value)
135
+ case type.to_sym
136
+ when :Time
137
+ Time.parse(value)
138
+ when :Date
139
+ Date.parse(value)
140
+ when :String
141
+ value.to_s
142
+ when :Integer
143
+ value.to_i
144
+ when :Float
145
+ value.to_f
146
+ when :Boolean
147
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
148
+ true
149
+ else
150
+ false
151
+ end
152
+ when :Object
153
+ # generic object (usually a Hash), return directly
154
+ value
155
+ when /\AArray<(?<inner_type>.+)>\z/
156
+ inner_type = Regexp.last_match[:inner_type]
157
+ value.map { |v| _deserialize(inner_type, v) }
158
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
159
+ k_type = Regexp.last_match[:k_type]
160
+ v_type = Regexp.last_match[:v_type]
161
+ {}.tap do |hash|
162
+ value.each do |k, v|
163
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
164
+ end
165
+ end
166
+ else # model
167
+ # models (e.g. Pet) or oneOf
168
+ klass = Plaid.const_get(type)
169
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
170
+ end
171
+ end
172
+
173
+ # Returns the string representation of the object
174
+ # @return [String] String presentation of the object
175
+ def to_s
176
+ to_hash.to_s
177
+ end
178
+
179
+ # to_body is an alias to to_hash (backward compatibility)
180
+ # @return [Hash] Returns the object in the form of hash
181
+ def to_body
182
+ to_hash
183
+ end
184
+
185
+ # Returns the object in the form of hash
186
+ # @return [Hash] Returns the object in the form of hash
187
+ def to_hash
188
+ hash = {}
189
+ self.class.attribute_map.each_pair do |attr, param|
190
+ value = self.send(attr)
191
+ if value.nil?
192
+ is_nullable = self.class.openapi_nullable.include?(attr)
193
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
194
+ end
195
+
196
+ hash[param] = _to_hash(value)
197
+ end
198
+ hash
199
+ end
200
+
201
+ # Outputs non-array value in the form of hash
202
+ # For object, use to_hash. Otherwise, just return the value
203
+ # @param [Object] value Any valid value
204
+ # @return [Hash] Returns the value in the form of hash
205
+ def _to_hash(value)
206
+ if value.is_a?(Array)
207
+ value.compact.map { |v| _to_hash(v) }
208
+ elsif value.is_a?(Hash)
209
+ {}.tap do |hash|
210
+ value.each { |k, v| hash[k] = _to_hash(v) }
211
+ end
212
+ elsif value.respond_to? :to_hash
213
+ value.to_hash
214
+ else
215
+ value
216
+ end
217
+ end
218
+
219
+ end
220
+
221
+ 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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -0,0 +1,306 @@
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.37.4
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
+ # An object containing proof of employment data for an individual
18
+ class EmploymentVerification
19
+ # Current employment status.
20
+ attr_accessor :status
21
+
22
+ # Start of employment in ISO_8601 format (YYYY-MM-DD).
23
+ attr_accessor :start_date
24
+
25
+ # End of employment, if applicable. In ISO_8601 format (YYY-MM-DD).
26
+ attr_accessor :end_date
27
+
28
+ attr_accessor :employer
29
+
30
+ # Current title of employee.
31
+ attr_accessor :title
32
+
33
+ attr_accessor :platform_ids
34
+
35
+ class EnumAttributeValidator
36
+ attr_reader :datatype
37
+ attr_reader :allowable_values
38
+
39
+ def initialize(datatype, allowable_values)
40
+ @allowable_values = allowable_values.map do |value|
41
+ case datatype.to_s
42
+ when /Integer/i
43
+ value.to_i
44
+ when /Float/i
45
+ value.to_f
46
+ else
47
+ value
48
+ end
49
+ end
50
+ end
51
+
52
+ def valid?(value)
53
+ !value || allowable_values.include?(value)
54
+ end
55
+ end
56
+
57
+ # Attribute mapping from ruby-style variable name to JSON key.
58
+ def self.attribute_map
59
+ {
60
+ :'status' => :'status',
61
+ :'start_date' => :'start_date',
62
+ :'end_date' => :'end_date',
63
+ :'employer' => :'employer',
64
+ :'title' => :'title',
65
+ :'platform_ids' => :'platform_ids'
66
+ }
67
+ end
68
+
69
+ # Returns all the JSON keys this model knows about
70
+ def self.acceptable_attributes
71
+ attribute_map.values
72
+ end
73
+
74
+ # Attribute type mapping.
75
+ def self.openapi_types
76
+ {
77
+ :'status' => :'String',
78
+ :'start_date' => :'Date',
79
+ :'end_date' => :'Date',
80
+ :'employer' => :'EmployerVerification',
81
+ :'title' => :'String',
82
+ :'platform_ids' => :'PlatformIds'
83
+ }
84
+ end
85
+
86
+ # List of attributes with nullable: true
87
+ def self.openapi_nullable
88
+ Set.new([
89
+ :'status',
90
+ :'start_date',
91
+ :'end_date',
92
+ :'title',
93
+ ])
94
+ end
95
+
96
+ # Initializes the object
97
+ # @param [Hash] attributes Model attributes in the form of hash
98
+ def initialize(attributes = {})
99
+ if (!attributes.is_a?(Hash))
100
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::EmploymentVerification` initialize method"
101
+ end
102
+
103
+ # check to see if the attribute exists and convert string to symbol for hash key
104
+ attributes = attributes.each_with_object({}) { |(k, v), h|
105
+ if (!self.class.attribute_map.key?(k.to_sym))
106
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::EmploymentVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
107
+ end
108
+ h[k.to_sym] = v
109
+ }
110
+
111
+ if attributes.key?(:'status')
112
+ self.status = attributes[:'status']
113
+ end
114
+
115
+ if attributes.key?(:'start_date')
116
+ self.start_date = attributes[:'start_date']
117
+ end
118
+
119
+ if attributes.key?(:'end_date')
120
+ self.end_date = attributes[:'end_date']
121
+ end
122
+
123
+ if attributes.key?(:'employer')
124
+ self.employer = attributes[:'employer']
125
+ end
126
+
127
+ if attributes.key?(:'title')
128
+ self.title = attributes[:'title']
129
+ end
130
+
131
+ if attributes.key?(:'platform_ids')
132
+ self.platform_ids = attributes[:'platform_ids']
133
+ end
134
+ end
135
+
136
+ # Show invalid properties with the reasons. Usually used together with valid?
137
+ # @return Array for valid properties with the reasons
138
+ def list_invalid_properties
139
+ invalid_properties = Array.new
140
+ invalid_properties
141
+ end
142
+
143
+ # Check to see if the all the properties in the model are valid
144
+ # @return true if the model is valid
145
+ def valid?
146
+ status_validator = EnumAttributeValidator.new('String', ["EMPLOYMENT_STATUS_ACTIVE", "EMPLOYMENT_STATUS_INACTIVE", "null"])
147
+ return false unless status_validator.valid?(@status)
148
+ true
149
+ end
150
+
151
+ # Custom attribute writer method checking allowed values (enum).
152
+ # @param [Object] status Object to be assigned
153
+ def status=(status)
154
+ validator = EnumAttributeValidator.new('String', ["EMPLOYMENT_STATUS_ACTIVE", "EMPLOYMENT_STATUS_INACTIVE", "null"])
155
+ unless validator.valid?(status)
156
+ fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
157
+ end
158
+ @status = status
159
+ end
160
+
161
+ # Checks equality by comparing each attribute.
162
+ # @param [Object] Object to be compared
163
+ def ==(o)
164
+ return true if self.equal?(o)
165
+ self.class == o.class &&
166
+ status == o.status &&
167
+ start_date == o.start_date &&
168
+ end_date == o.end_date &&
169
+ employer == o.employer &&
170
+ title == o.title &&
171
+ platform_ids == o.platform_ids
172
+ end
173
+
174
+ # @see the `==` method
175
+ # @param [Object] Object to be compared
176
+ def eql?(o)
177
+ self == o
178
+ end
179
+
180
+ # Calculates hash code according to all attributes.
181
+ # @return [Integer] Hash code
182
+ def hash
183
+ [status, start_date, end_date, employer, title, platform_ids].hash
184
+ end
185
+
186
+ # Builds the object from hash
187
+ # @param [Hash] attributes Model attributes in the form of hash
188
+ # @return [Object] Returns the model itself
189
+ def self.build_from_hash(attributes)
190
+ new.build_from_hash(attributes)
191
+ end
192
+
193
+ # Builds the object from hash
194
+ # @param [Hash] attributes Model attributes in the form of hash
195
+ # @return [Object] Returns the model itself
196
+ def build_from_hash(attributes)
197
+ return nil unless attributes.is_a?(Hash)
198
+ self.class.openapi_types.each_pair do |key, type|
199
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
200
+ self.send("#{key}=", nil)
201
+ elsif type =~ /\AArray<(.*)>/i
202
+ # check to ensure the input is an array given that the attribute
203
+ # is documented as an array but the input is not
204
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
205
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
206
+ end
207
+ elsif !attributes[self.class.attribute_map[key]].nil?
208
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
209
+ end
210
+ end
211
+
212
+ self
213
+ end
214
+
215
+ # Deserializes the data based on type
216
+ # @param string type Data type
217
+ # @param string value Value to be deserialized
218
+ # @return [Object] Deserialized data
219
+ def _deserialize(type, value)
220
+ case type.to_sym
221
+ when :Time
222
+ Time.parse(value)
223
+ when :Date
224
+ Date.parse(value)
225
+ when :String
226
+ value.to_s
227
+ when :Integer
228
+ value.to_i
229
+ when :Float
230
+ value.to_f
231
+ when :Boolean
232
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
233
+ true
234
+ else
235
+ false
236
+ end
237
+ when :Object
238
+ # generic object (usually a Hash), return directly
239
+ value
240
+ when /\AArray<(?<inner_type>.+)>\z/
241
+ inner_type = Regexp.last_match[:inner_type]
242
+ value.map { |v| _deserialize(inner_type, v) }
243
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
244
+ k_type = Regexp.last_match[:k_type]
245
+ v_type = Regexp.last_match[:v_type]
246
+ {}.tap do |hash|
247
+ value.each do |k, v|
248
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
249
+ end
250
+ end
251
+ else # model
252
+ # models (e.g. Pet) or oneOf
253
+ klass = Plaid.const_get(type)
254
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
255
+ end
256
+ end
257
+
258
+ # Returns the string representation of the object
259
+ # @return [String] String presentation of the object
260
+ def to_s
261
+ to_hash.to_s
262
+ end
263
+
264
+ # to_body is an alias to to_hash (backward compatibility)
265
+ # @return [Hash] Returns the object in the form of hash
266
+ def to_body
267
+ to_hash
268
+ end
269
+
270
+ # Returns the object in the form of hash
271
+ # @return [Hash] Returns the object in the form of hash
272
+ def to_hash
273
+ hash = {}
274
+ self.class.attribute_map.each_pair do |attr, param|
275
+ value = self.send(attr)
276
+ if value.nil?
277
+ is_nullable = self.class.openapi_nullable.include?(attr)
278
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
279
+ end
280
+
281
+ hash[param] = _to_hash(value)
282
+ end
283
+ hash
284
+ end
285
+
286
+ # Outputs non-array value in the form of hash
287
+ # For object, use to_hash. Otherwise, just return the value
288
+ # @param [Object] value Any valid value
289
+ # @return [Hash] Returns the value in the form of hash
290
+ def _to_hash(value)
291
+ if value.is_a?(Array)
292
+ value.compact.map { |v| _to_hash(v) }
293
+ elsif value.is_a?(Hash)
294
+ {}.tap do |hash|
295
+ value.each { |k, v| hash[k] = _to_hash(v) }
296
+ end
297
+ elsif value.respond_to? :to_hash
298
+ value.to_hash
299
+ else
300
+ value
301
+ end
302
+ end
303
+
304
+ end
305
+
306
+ end