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