plaid 14.5.0 → 14.9.0

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