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,252 @@
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
+ class IncomeVerificationPrecheckEmployer
18
+ # The employer's name
19
+ attr_accessor :name
20
+
21
+ attr_accessor :address
22
+
23
+ # The employer's tax id
24
+ attr_accessor :tax_id
25
+
26
+ # The URL for the employer's public website
27
+ attr_accessor :url
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'name' => :'name',
33
+ :'address' => :'address',
34
+ :'tax_id' => :'tax_id',
35
+ :'url' => :'url'
36
+ }
37
+ end
38
+
39
+ # Returns all the JSON keys this model knows about
40
+ def self.acceptable_attributes
41
+ attribute_map.values
42
+ end
43
+
44
+ # Attribute type mapping.
45
+ def self.openapi_types
46
+ {
47
+ :'name' => :'String',
48
+ :'address' => :'IncomeVerificationPrecheckEmployerAddress',
49
+ :'tax_id' => :'String',
50
+ :'url' => :'String'
51
+ }
52
+ end
53
+
54
+ # List of attributes with nullable: true
55
+ def self.openapi_nullable
56
+ Set.new([
57
+ :'name',
58
+ :'address',
59
+ :'tax_id',
60
+ :'url'
61
+ ])
62
+ end
63
+
64
+ # Initializes the object
65
+ # @param [Hash] attributes Model attributes in the form of hash
66
+ def initialize(attributes = {})
67
+ if (!attributes.is_a?(Hash))
68
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IncomeVerificationPrecheckEmployer` initialize method"
69
+ end
70
+
71
+ # check to see if the attribute exists and convert string to symbol for hash key
72
+ attributes = attributes.each_with_object({}) { |(k, v), h|
73
+ if (!self.class.attribute_map.key?(k.to_sym))
74
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IncomeVerificationPrecheckEmployer`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
75
+ end
76
+ h[k.to_sym] = v
77
+ }
78
+
79
+ if attributes.key?(:'name')
80
+ self.name = attributes[:'name']
81
+ end
82
+
83
+ if attributes.key?(:'address')
84
+ self.address = attributes[:'address']
85
+ end
86
+
87
+ if attributes.key?(:'tax_id')
88
+ self.tax_id = attributes[:'tax_id']
89
+ end
90
+
91
+ if attributes.key?(:'url')
92
+ self.url = attributes[:'url']
93
+ end
94
+ end
95
+
96
+ # Show invalid properties with the reasons. Usually used together with valid?
97
+ # @return Array for valid properties with the reasons
98
+ def list_invalid_properties
99
+ invalid_properties = Array.new
100
+ invalid_properties
101
+ end
102
+
103
+ # Check to see if the all the properties in the model are valid
104
+ # @return true if the model is valid
105
+ def valid?
106
+ true
107
+ end
108
+
109
+ # Checks equality by comparing each attribute.
110
+ # @param [Object] Object to be compared
111
+ def ==(o)
112
+ return true if self.equal?(o)
113
+ self.class == o.class &&
114
+ name == o.name &&
115
+ address == o.address &&
116
+ tax_id == o.tax_id &&
117
+ url == o.url
118
+ end
119
+
120
+ # @see the `==` method
121
+ # @param [Object] Object to be compared
122
+ def eql?(o)
123
+ self == o
124
+ end
125
+
126
+ # Calculates hash code according to all attributes.
127
+ # @return [Integer] Hash code
128
+ def hash
129
+ [name, address, tax_id, url].hash
130
+ end
131
+
132
+ # Builds the object from hash
133
+ # @param [Hash] attributes Model attributes in the form of hash
134
+ # @return [Object] Returns the model itself
135
+ def self.build_from_hash(attributes)
136
+ new.build_from_hash(attributes)
137
+ end
138
+
139
+ # Builds the object from hash
140
+ # @param [Hash] attributes Model attributes in the form of hash
141
+ # @return [Object] Returns the model itself
142
+ def build_from_hash(attributes)
143
+ return nil unless attributes.is_a?(Hash)
144
+ self.class.openapi_types.each_pair do |key, type|
145
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
146
+ self.send("#{key}=", nil)
147
+ elsif type =~ /\AArray<(.*)>/i
148
+ # check to ensure the input is an array given that the attribute
149
+ # is documented as an array but the input is not
150
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
151
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
152
+ end
153
+ elsif !attributes[self.class.attribute_map[key]].nil?
154
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
155
+ end
156
+ end
157
+
158
+ self
159
+ end
160
+
161
+ # Deserializes the data based on type
162
+ # @param string type Data type
163
+ # @param string value Value to be deserialized
164
+ # @return [Object] Deserialized data
165
+ def _deserialize(type, value)
166
+ case type.to_sym
167
+ when :Time
168
+ Time.parse(value)
169
+ when :Date
170
+ Date.parse(value)
171
+ when :String
172
+ value.to_s
173
+ when :Integer
174
+ value.to_i
175
+ when :Float
176
+ value.to_f
177
+ when :Boolean
178
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
179
+ true
180
+ else
181
+ false
182
+ end
183
+ when :Object
184
+ # generic object (usually a Hash), return directly
185
+ value
186
+ when /\AArray<(?<inner_type>.+)>\z/
187
+ inner_type = Regexp.last_match[:inner_type]
188
+ value.map { |v| _deserialize(inner_type, v) }
189
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
190
+ k_type = Regexp.last_match[:k_type]
191
+ v_type = Regexp.last_match[:v_type]
192
+ {}.tap do |hash|
193
+ value.each do |k, v|
194
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
195
+ end
196
+ end
197
+ else # model
198
+ # models (e.g. Pet) or oneOf
199
+ klass = Plaid.const_get(type)
200
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
201
+ end
202
+ end
203
+
204
+ # Returns the string representation of the object
205
+ # @return [String] String presentation of the object
206
+ def to_s
207
+ to_hash.to_s
208
+ end
209
+
210
+ # to_body is an alias to to_hash (backward compatibility)
211
+ # @return [Hash] Returns the object in the form of hash
212
+ def to_body
213
+ to_hash
214
+ end
215
+
216
+ # Returns the object in the form of hash
217
+ # @return [Hash] Returns the object in the form of hash
218
+ def to_hash
219
+ hash = {}
220
+ self.class.attribute_map.each_pair do |attr, param|
221
+ value = self.send(attr)
222
+ if value.nil?
223
+ is_nullable = self.class.openapi_nullable.include?(attr)
224
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
225
+ end
226
+
227
+ hash[param] = _to_hash(value)
228
+ end
229
+ hash
230
+ end
231
+
232
+ # Outputs non-array value in the form of hash
233
+ # For object, use to_hash. Otherwise, just return the value
234
+ # @param [Object] value Any valid value
235
+ # @return [Hash] Returns the value in the form of hash
236
+ def _to_hash(value)
237
+ if value.is_a?(Array)
238
+ value.compact.map { |v| _to_hash(v) }
239
+ elsif value.is_a?(Hash)
240
+ {}.tap do |hash|
241
+ value.each { |k, v| hash[k] = _to_hash(v) }
242
+ end
243
+ elsif value.respond_to? :to_hash
244
+ value.to_hash
245
+ else
246
+ value
247
+ end
248
+ end
249
+
250
+ end
251
+
252
+ end
@@ -0,0 +1,280 @@
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
+ # The address of the employer
18
+ class IncomeVerificationPrecheckEmployerAddress
19
+ # The full city name
20
+ attr_accessor :city
21
+
22
+ # The region or state Example: `\"NC\"`
23
+ attr_accessor :region
24
+
25
+ # The full street address Example: `\"564 Main Street, APT 15\"`
26
+ attr_accessor :street
27
+
28
+ # The postal code
29
+ attr_accessor :postal_code
30
+
31
+ # The ISO 3166-1 alpha-2 country code
32
+ attr_accessor :country
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'city' => :'city',
38
+ :'region' => :'region',
39
+ :'street' => :'street',
40
+ :'postal_code' => :'postal_code',
41
+ :'country' => :'country'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'city' => :'String',
54
+ :'region' => :'String',
55
+ :'street' => :'String',
56
+ :'postal_code' => :'String',
57
+ :'country' => :'String'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'region',
65
+ :'postal_code',
66
+ :'country'
67
+ ])
68
+ end
69
+
70
+ # List of class defined in allOf (OpenAPI v3)
71
+ def self.openapi_all_of
72
+ [
73
+ :'AddressData'
74
+ ]
75
+ end
76
+
77
+ # Initializes the object
78
+ # @param [Hash] attributes Model attributes in the form of hash
79
+ def initialize(attributes = {})
80
+ if (!attributes.is_a?(Hash))
81
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IncomeVerificationPrecheckEmployerAddress` initialize method"
82
+ end
83
+
84
+ # check to see if the attribute exists and convert string to symbol for hash key
85
+ attributes = attributes.each_with_object({}) { |(k, v), h|
86
+ if (!self.class.attribute_map.key?(k.to_sym))
87
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IncomeVerificationPrecheckEmployerAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
88
+ end
89
+ h[k.to_sym] = v
90
+ }
91
+
92
+ if attributes.key?(:'city')
93
+ self.city = attributes[:'city']
94
+ end
95
+
96
+ if attributes.key?(:'region')
97
+ self.region = attributes[:'region']
98
+ end
99
+
100
+ if attributes.key?(:'street')
101
+ self.street = attributes[:'street']
102
+ end
103
+
104
+ if attributes.key?(:'postal_code')
105
+ self.postal_code = attributes[:'postal_code']
106
+ end
107
+
108
+ if attributes.key?(:'country')
109
+ self.country = attributes[:'country']
110
+ end
111
+ end
112
+
113
+ # Show invalid properties with the reasons. Usually used together with valid?
114
+ # @return Array for valid properties with the reasons
115
+ def list_invalid_properties
116
+ invalid_properties = Array.new
117
+ if @city.nil?
118
+ invalid_properties.push('invalid value for "city", city cannot be nil.')
119
+ end
120
+
121
+ if @street.nil?
122
+ invalid_properties.push('invalid value for "street", street cannot be nil.')
123
+ end
124
+
125
+ invalid_properties
126
+ end
127
+
128
+ # Check to see if the all the properties in the model are valid
129
+ # @return true if the model is valid
130
+ def valid?
131
+ return false if @city.nil?
132
+ return false if @street.nil?
133
+ true
134
+ end
135
+
136
+ # Checks equality by comparing each attribute.
137
+ # @param [Object] Object to be compared
138
+ def ==(o)
139
+ return true if self.equal?(o)
140
+ self.class == o.class &&
141
+ city == o.city &&
142
+ region == o.region &&
143
+ street == o.street &&
144
+ postal_code == o.postal_code &&
145
+ country == o.country
146
+ end
147
+
148
+ # @see the `==` method
149
+ # @param [Object] Object to be compared
150
+ def eql?(o)
151
+ self == o
152
+ end
153
+
154
+ # Calculates hash code according to all attributes.
155
+ # @return [Integer] Hash code
156
+ def hash
157
+ [city, region, street, postal_code, country].hash
158
+ end
159
+
160
+ # Builds the object from hash
161
+ # @param [Hash] attributes Model attributes in the form of hash
162
+ # @return [Object] Returns the model itself
163
+ def self.build_from_hash(attributes)
164
+ new.build_from_hash(attributes)
165
+ end
166
+
167
+ # Builds the object from hash
168
+ # @param [Hash] attributes Model attributes in the form of hash
169
+ # @return [Object] Returns the model itself
170
+ def build_from_hash(attributes)
171
+ return nil unless attributes.is_a?(Hash)
172
+ self.class.openapi_types.each_pair do |key, type|
173
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
174
+ self.send("#{key}=", nil)
175
+ elsif type =~ /\AArray<(.*)>/i
176
+ # check to ensure the input is an array given that the attribute
177
+ # is documented as an array but the input is not
178
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
179
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
180
+ end
181
+ elsif !attributes[self.class.attribute_map[key]].nil?
182
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
183
+ end
184
+ end
185
+
186
+ self
187
+ end
188
+
189
+ # Deserializes the data based on type
190
+ # @param string type Data type
191
+ # @param string value Value to be deserialized
192
+ # @return [Object] Deserialized data
193
+ def _deserialize(type, value)
194
+ case type.to_sym
195
+ when :Time
196
+ Time.parse(value)
197
+ when :Date
198
+ Date.parse(value)
199
+ when :String
200
+ value.to_s
201
+ when :Integer
202
+ value.to_i
203
+ when :Float
204
+ value.to_f
205
+ when :Boolean
206
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
207
+ true
208
+ else
209
+ false
210
+ end
211
+ when :Object
212
+ # generic object (usually a Hash), return directly
213
+ value
214
+ when /\AArray<(?<inner_type>.+)>\z/
215
+ inner_type = Regexp.last_match[:inner_type]
216
+ value.map { |v| _deserialize(inner_type, v) }
217
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
218
+ k_type = Regexp.last_match[:k_type]
219
+ v_type = Regexp.last_match[:v_type]
220
+ {}.tap do |hash|
221
+ value.each do |k, v|
222
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
223
+ end
224
+ end
225
+ else # model
226
+ # models (e.g. Pet) or oneOf
227
+ klass = Plaid.const_get(type)
228
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
229
+ end
230
+ end
231
+
232
+ # Returns the string representation of the object
233
+ # @return [String] String presentation of the object
234
+ def to_s
235
+ to_hash.to_s
236
+ end
237
+
238
+ # to_body is an alias to to_hash (backward compatibility)
239
+ # @return [Hash] Returns the object in the form of hash
240
+ def to_body
241
+ to_hash
242
+ end
243
+
244
+ # Returns the object in the form of hash
245
+ # @return [Hash] Returns the object in the form of hash
246
+ def to_hash
247
+ hash = {}
248
+ self.class.attribute_map.each_pair do |attr, param|
249
+ value = self.send(attr)
250
+ if value.nil?
251
+ is_nullable = self.class.openapi_nullable.include?(attr)
252
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
253
+ end
254
+
255
+ hash[param] = _to_hash(value)
256
+ end
257
+ hash
258
+ end
259
+
260
+ # Outputs non-array value in the form of hash
261
+ # For object, use to_hash. Otherwise, just return the value
262
+ # @param [Object] value Any valid value
263
+ # @return [Hash] Returns the value in the form of hash
264
+ def _to_hash(value)
265
+ if value.is_a?(Array)
266
+ value.compact.map { |v| _to_hash(v) }
267
+ elsif value.is_a?(Hash)
268
+ {}.tap do |hash|
269
+ value.each { |k, v| hash[k] = _to_hash(v) }
270
+ end
271
+ elsif value.respond_to? :to_hash
272
+ value.to_hash
273
+ else
274
+ value
275
+ end
276
+ end
277
+
278
+ end
279
+
280
+ 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
@@ -14,10 +14,12 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Plaid
17
- # The receiver details if the type of this event is `reciever_pending` or `reciever_posted`. Null value otherwise.
18
- class TransferReceiverDetails
19
- # The sign of the available balance for the receiver bank account associated with the receiver event at the time the matching transaction was found. Can be `positive`, `negative`, or null if the balance was not available at the time.
20
- attr_accessor :available_balance
17
+ class IncomeVerificationPrecheckMilitaryInfo
18
+ # Is the user currently active duty in the US military
19
+ attr_accessor :is_active_duty
20
+
21
+ # If the user is currently serving in the US military, the branch of the military they are serving in
22
+ attr_accessor :branch
21
23
 
22
24
  class EnumAttributeValidator
23
25
  attr_reader :datatype
@@ -44,7 +46,8 @@ module Plaid
44
46
  # Attribute mapping from ruby-style variable name to JSON key.
45
47
  def self.attribute_map
46
48
  {
47
- :'available_balance' => :'available_balance'
49
+ :'is_active_duty' => :'is_active_duty',
50
+ :'branch' => :'branch'
48
51
  }
49
52
  end
50
53
 
@@ -56,14 +59,16 @@ module Plaid
56
59
  # Attribute type mapping.
57
60
  def self.openapi_types
58
61
  {
59
- :'available_balance' => :'String'
62
+ :'is_active_duty' => :'Boolean',
63
+ :'branch' => :'String'
60
64
  }
61
65
  end
62
66
 
63
67
  # List of attributes with nullable: true
64
68
  def self.openapi_nullable
65
69
  Set.new([
66
- :'available_balance'
70
+ :'is_active_duty',
71
+ :'branch'
67
72
  ])
68
73
  end
69
74
 
@@ -71,19 +76,23 @@ module Plaid
71
76
  # @param [Hash] attributes Model attributes in the form of hash
72
77
  def initialize(attributes = {})
73
78
  if (!attributes.is_a?(Hash))
74
- fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferReceiverDetails` initialize method"
79
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IncomeVerificationPrecheckMilitaryInfo` initialize method"
75
80
  end
76
81
 
77
82
  # check to see if the attribute exists and convert string to symbol for hash key
78
83
  attributes = attributes.each_with_object({}) { |(k, v), h|
79
84
  if (!self.class.attribute_map.key?(k.to_sym))
80
- fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferReceiverDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
85
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IncomeVerificationPrecheckMilitaryInfo`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
81
86
  end
