plaid 14.0.0 → 14.1.0

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