plaid 14.0.0.beta.5 → 14.3.0

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