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,239 @@
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
+ # Defines the response schema for `/transfer/get`
18
+ class TransferGetResponse
19
+ attr_accessor :transfer
20
+
21
+ # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
22
+ attr_accessor :request_id
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'transfer' => :'transfer',
28
+ :'request_id' => :'request_id'
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
+ :'transfer' => :'Transfer',
41
+ :'request_id' => :'String'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferGetResponse` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'transfer')
67
+ self.transfer = attributes[:'transfer']
68
+ end
69
+
70
+ if attributes.key?(:'request_id')
71
+ self.request_id = attributes[:'request_id']
72
+ end
73
+ end
74
+
75
+ # Show invalid properties with the reasons. Usually used together with valid?
76
+ # @return Array for valid properties with the reasons
77
+ def list_invalid_properties
78
+ invalid_properties = Array.new
79
+ if @transfer.nil?
80
+ invalid_properties.push('invalid value for "transfer", transfer cannot be nil.')
81
+ end
82
+
83
+ if @request_id.nil?
84
+ invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
85
+ end
86
+
87
+ invalid_properties
88
+ end
89
+
90
+ # Check to see if the all the properties in the model are valid
91
+ # @return true if the model is valid
92
+ def valid?
93
+ return false if @transfer.nil?
94
+ return false if @request_id.nil?
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
+ transfer == o.transfer &&
104
+ request_id == o.request_id
105
+ end
106
+
107
+ # @see the `==` method
108
+ # @param [Object] Object to be compared
109
+ def eql?(o)
110
+ self == o
111
+ end
112
+
113
+ # Calculates hash code according to all attributes.
114
+ # @return [Integer] Hash code
115
+ def hash
116
+ [transfer, request_id].hash
117
+ end
118
+
119
+ # Builds the object from hash
120
+ # @param [Hash] attributes Model attributes in the form of hash
121
+ # @return [Object] Returns the model itself
122
+ def self.build_from_hash(attributes)
123
+ new.build_from_hash(attributes)
124
+ end
125
+
126
+ # Builds the object from hash
127
+ # @param [Hash] attributes Model attributes in the form of hash
128
+ # @return [Object] Returns the model itself
129
+ def build_from_hash(attributes)
130
+ return nil unless attributes.is_a?(Hash)
131
+ self.class.openapi_types.each_pair do |key, type|
132
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
133
+ self.send("#{key}=", nil)
134
+ elsif type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
138
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
139
+ end
140
+ elsif !attributes[self.class.attribute_map[key]].nil?
141
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
142
+ end
143
+ end
144
+
145
+ self
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def _deserialize(type, value)
153
+ case type.to_sym
154
+ when :Time
155
+ Time.parse(value)
156
+ when :Date
157
+ Date.parse(value)
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :Boolean
165
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
166
+ true
167
+ else
168
+ false
169
+ end
170
+ when :Object
171
+ # generic object (usually a Hash), return directly
172
+ value
173
+ when /\AArray<(?<inner_type>.+)>\z/
174
+ inner_type = Regexp.last_match[:inner_type]
175
+ value.map { |v| _deserialize(inner_type, v) }
176
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
177
+ k_type = Regexp.last_match[:k_type]
178
+ v_type = Regexp.last_match[:v_type]
179
+ {}.tap do |hash|
180
+ value.each do |k, v|
181
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
182
+ end
183
+ end
184
+ else # model
185
+ # models (e.g. Pet) or oneOf
186
+ klass = Plaid.const_get(type)
187
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ if value.nil?
210
+ is_nullable = self.class.openapi_nullable.include?(attr)
211
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
212
+ end
213
+
214
+ hash[param] = _to_hash(value)
215
+ end
216
+ hash
217
+ end
218
+
219
+ # Outputs non-array value in the form of hash
220
+ # For object, use to_hash. Otherwise, just return the value
221
+ # @param [Object] value Any valid value
222
+ # @return [Hash] Returns the value in the form of hash
223
+ def _to_hash(value)
224
+ if value.is_a?(Array)
225
+ value.compact.map { |v| _to_hash(v) }
226
+ elsif value.is_a?(Hash)
227
+ {}.tap do |hash|
228
+ value.each { |k, v| hash[k] = _to_hash(v) }
229
+ end
230
+ elsif value.respond_to? :to_hash
231
+ value.to_hash
232
+ else
233
+ value
234
+ end
235
+ end
236
+
237
+ end
238
+
239
+ end
@@ -0,0 +1,340 @@
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
+ # Defines the request schema for `/transfer/list`
18
+ class TransferListRequest
19
+ # Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
20
+ attr_accessor :client_id
21
+
22
+ # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
23
+ attr_accessor :secret
24
+
25
+ # The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
26
+ attr_accessor :start_date
27
+
28
+ # The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
29
+ attr_accessor :end_date
30
+
31
+ # The maximum number of transfers to return.
32
+ attr_accessor :count
33
+
34
+ # The number of transfers to skip before returning results.
35
+ attr_accessor :offset
36
+
37
+ # Filter transfers to only those originated through the specified origination account.
38
+ attr_accessor :origination_account_id
39
+
40
+ attr_accessor :direction
41
+
42
+ # Attribute mapping from ruby-style variable name to JSON key.
43
+ def self.attribute_map
44
+ {
45
+ :'client_id' => :'client_id',
46
+ :'secret' => :'secret',
47
+ :'start_date' => :'start_date',
48
+ :'end_date' => :'end_date',
49
+ :'count' => :'count',
50
+ :'offset' => :'offset',
51
+ :'origination_account_id' => :'origination_account_id',
52
+ :'direction' => :'direction'
53
+ }
54
+ end
55
+
56
+ # Returns all the JSON keys this model knows about
57
+ def self.acceptable_attributes
58
+ attribute_map.values
59
+ end
60
+
61
+ # Attribute type mapping.
62
+ def self.openapi_types
63
+ {
64
+ :'client_id' => :'String',
65
+ :'secret' => :'String',
66
+ :'start_date' => :'Time',
67
+ :'end_date' => :'Time',
68
+ :'count' => :'Integer',
69
+ :'offset' => :'Integer',
70
+ :'origination_account_id' => :'String',
71
+ :'direction' => :'TransferDirection'
72
+ }
73
+ end
74
+
75
+ # List of attributes with nullable: true
76
+ def self.openapi_nullable
77
+ Set.new([
78
+ :'start_date',
79
+ :'end_date',
80
+ :'origination_account_id',
81
+ :'direction'
82
+ ])
83
+ end
84
+
85
+ # Initializes the object
86
+ # @param [Hash] attributes Model attributes in the form of hash
87
+ def initialize(attributes = {})
88
+ if (!attributes.is_a?(Hash))
89
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferListRequest` initialize method"
90
+ end
91
+
92
+ # check to see if the attribute exists and convert string to symbol for hash key
93
+ attributes = attributes.each_with_object({}) { |(k, v), h|
94
+ if (!self.class.attribute_map.key?(k.to_sym))
95
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferListRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
96
+ end
97
+ h[k.to_sym] = v
98
+ }
99
+
100
+ if attributes.key?(:'client_id')
101
+ self.client_id = attributes[:'client_id']
102
+ end
103
+
104
+ if attributes.key?(:'secret')
105
+ self.secret = attributes[:'secret']
106
+ end
107
+
108
+ if attributes.key?(:'start_date')
109
+ self.start_date = attributes[:'start_date']
110
+ end
111
+
112
+ if attributes.key?(:'end_date')
113
+ self.end_date = attributes[:'end_date']
114
+ end
115
+
116
+ if attributes.key?(:'count')
117
+ self.count = attributes[:'count']
118
+ else
119
+ self.count = 25
120
+ end
121
+
122
+ if attributes.key?(:'offset')
123
+ self.offset = attributes[:'offset']
124
+ else
125
+ self.offset = 0
126
+ end
127
+
128
+ if attributes.key?(:'origination_account_id')
129
+ self.origination_account_id = attributes[:'origination_account_id']
130
+ end
131
+
132
+ if attributes.key?(:'direction')
133
+ self.direction = attributes[:'direction']
134
+ end
135
+ end
136
+
137
+ # Show invalid properties with the reasons. Usually used together with valid?
138
+ # @return Array for valid properties with the reasons
139
+ def list_invalid_properties
140
+ invalid_properties = Array.new
141
+ if !@count.nil? && @count > 25
142
+ invalid_properties.push('invalid value for "count", must be smaller than or equal to 25.')
143
+ end
144
+
145
+ if !@count.nil? && @count < 1
146
+ invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
147
+ end
148
+
149
+
150
+ if !@offset.nil? && @offset < 0
151
+ invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
152
+ end
153
+
154
+
155
+ invalid_properties
156
+ end
157
+
158
+ # Check to see if the all the properties in the model are valid
159
+ # @return true if the model is valid
160
+ def valid?
161
+ return false if !@count.nil? && @count > 25
162
+ return false if !@count.nil? && @count < 1
163
+ return false if !@offset.nil? && @offset < 0
164
+ true
165
+ end
166
+
167
+ # Custom attribute writer method with validation
168
+ # @param [Object] count Value to be assigned
169
+ def count=(count)
170
+ if !count.nil? && count > 25
171
+ fail ArgumentError, 'invalid value for "count", must be smaller than or equal to 25.'
172
+ end
173
+
174
+ if !count.nil? && count < 1
175
+ fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.'
176
+ end
177
+
178
+
179
+ @count = count
180
+ end
181
+
182
+ # Custom attribute writer method with validation
183
+ # @param [Object] offset Value to be assigned
184
+ def offset=(offset)
185
+ if !offset.nil? && offset < 0
186
+ fail ArgumentError, 'invalid value for "offset", must be greater than or equal to 0.'
187
+ end
188
+
189
+
190
+ @offset = offset
191
+ end
192
+
193
+ # Checks equality by comparing each attribute.
194
+ # @param [Object] Object to be compared
195
+ def ==(o)
196
+ return true if self.equal?(o)
197
+ self.class == o.class &&
198
+ client_id == o.client_id &&
199
+ secret == o.secret &&
200
+ start_date == o.start_date &&
201
+ end_date == o.end_date &&
202
+ count == o.count &&
203
+ offset == o.offset &&
204
+ origination_account_id == o.origination_account_id &&
205
+ direction == o.direction
206
+ end
207
+
208
+ # @see the `==` method
209
+ # @param [Object] Object to be compared
210
+ def eql?(o)
211
+ self == o
212
+ end
213
+
214
+ # Calculates hash code according to all attributes.
215
+ # @return [Integer] Hash code
216
+ def hash
217
+ [client_id, secret, start_date, end_date, count, offset, origination_account_id, direction].hash
218
+ end
219
+
220
+ # Builds the object from hash
221
+ # @param [Hash] attributes Model attributes in the form of hash
222
+ # @return [Object] Returns the model itself
223
+ def self.build_from_hash(attributes)
224
+ new.build_from_hash(attributes)
225
+ end
226
+
227
+ # Builds the object from hash
228
+ # @param [Hash] attributes Model attributes in the form of hash
229
+ # @return [Object] Returns the model itself
230
+ def build_from_hash(attributes)
231
+ return nil unless attributes.is_a?(Hash)
232
+ self.class.openapi_types.each_pair do |key, type|
233
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
234
+ self.send("#{key}=", nil)
235
+ elsif type =~ /\AArray<(.*)>/i
236
+ # check to ensure the input is an array given that the attribute
237
+ # is documented as an array but the input is not
238
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
239
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
240
+ end
241
+ elsif !attributes[self.class.attribute_map[key]].nil?
242
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
243
+ end
244
+ end
245
+
246
+ self
247
+ end
248
+
249
+ # Deserializes the data based on type
250
+ # @param string type Data type
251
+ # @param string value Value to be deserialized
252
+ # @return [Object] Deserialized data
253
+ def _deserialize(type, value)
254
+ case type.to_sym
255
+ when :Time
256
+ Time.parse(value)
257
+ when :Date
258
+ Date.parse(value)
259
+ when :String
260
+ value.to_s
261
+ when :Integer
262
+ value.to_i
263
+ when :Float
264
+ value.to_f
265
+ when :Boolean
266
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
267
+ true
268
+ else
269
+ false
270
+ end
271
+ when :Object
272
+ # generic object (usually a Hash), return directly
273
+ value
274
+ when /\AArray<(?<inner_type>.+)>\z/
275
+ inner_type = Regexp.last_match[:inner_type]
276
+ value.map { |v| _deserialize(inner_type, v) }
277
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
278
+ k_type = Regexp.last_match[:k_type]
279
+ v_type = Regexp.last_match[:v_type]
280
+ {}.tap do |hash|
281
+ value.each do |k, v|
282
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
283
+ end
284
+ end
285
+ else # model
286
+ # models (e.g. Pet) or oneOf
287
+ klass = Plaid.const_get(type)
288
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
289
+ end
290
+ end
291
+
292
+ # Returns the string representation of the object
293
+ # @return [String] String presentation of the object
294
+ def to_s
295
+ to_hash.to_s
296
+ end
297
+
298
+ # to_body is an alias to to_hash (backward compatibility)
299
+ # @return [Hash] Returns the object in the form of hash
300
+ def to_body
301
+ to_hash
302
+ end
303
+
304
+ # Returns the object in the form of hash
305
+ # @return [Hash] Returns the object in the form of hash
306
+ def to_hash
307
+ hash = {}
308
+ self.class.attribute_map.each_pair do |attr, param|
309
+ value = self.send(attr)
310
+ if value.nil?
311
+ is_nullable = self.class.openapi_nullable.include?(attr)
312
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
313
+ end
314
+
315
+ hash[param] = _to_hash(value)
316
+ end
317
+ hash
318
+ end
319
+
320
+ # Outputs non-array value in the form of hash
321
+ # For object, use to_hash. Otherwise, just return the value
322
+ # @param [Object] value Any valid value
323
+ # @return [Hash] Returns the value in the form of hash
324
+ def _to_hash(value)
325
+ if value.is_a?(Array)
326
+ value.compact.map { |v| _to_hash(v) }
327
+ elsif value.is_a?(Hash)
328
+ {}.tap do |hash|
329
+ value.each { |k, v| hash[k] = _to_hash(v) }
330
+ end
331
+ elsif value.respond_to? :to_hash
332
+ value.to_hash
333
+ else
334
+ value
335
+ end
336
+ end
337
+
338
+ end
339
+
340
+ end