plaid 14.0.0.beta.5 → 14.3.0

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