plaid 14.0.0 → 14.4.0

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