82
87
  h[k.to_sym] = v
83
88
  }
84
89
 
85
- if attributes.key?(:'available_balance')
86
- self.available_balance = attributes[:'available_balance']
90
+ if attributes.key?(:'is_active_duty')
91
+ self.is_active_duty = attributes[:'is_active_duty']
92
+ end
93
+
94
+ if attributes.key?(:'branch')
95
+ self.branch = attributes[:'branch']
87
96
  end
88
97
  end
89
98
 
@@ -97,19 +106,19 @@ module Plaid
97
106
  # Check to see if the all the properties in the model are valid
98
107
  # @return true if the model is valid
99
108
  def valid?
100
- available_balance_validator = EnumAttributeValidator.new('String', ["positive", "negative", "null"])
101
- return false unless available_balance_validator.valid?(@available_balance)
109
+ branch_validator = EnumAttributeValidator.new('String', ["AIR FORCE", "ARMY", "COAST GUARD", "MARINES", "NAVY"])
110
+ return false unless branch_validator.valid?(@branch)
102
111
  true
103
112
  end
104
113
 
105
114
  # Custom attribute writer method checking allowed values (enum).
106
- # @param [Object] available_balance Object to be assigned
107
- def available_balance=(available_balance)
108
- validator = EnumAttributeValidator.new('String', ["positive", "negative", "null"])
109
- unless validator.valid?(available_balance)
110
- fail ArgumentError, "invalid value for \"available_balance\", must be one of #{validator.allowable_values}."
115
+ # @param [Object] branch Object to be assigned
116
+ def branch=(branch)
117
+ validator = EnumAttributeValidator.new('String', ["AIR FORCE", "ARMY", "COAST GUARD", "MARINES", "NAVY"])
118
+ unless validator.valid?(branch)
119
+ fail ArgumentError, "invalid value for \"branch\", must be one of #{validator.allowable_values}."
111
120
  end
112
- @available_balance = available_balance
121
+ @branch = branch
113
122
  end
114
123
 
115
124
  # Checks equality by comparing each attribute.
@@ -117,7 +126,8 @@ module Plaid
117
126
  def ==(o)
118
127
  return true if self.equal?(o)
119
128
  self.class == o.class &&
120
- available_balance == o.available_balance
129
+ is_active_duty == o.is_active_duty &&
130
+ branch == o.branch
121
131
  end
122
132
 
123
133
  # @see the `==` method
@@ -129,7 +139,7 @@ module Plaid
129
139
  # Calculates hash code according to all attributes.
130
140
  # @return [Integer] Hash code
131
141
  def hash
132
- [available_balance].hash
142
+ [is_active_duty, branch].hash
133
143
  end
134
144
 
135
145
  # Builds the object from hash