plaid 14.0.0 → 14.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (440) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -2
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +718 -5
  6. data/lib/plaid/api_client.rb +1 -1
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +3 -3
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +2 -2
  13. data/lib/plaid/models/account_base.rb +3 -3
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +3 -3
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  19. data/lib/plaid/models/account_subtype.rb +2 -1
  20. data/lib/plaid/models/account_type.rb +1 -1
  21. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  22. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  23. data/lib/plaid/models/accounts_get_request.rb +1 -1
  24. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  25. data/lib/plaid/models/accounts_get_response.rb +1 -1
  26. data/lib/plaid/models/ach_class.rb +1 -1
  27. data/lib/plaid/models/address.rb +1 -1
  28. data/lib/plaid/models/address_data.rb +1 -1
  29. data/lib/plaid/models/address_data_nullable.rb +1 -1
  30. data/lib/plaid/models/address_nullable.rb +1 -1
  31. data/lib/plaid/models/application.rb +2 -2
  32. data/lib/plaid/models/application_get_request.rb +1 -1
  33. data/lib/plaid/models/application_get_response.rb +1 -1
  34. data/lib/plaid/models/apr.rb +1 -1
  35. data/lib/plaid/models/asset_report.rb +2 -2
  36. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  37. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  38. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  39. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  40. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  41. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  42. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  43. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  44. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  45. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  46. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  47. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  48. data/lib/plaid/models/asset_report_item.rb +2 -2
  49. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  50. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  51. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  52. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  53. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  55. data/lib/plaid/models/asset_report_transaction.rb +2 -2
  56. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  57. data/lib/plaid/models/asset_report_user.rb +1 -1
  58. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  59. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  60. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  61. data/lib/plaid/models/auth_get_request.rb +1 -1
  62. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  63. data/lib/plaid/models/auth_get_response.rb +1 -1
  64. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  65. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  66. data/lib/plaid/models/bank_transfer.rb +2 -2
  67. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  68. data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
  69. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  70. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  71. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  72. data/lib/plaid/models/bank_transfer_create_request.rb +4 -4
  73. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  74. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  75. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  76. data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
  77. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  78. data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
  79. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  80. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  81. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  82. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  83. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  84. data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  89. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  90. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  91. data/lib/plaid/models/bank_transfer_sweep.rb +316 -0
  92. data/lib/plaid/models/bank_transfer_sweep_account.rb +238 -0
  93. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +277 -0
  94. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
  95. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  97. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  98. data/lib/plaid/models/categories_get_response.rb +1 -1
  99. data/lib/plaid/models/category.rb +1 -1
  100. data/lib/plaid/models/cause.rb +1 -1
  101. data/lib/plaid/models/connected_application.rb +3 -3
  102. data/lib/plaid/models/country_code.rb +1 -1
  103. data/lib/plaid/models/credit_card_liability.rb +4 -4
  104. data/lib/plaid/models/credit_filter.rb +1 -1
  105. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  106. data/lib/plaid/models/deductions.rb +232 -0
  107. data/lib/plaid/models/default_update_webhook.rb +1 -1
  108. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  109. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  110. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  111. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  112. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  113. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  114. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  115. data/lib/plaid/models/deposit_switch_get_response.rb +3 -3
  116. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  117. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  118. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  119. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  120. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  121. data/lib/plaid/models/depository_filter.rb +1 -1
  122. data/lib/plaid/models/distribution_details.rb +263 -0
  123. data/lib/plaid/models/document_metadata.rb +240 -0
  124. data/lib/plaid/models/earnings.rb +232 -0
  125. data/lib/plaid/models/earnings_total.rb +304 -0
  126. data/lib/plaid/models/email.rb +1 -1
  127. data/lib/plaid/models/employee.rb +30 -6
  128. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  129. data/lib/plaid/models/employer.rb +1 -1
  130. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  131. data/lib/plaid/models/employers_search_request.rb +1 -1
  132. data/lib/plaid/models/employers_search_response.rb +1 -1
  133. data/lib/plaid/models/employment_details.rb +230 -0
  134. data/lib/plaid/models/error.rb +1 -1
  135. data/lib/plaid/models/external_payment_options.rb +1 -1
  136. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  137. data/lib/plaid/models/external_payment_schedule_base.rb +4 -4
  138. data/lib/plaid/models/external_payment_schedule_get.rb +4 -4
  139. data/lib/plaid/models/external_payment_schedule_request.rb +4 -4
  140. data/lib/plaid/models/health_incident.rb +3 -3
  141. data/lib/plaid/models/historical_balance.rb +2 -2
  142. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  143. data/lib/plaid/models/holding.rb +1 -1
  144. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  145. data/lib/plaid/models/holdings_override.rb +289 -0
  146. data/lib/plaid/models/identity_get_request.rb +1 -1
  147. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  148. data/lib/plaid/models/identity_get_response.rb +1 -1
  149. data/lib/plaid/models/incident_update.rb +2 -2
  150. data/lib/plaid/models/income_breakdown.rb +2 -1
  151. data/lib/plaid/models/income_summary.rb +1 -1
  152. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  153. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  154. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  155. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  156. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -10
  157. data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
  158. data/lib/plaid/models/income_verification_paystub_get_request.rb +252 -0
  159. data/lib/plaid/models/income_verification_paystubs_get_request.rb +17 -10
  160. data/lib/plaid/models/income_verification_paystubs_get_response.rb +23 -2
  161. data/lib/plaid/models/income_verification_refresh_request.rb +17 -10
  162. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  163. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  164. data/lib/plaid/models/income_verification_summary_get_request.rb +17 -10
  165. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  166. data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
  167. data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
  168. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  169. data/lib/plaid/models/inflow_model.rb +1 -1
  170. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  171. data/lib/plaid/models/institution.rb +1 -1
  172. data/lib/plaid/models/institution_status.rb +1 -1
  173. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  174. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  175. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  176. data/lib/plaid/models/institutions_get_request.rb +1 -1
  177. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  178. data/lib/plaid/models/institutions_get_response.rb +1 -1
  179. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  180. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  181. data/lib/plaid/models/institutions_search_request.rb +1 -1
  182. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  183. data/lib/plaid/models/institutions_search_response.rb +1 -1
  184. data/lib/plaid/models/investment_filter.rb +1 -1
  185. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  186. data/lib/plaid/models/investment_transaction.rb +4 -4
  187. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  188. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  189. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  190. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  191. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  192. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  193. data/lib/plaid/models/investments_transactions_override.rb +319 -0
  194. data/lib/plaid/models/item.rb +1 -1
  195. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  196. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  197. data/lib/plaid/models/item_application_list_request.rb +1 -1
  198. data/lib/plaid/models/item_application_list_response.rb +1 -1
  199. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  200. data/lib/plaid/models/item_application_scopes_update_request.rb +29 -5
  201. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  202. data/lib/plaid/models/item_error_webhook.rb +1 -1
  203. data/lib/plaid/models/item_get_request.rb +1 -1
  204. data/lib/plaid/models/item_get_response.rb +1 -1
  205. data/lib/plaid/models/item_import_request.rb +1 -1
  206. data/lib/plaid/models/item_import_request_options.rb +1 -1
  207. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  208. data/lib/plaid/models/item_import_response.rb +1 -1
  209. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  210. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  211. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  212. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  213. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  214. data/lib/plaid/models/item_remove_request.rb +1 -1
  215. data/lib/plaid/models/item_remove_response.rb +1 -1
  216. data/lib/plaid/models/item_status.rb +1 -1
  217. data/lib/plaid/models/item_status_investments.rb +3 -3
  218. data/lib/plaid/models/item_status_last_webhook.rb +2 -2
  219. data/lib/plaid/models/item_status_nullable.rb +1 -1
  220. data/lib/plaid/models/item_status_transactions.rb +3 -3
  221. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  222. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  223. data/lib/plaid/models/jwk_public_key.rb +3 -1
  224. data/lib/plaid/models/jwt_header.rb +1 -1
  225. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  226. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  227. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  228. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  229. data/lib/plaid/models/liabilities_object.rb +1 -1
  230. data/lib/plaid/models/liability_override.rb +2 -2
  231. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  232. data/lib/plaid/models/link_token_create_request.rb +3 -3
  233. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  234. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  235. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  236. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  237. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  238. data/lib/plaid/models/link_token_create_request_user.rb +3 -3
  239. data/lib/plaid/models/link_token_create_response.rb +2 -2
  240. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  241. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  242. data/lib/plaid/models/link_token_get_request.rb +1 -1
  243. data/lib/plaid/models/link_token_get_response.rb +3 -3
  244. data/lib/plaid/models/loan_filter.rb +1 -1
  245. data/lib/plaid/models/location.rb +1 -1
  246. data/lib/plaid/models/meta.rb +1 -1
  247. data/lib/plaid/models/mfa.rb +1 -1
  248. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  249. data/lib/plaid/models/mortgage_liability.rb +5 -5
  250. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  251. data/lib/plaid/models/net_pay.rb +230 -0
  252. data/lib/plaid/models/numbers.rb +1 -1
  253. data/lib/plaid/models/numbers_ach.rb +1 -1
  254. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  255. data/lib/plaid/models/numbers_bacs.rb +1 -1
  256. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  257. data/lib/plaid/models/numbers_eft.rb +1 -1
  258. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  259. data/lib/plaid/models/numbers_international.rb +1 -1
  260. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  261. data/lib/plaid/models/override_account_type.rb +1 -1
  262. data/lib/plaid/models/override_accounts.rb +20 -2
  263. data/lib/plaid/models/owner.rb +1 -1
  264. data/lib/plaid/models/owner_override.rb +1 -1
  265. data/lib/plaid/models/pay.rb +258 -0
  266. data/lib/plaid/models/pay_frequency.rb +1 -1
  267. data/lib/plaid/models/pay_period_details.rb +4 -4
  268. data/lib/plaid/models/payment_amount.rb +1 -1
  269. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  270. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  271. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  272. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  273. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  274. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  275. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  276. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  277. data/lib/plaid/models/payment_initiation_payment_list_request.rb +28 -2
  278. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  279. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  280. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  281. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  282. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  283. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  284. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  285. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  286. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  287. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  288. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  289. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  290. data/lib/plaid/models/payment_meta.rb +1 -1
  291. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  292. data/lib/plaid/models/payment_status_update_webhook.rb +3 -3
  293. data/lib/plaid/models/paystub.rb +58 -12
  294. data/lib/plaid/models/paystub_address.rb +297 -0
  295. data/lib/plaid/models/paystub_deduction.rb +1 -1
  296. data/lib/plaid/models/paystub_details.rb +299 -0
  297. data/lib/plaid/models/paystub_employer.rb +15 -6
  298. data/lib/plaid/models/paystub_ytd_details.rb +3 -11
  299. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  300. data/lib/plaid/models/phone_number.rb +1 -1
  301. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  302. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  303. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  304. data/lib/plaid/models/processor_balance_get_request.rb +14 -5
  305. data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
  306. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  307. data/lib/plaid/models/processor_bank_transfer_create_request.rb +4 -4
  308. data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
  309. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  310. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  311. data/lib/plaid/models/processor_number.rb +1 -1
  312. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  313. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  314. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  315. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  316. data/lib/plaid/models/product_access.rb +1 -1
  317. data/lib/plaid/models/product_status.rb +2 -2
  318. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  319. data/lib/plaid/models/products.rb +1 -1
  320. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  321. data/lib/plaid/models/pslf_status.rb +2 -2
  322. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  323. data/lib/plaid/models/recipient_bacs.rb +1 -1
  324. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  325. data/lib/plaid/models/requested_scopes.rb +1 -1
  326. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  327. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  328. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  329. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  330. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  331. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  332. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  333. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  334. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  335. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  336. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  337. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  338. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  339. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  340. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  341. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  342. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  343. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  344. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  345. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  346. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
  347. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
  348. data/lib/plaid/models/scopes.rb +1 -1
  349. data/lib/plaid/models/scopes_context.rb +37 -0
  350. data/lib/plaid/models/scopes_nullable.rb +1 -1
  351. data/lib/plaid/models/security.rb +1 -1
  352. data/lib/plaid/models/security_override.rb +270 -0
  353. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  354. data/lib/plaid/models/servicer_address_data.rb +1 -1
  355. data/lib/plaid/models/signal_address_data.rb +1 -1
  356. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  357. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  358. data/lib/plaid/models/signal_device.rb +1 -1
  359. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  360. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  361. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  362. data/lib/plaid/models/signal_person_name.rb +1 -1
  363. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  364. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  365. data/lib/plaid/models/signal_scores.rb +1 -1
  366. data/lib/plaid/models/signal_user.rb +1 -1
  367. data/lib/plaid/models/standalone_account_type.rb +1 -1
  368. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  369. data/lib/plaid/models/standalone_investment_transaction_type.rb +3 -3
  370. data/lib/plaid/models/student_loan.rb +7 -7
  371. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  372. data/lib/plaid/models/student_loan_status.rb +2 -2
  373. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  374. data/lib/plaid/models/taxform.rb +233 -0
  375. data/lib/plaid/models/taxpayer_id.rb +257 -0
  376. data/lib/plaid/models/total.rb +284 -0
  377. data/lib/plaid/models/transaction.rb +17 -6
  378. data/lib/plaid/models/transaction_all_of.rb +16 -5
  379. data/lib/plaid/models/transaction_base.rb +2 -2
  380. data/lib/plaid/models/transaction_code.rb +1 -1
  381. data/lib/plaid/models/transaction_data.rb +2 -2
  382. data/lib/plaid/models/transaction_override.rb +3 -3
  383. data/lib/plaid/models/transactions_get_request.rb +1 -1
  384. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  385. data/lib/plaid/models/transactions_get_response.rb +1 -1
  386. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  387. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  388. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  389. data/lib/plaid/models/transfer.rb +453 -0
  390. data/lib/plaid/models/transfer_authorization.rb +313 -0
  391. data/lib/plaid/models/transfer_authorization_create_request.rb +401 -0
  392. data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
  393. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +274 -0
  394. data/lib/plaid/models/transfer_authorization_device.rb +230 -0
  395. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +342 -0
  396. data/lib/plaid/models/transfer_cancel_request.rb +245 -0
  397. data/lib/plaid/models/transfer_cancel_response.rb +225 -0
  398. data/lib/plaid/models/transfer_create_request.rb +489 -0
  399. data/lib/plaid/models/transfer_create_response.rb +239 -0
  400. data/lib/plaid/models/transfer_direction.rb +38 -0
  401. data/lib/plaid/models/transfer_event.rb +390 -0
  402. data/lib/plaid/models/transfer_event_list_request.rb +434 -0
  403. data/lib/plaid/models/transfer_event_list_response.rb +241 -0
  404. data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
  405. data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
  406. data/lib/plaid/models/transfer_event_type.rb +42 -0
  407. data/lib/plaid/models/transfer_failure.rb +231 -0
  408. data/lib/plaid/models/transfer_get_request.rb +245 -0
  409. data/lib/plaid/models/transfer_get_response.rb +239 -0
  410. data/lib/plaid/models/transfer_list_request.rb +340 -0
  411. data/lib/plaid/models/transfer_list_response.rb +241 -0
  412. data/lib/plaid/models/transfer_network.rb +37 -0
  413. data/lib/plaid/models/transfer_receiver_details.rb +255 -0
  414. data/lib/plaid/models/transfer_status.rb +40 -0
  415. data/lib/plaid/models/transfer_type.rb +37 -0
  416. data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
  417. data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
  418. data/lib/plaid/models/transfer_user_in_request.rb +254 -0
  419. data/lib/plaid/models/transfer_user_in_response.rb +257 -0
  420. data/lib/plaid/models/user_custom_password.rb +1 -1
  421. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  422. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  423. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  424. data/lib/plaid/models/verification_status.rb +1 -1
  425. data/lib/plaid/models/w2.rb +437 -0
  426. data/lib/plaid/models/w2_box12.rb +231 -0
  427. data/lib/plaid/models/w2_state_and_local_wages.rb +286 -0
  428. data/lib/plaid/models/warning.rb +1 -1
  429. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  430. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  431. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  432. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  433. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  434. data/lib/plaid/version.rb +2 -2
  435. data/lib/plaid.rb +62 -2
  436. data/pkg/plaid-14.0.0.gem +0 -0
  437. data/pkg/plaid-14.1.0.gem +0 -0
  438. data/plaid.gemspec +1 -1
  439. metadata +65 -3
  440. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6eb0d7d14bf37262c2512547e40a260a6f91b4588bd649a457e515fd0133e6bb
4
- data.tar.gz: 82b314e48ef6c3ab39d186de4540a6d45ae0f94619bdce7d02777077c338628e
3
+ metadata.gz: 78d707a9478be29160a0a732af7e85555674d4f564201ae363590ff5003debdd
4
+ data.tar.gz: '083baef42424e0b7fc5d291579017c6289ff7f0281886ec69481398aea320c6f'
5
5
  SHA512:
6
- metadata.gz: e4903a1b19b4014d1a0135f5846910e2c46622ea757eb50e60fd34521f33efbf50eb50afaa7dea79307a60426754701e70ada4ac341b312e7435543566c57750
7
- data.tar.gz: c99e421ec181e3104df80a382446bf0edf49edb61d82085d569466e71a495609c161db88a8a23deb369c8a06e8d95da3d00c3e055f209f872b0e275c3e0c80f3
6
+ metadata.gz: fc71e7d030eef17daa4af9bc5161240d1b0f2c18d5274578d941b9da328d9facf8d4f0a70e192a0e6011d850e184eccbacf0bfeaf81eb1c93a41250def8bd653
7
+ data.tar.gz: 6e2634b7e048a35909f092a2b01f57bb9796dd650cd375bbefd88d503dae028815bc366415fb139b9be89dff66d20c3de476a96354331eb48153bcadda19be68
data/CHANGELOG.md CHANGED
@@ -1,7 +1,9 @@
1
- See full changelog for the OpenAPI schema [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1
+ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2
2
 
3
- # 14.0.0
3
+ # 14.1.0
4
+ Updating to OAS 2020-09-14_1.26.1.
4
5
 
6
+ # 14.0.0
5
7
  The official release of the `plaid-ruby` generated library. Refer to the beta migration guide for tips on migrating from older version of the libraries.
6
8
 
7
9
  This particular version is pinned to OpenAPI version `2020-09-14_1.20.6`.
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- plaid (14.0.0)
4
+ plaid (14.1.0)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -10,7 +10,7 @@ GEM
10
10
  ast (2.4.1)
11
11
  diff-lcs (1.4.4)
12
12
  dotenv (2.7.6)
13
- faraday (1.7.0)
13
+ faraday (1.7.1)
14
14
  faraday-em_http (~> 1.0)
15
15
  faraday-em_synchrony (~> 1.0)
16
16
  faraday-excon (~> 1.1)
data/Makefile CHANGED
@@ -1,2 +1,2 @@
1
1
  # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
2
- RUBY_PACKAGE_VERSION=14.0.0
2
+ RUBY_PACKAGE_VERSION=14.1.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.20.6
6
+ The version of the OpenAPI document: 2020-09-14_1.26.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -1125,7 +1125,7 @@ module Plaid
1125
1125
  end
1126
1126
 
1127
1127
  # Sync bank transfer events
1128
- # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1128
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1129
1129
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1130
1130
  # @param [Hash] opts the optional parameters
1131
1131
  # @return [BankTransferEventSyncResponse]
@@ -1135,7 +1135,7 @@ module Plaid
1135
1135
  end
1136
1136
 
1137
1137
  # Sync bank transfer events
1138
- # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1138
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1139
1139
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1140
1140
  # @param [Hash] opts the optional parameters
1141
1141
  # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
@@ -1384,6 +1384,71 @@ module Plaid
1384
1384
  return data, status_code, headers
1385
1385
  end
1386
1386
 
1387
+ # Retrieve a sweep
1388
+ # The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
1389
+ # @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
1390
+ # @param [Hash] opts the optional parameters
1391
+ # @return [BankTransferSweepGetResponse]
1392
+ def bank_transfer_sweep_get(bank_transfer_sweep_get_request, opts = {})
1393
+ data, _status_code, _headers = bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts)
1394
+ data
1395
+ end
1396
+
1397
+ # Retrieve a sweep
1398
+ # The &#x60;/bank_transfer/sweep/get&#x60; endpoint fetches information about the sweep corresponding to the given &#x60;sweep_id&#x60;.
1399
+ # @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
1400
+ # @param [Hash] opts the optional parameters
1401
+ # @return [Array<(BankTransferSweepGetResponse, Integer, Hash)>] BankTransferSweepGetResponse data, response status code and response headers
1402
+ def bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts = {})
1403
+ if @api_client.config.debugging
1404
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_get ...'
1405
+ end
1406
+ # verify the required parameter 'bank_transfer_sweep_get_request' is set
1407
+ if @api_client.config.client_side_validation && bank_transfer_sweep_get_request.nil?
1408
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_get_request' when calling PlaidApi.bank_transfer_sweep_get"
1409
+ end
1410
+ # resource path
1411
+ local_var_path = '/bank_transfer/sweep/get'
1412
+
1413
+ # query parameters
1414
+ query_params = opts[:query_params] || {}
1415
+
1416
+ # header parameters
1417
+ header_params = opts[:header_params] || {}
1418
+ # HTTP header 'Accept' (if needed)
1419
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1420
+ # HTTP header 'Content-Type'
1421
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1422
+
1423
+ # form parameters
1424
+ form_params = opts[:form_params] || {}
1425
+
1426
+ # http body (model)
1427
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_get_request)
1428
+
1429
+ # return_type
1430
+ return_type = opts[:debug_return_type] || 'BankTransferSweepGetResponse'
1431
+
1432
+ # auth_names
1433
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1434
+
1435
+ new_options = opts.merge(
1436
+ :operation => :"PlaidApi.bank_transfer_sweep_get",
1437
+ :header_params => header_params,
1438
+ :query_params => query_params,
1439
+ :form_params => form_params,
1440
+ :body => post_body,
1441
+ :auth_names => auth_names,
1442
+ :return_type => return_type
1443
+ )
1444
+
1445
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1446
+ if @api_client.config.debugging
1447
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1448
+ end
1449
+ return data, status_code, headers
1450
+ end
1451
+
1387
1452
  # Get Categories
1388
1453
  # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1389
1454
  # @param body [Object]
@@ -2034,6 +2099,69 @@ module Plaid
2034
2099
  return data, status_code, headers
2035
2100
  end
2036
2101
 
2102
+ # (Deprecated) Retrieve information from a single paystub used for income verification
2103
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2104
+ # @param [Hash] opts the optional parameters
2105
+ # @return [nil]
2106
+ def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
2107
+ income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
2108
+ nil
2109
+ end
2110
+
2111
+ # (Deprecated) Retrieve information from a single paystub used for income verification
2112
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2113
+ # @param [Hash] opts the optional parameters
2114
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2115
+ def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
2116
+ if @api_client.config.debugging
2117
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
2118
+ end
2119
+ # verify the required parameter 'income_verification_paystub_get_request' is set
2120
+ if @api_client.config.client_side_validation && income_verification_paystub_get_request.nil?
2121
+ fail ArgumentError, "Missing the required parameter 'income_verification_paystub_get_request' when calling PlaidApi.income_verification_paystub_get"
2122
+ end
2123
+ # resource path
2124
+ local_var_path = '/income/verification/paystub/get'
2125
+
2126
+ # query parameters
2127
+ query_params = opts[:query_params] || {}
2128
+
2129
+ # header parameters
2130
+ header_params = opts[:header_params] || {}
2131
+ # HTTP header 'Accept' (if needed)
2132
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2133
+ # HTTP header 'Content-Type'
2134
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2135
+
2136
+ # form parameters
2137
+ form_params = opts[:form_params] || {}
2138
+
2139
+ # http body (model)
2140
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
2141
+
2142
+ # return_type
2143
+ return_type = opts[:debug_return_type]
2144
+
2145
+ # auth_names
2146
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2147
+
2148
+ new_options = opts.merge(
2149
+ :operation => :"PlaidApi.income_verification_paystub_get",
2150
+ :header_params => header_params,
2151
+ :query_params => query_params,
2152
+ :form_params => form_params,
2153
+ :body => post_body,
2154
+ :auth_names => auth_names,
2155
+ :return_type => return_type
2156
+ )
2157
+
2158
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2159
+ if @api_client.config.debugging
2160
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2161
+ end
2162
+ return data, status_code, headers
2163
+ end
2164
+
2037
2165
  # Retrieve information from the paystubs used for income verification
2038
2166
  # `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2039
2167
  # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
@@ -2229,8 +2357,73 @@ module Plaid
2229
2357
  return data, status_code, headers
2230
2358
  end
2231
2359
 
2360
+ # Retrieve information from the tax documents used for income verification
2361
+ # `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2362
+ # @param request_body [Hash<String, Object>]
2363
+ # @param [Hash] opts the optional parameters
2364
+ # @return [IncomeVerificationTaxformsGetResponse]
2365
+ def income_verification_taxforms_get(request_body, opts = {})
2366
+ data, _status_code, _headers = income_verification_taxforms_get_with_http_info(request_body, opts)
2367
+ data
2368
+ end
2369
+
2370
+ # Retrieve information from the tax documents used for income verification
2371
+ # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from taxforms that were used to verify an end user&#39;s. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2372
+ # @param request_body [Hash<String, Object>]
2373
+ # @param [Hash] opts the optional parameters
2374
+ # @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
2375
+ def income_verification_taxforms_get_with_http_info(request_body, opts = {})
2376
+ if @api_client.config.debugging
2377
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_get ...'
2378
+ end
2379
+ # verify the required parameter 'request_body' is set
2380
+ if @api_client.config.client_side_validation && request_body.nil?
2381
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.income_verification_taxforms_get"
2382
+ end
2383
+ # resource path
2384
+ local_var_path = '/income/verification/taxforms/get'
2385
+
2386
+ # query parameters
2387
+ query_params = opts[:query_params] || {}
2388
+
2389
+ # header parameters
2390
+ header_params = opts[:header_params] || {}
2391
+ # HTTP header 'Accept' (if needed)
2392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2393
+ # HTTP header 'Content-Type'
2394
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2395
+
2396
+ # form parameters
2397
+ form_params = opts[:form_params] || {}
2398
+
2399
+ # http body (model)
2400
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
2401
+
2402
+ # return_type
2403
+ return_type = opts[:debug_return_type] || 'IncomeVerificationTaxformsGetResponse'
2404
+
2405
+ # auth_names
2406
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2407
+
2408
+ new_options = opts.merge(
2409
+ :operation => :"PlaidApi.income_verification_taxforms_get",
2410
+ :header_params => header_params,
2411
+ :query_params => query_params,
2412
+ :form_params => form_params,
2413
+ :body => post_body,
2414
+ :auth_names => auth_names,
2415
+ :return_type => return_type
2416
+ )
2417
+
2418
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2419
+ if @api_client.config.debugging
2420
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_taxforms_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2421
+ end
2422
+ return data, status_code, headers
2423
+ end
2424
+
2232
2425
  # Get details of all supported institutions
2233
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
2426
+ # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
2234
2427
  # @param institutions_get_request [InstitutionsGetRequest]
2235
2428
  # @param [Hash] opts the optional parameters
2236
2429
  # @return [InstitutionsGetResponse]
@@ -2240,7 +2433,7 @@ module Plaid
2240
2433
  end
2241
2434
 
2242
2435
  # Get details of all supported institutions
2243
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
2436
+ # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
2244
2437
  # @param institutions_get_request [InstitutionsGetRequest]
2245
2438
  # @param [Hash] opts the optional parameters
2246
2439
  # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
@@ -4762,6 +4955,71 @@ module Plaid
4762
4955
  return data, status_code, headers
4763
4956
  end
4764
4957
 
4958
+ # Simulate a transfer event in Sandbox
4959
+ # Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
4960
+ # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
4961
+ # @param [Hash] opts the optional parameters
4962
+ # @return [SandboxTransferSimulateResponse]
4963
+ def sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {})
4964
+ data, _status_code, _headers = sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts)
4965
+ data
4966
+ end
4967
+
4968
+ # Simulate a transfer event in Sandbox
4969
+ # Use the &#x60;/sandbox/transfer/simulate&#x60; endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
4970
+ # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
4971
+ # @param [Hash] opts the optional parameters
4972
+ # @return [Array<(SandboxTransferSimulateResponse, Integer, Hash)>] SandboxTransferSimulateResponse data, response status code and response headers
4973
+ def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {})
4974
+ if @api_client.config.debugging
4975
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_simulate ...'
4976
+ end
4977
+ # verify the required parameter 'sandbox_transfer_simulate_request' is set
4978
+ if @api_client.config.client_side_validation && sandbox_transfer_simulate_request.nil?
4979
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_simulate_request' when calling PlaidApi.sandbox_transfer_simulate"
4980
+ end
4981
+ # resource path
4982
+ local_var_path = '/sandbox/transfer/simulate'
4983
+
4984
+ # query parameters
4985
+ query_params = opts[:query_params] || {}
4986
+
4987
+ # header parameters
4988
+ header_params = opts[:header_params] || {}
4989
+ # HTTP header 'Accept' (if needed)
4990
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4991
+ # HTTP header 'Content-Type'
4992
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4993
+
4994
+ # form parameters
4995
+ form_params = opts[:form_params] || {}
4996
+
4997
+ # http body (model)
4998
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_simulate_request)
4999
+
5000
+ # return_type
5001
+ return_type = opts[:debug_return_type] || 'SandboxTransferSimulateResponse'
5002
+
5003
+ # auth_names
5004
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5005
+
5006
+ new_options = opts.merge(
5007
+ :operation => :"PlaidApi.sandbox_transfer_simulate",
5008
+ :header_params => header_params,
5009
+ :query_params => query_params,
5010
+ :form_params => form_params,
5011
+ :body => post_body,
5012
+ :auth_names => auth_names,
5013
+ :return_type => return_type
5014
+ )
5015
+
5016
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5017
+ if @api_client.config.debugging
5018
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5019
+ end
5020
+ return data, status_code, headers
5021
+ end
5022
+
4765
5023
  # Report whether you initiated an ACH transaction
4766
5024
  # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
4767
5025
  # @param signal_decision_report_request [SignalDecisionReportRequest]
@@ -5087,6 +5345,461 @@ module Plaid
5087
5345
  return data, status_code, headers
5088
5346
  end
5089
5347
 
5348
+ # Create a transfer authorization
5349
+ # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, create an Item in Link with the username `user_good` and password `pass_good` - To decline a transfer with the rationale code `NSF`, create an Item in Link with the username `declined_nsf_good` and password `pass_good` - To decline a transfer with the rationale code `RISK`, create an Item in Link with the username `declined_risk_good` and password `pass_good` - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
5350
+ # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5351
+ # @param [Hash] opts the optional parameters
5352
+ # @return [TransferAuthorizationCreateResponse]
5353
+ def transfer_authorization_create(transfer_authorization_create_request, opts = {})
5354
+ data, _status_code, _headers = transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts)
5355
+ data
5356
+ end
5357
+
5358
+ # Create a transfer authorization
5359
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s sandbox environment the decisions will be returned as follows: - To approve a transfer, create an Item in Link with the username &#x60;user_good&#x60; and password &#x60;pass_good&#x60; - To decline a transfer with the rationale code &#x60;NSF&#x60;, create an Item in Link with the username &#x60;declined_nsf_good&#x60; and password &#x60;pass_good&#x60; - To decline a transfer with the rationale code &#x60;RISK&#x60;, create an Item in Link with the username &#x60;declined_risk_good&#x60; and password &#x60;pass_good&#x60; - To permit a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code &#x60;ERROR&#x60;.
5360
+ # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5361
+ # @param [Hash] opts the optional parameters
5362
+ # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
5363
+ def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
5364
+ if @api_client.config.debugging
5365
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
5366
+ end
5367
+ # verify the required parameter 'transfer_authorization_create_request' is set
5368
+ if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
5369
+ fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
5370
+ end
5371
+ # resource path
5372
+ local_var_path = '/transfer/authorization/create'
5373
+
5374
+ # query parameters
5375
+ query_params = opts[:query_params] || {}
5376
+
5377
+ # header parameters
5378
+ header_params = opts[:header_params] || {}
5379
+ # HTTP header 'Accept' (if needed)
5380
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5381
+ # HTTP header 'Content-Type'
5382
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5383
+
5384
+ # form parameters
5385
+ form_params = opts[:form_params] || {}
5386
+
5387
+ # http body (model)
5388
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)
5389
+
5390
+ # return_type
5391
+ return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'
5392
+
5393
+ # auth_names
5394
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5395
+
5396
+ new_options = opts.merge(
5397
+ :operation => :"PlaidApi.transfer_authorization_create",
5398
+ :header_params => header_params,
5399
+ :query_params => query_params,
5400
+ :form_params => form_params,
5401
+ :body => post_body,
5402
+ :auth_names => auth_names,
5403
+ :return_type => return_type
5404
+ )
5405
+
5406
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5407
+ if @api_client.config.debugging
5408
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5409
+ end
5410
+ return data, status_code, headers
5411
+ end
5412
+
5413
+ # Cancel a transfer
5414
+ # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
5415
+ # @param transfer_cancel_request [TransferCancelRequest]
5416
+ # @param [Hash] opts the optional parameters
5417
+ # @return [TransferCancelResponse]
5418
+ def transfer_cancel(transfer_cancel_request, opts = {})
5419
+ data, _status_code, _headers = transfer_cancel_with_http_info(transfer_cancel_request, opts)
5420
+ data
5421
+ end
5422
+
5423
+ # Cancel a transfer
5424
+ # Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
5425
+ # @param transfer_cancel_request [TransferCancelRequest]
5426
+ # @param [Hash] opts the optional parameters
5427
+ # @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
5428
+ def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
5429
+ if @api_client.config.debugging
5430
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
5431
+ end
5432
+ # verify the required parameter 'transfer_cancel_request' is set
5433
+ if @api_client.config.client_side_validation && transfer_cancel_request.nil?
5434
+ fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
5435
+ end
5436
+ # resource path
5437
+ local_var_path = '/transfer/cancel'
5438
+
5439
+ # query parameters
5440
+ query_params = opts[:query_params] || {}
5441
+
5442
+ # header parameters
5443
+ header_params = opts[:header_params] || {}
5444
+ # HTTP header 'Accept' (if needed)
5445
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5446
+ # HTTP header 'Content-Type'
5447
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5448
+
5449
+ # form parameters
5450
+ form_params = opts[:form_params] || {}
5451
+
5452
+ # http body (model)
5453
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_cancel_request)
5454
+
5455
+ # return_type
5456
+ return_type = opts[:debug_return_type] || 'TransferCancelResponse'
5457
+
5458
+ # auth_names
5459
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5460
+
5461
+ new_options = opts.merge(
5462
+ :operation => :"PlaidApi.transfer_cancel",
5463
+ :header_params => header_params,
5464
+ :query_params => query_params,
5465
+ :form_params => form_params,
5466
+ :body => post_body,
5467
+ :auth_names => auth_names,
5468
+ :return_type => return_type
5469
+ )
5470
+
5471
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5472
+ if @api_client.config.debugging
5473
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5474
+ end
5475
+ return data, status_code, headers
5476
+ end
5477
+
5478
+ # Create a transfer
5479
+ # Use the `/transfer/create` endpoint to initiate a new transfer.
5480
+ # @param transfer_create_request [TransferCreateRequest]
5481
+ # @param [Hash] opts the optional parameters
5482
+ # @return [TransferCreateResponse]
5483
+ def transfer_create(transfer_create_request, opts = {})
5484
+ data, _status_code, _headers = transfer_create_with_http_info(transfer_create_request, opts)
5485
+ data
5486
+ end
5487
+
5488
+ # Create a transfer
5489
+ # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer.
5490
+ # @param transfer_create_request [TransferCreateRequest]
5491
+ # @param [Hash] opts the optional parameters
5492
+ # @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
5493
+ def transfer_create_with_http_info(transfer_create_request, opts = {})
5494
+ if @api_client.config.debugging
5495
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_create ...'
5496
+ end
5497
+ # verify the required parameter 'transfer_create_request' is set
5498
+ if @api_client.config.client_side_validation && transfer_create_request.nil?
5499
+ fail ArgumentError, "Missing the required parameter 'transfer_create_request' when calling PlaidApi.transfer_create"
5500
+ end
5501
+ # resource path
5502
+ local_var_path = '/transfer/create'
5503
+
5504
+ # query parameters
5505
+ query_params = opts[:query_params] || {}
5506
+
5507
+ # header parameters
5508
+ header_params = opts[:header_params] || {}
5509
+ # HTTP header 'Accept' (if needed)
5510
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5511
+ # HTTP header 'Content-Type'
5512
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5513
+
5514
+ # form parameters
5515
+ form_params = opts[:form_params] || {}
5516
+
5517
+ # http body (model)
5518
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_create_request)
5519
+
5520
+ # return_type
5521
+ return_type = opts[:debug_return_type] || 'TransferCreateResponse'
5522
+
5523
+ # auth_names
5524
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5525
+
5526
+ new_options = opts.merge(
5527
+ :operation => :"PlaidApi.transfer_create",
5528
+ :header_params => header_params,
5529
+ :query_params => query_params,
5530
+ :form_params => form_params,
5531
+ :body => post_body,
5532
+ :auth_names => auth_names,
5533
+ :return_type => return_type
5534
+ )
5535
+
5536
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5537
+ if @api_client.config.debugging
5538
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5539
+ end
5540
+ return data, status_code, headers
5541
+ end
5542
+
5543
+ # List transfer events
5544
+ # Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
5545
+ # @param transfer_event_list_request [TransferEventListRequest]
5546
+ # @param [Hash] opts the optional parameters
5547
+ # @return [TransferEventListResponse]
5548
+ def transfer_event_list(transfer_event_list_request, opts = {})
5549
+ data, _status_code, _headers = transfer_event_list_with_http_info(transfer_event_list_request, opts)
5550
+ data
5551
+ end
5552
+
5553
+ # List transfer events
5554
+ # Use the &#x60;/transfer/event/list&#x60; endpoint to get a list of transfer events based on specified filter criteria.
5555
+ # @param transfer_event_list_request [TransferEventListRequest]
5556
+ # @param [Hash] opts the optional parameters
5557
+ # @return [Array<(TransferEventListResponse, Integer, Hash)>] TransferEventListResponse data, response status code and response headers
5558
+ def transfer_event_list_with_http_info(transfer_event_list_request, opts = {})
5559
+ if @api_client.config.debugging
5560
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_list ...'
5561
+ end
5562
+ # verify the required parameter 'transfer_event_list_request' is set
5563
+ if @api_client.config.client_side_validation && transfer_event_list_request.nil?
5564
+ fail ArgumentError, "Missing the required parameter 'transfer_event_list_request' when calling PlaidApi.transfer_event_list"
5565
+ end
5566
+ # resource path
5567
+ local_var_path = '/transfer/event/list'
5568
+
5569
+ # query parameters
5570
+ query_params = opts[:query_params] || {}
5571
+
5572
+ # header parameters
5573
+ header_params = opts[:header_params] || {}
5574
+ # HTTP header 'Accept' (if needed)
5575
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5576
+ # HTTP header 'Content-Type'
5577
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5578
+
5579
+ # form parameters
5580
+ form_params = opts[:form_params] || {}
5581
+
5582
+ # http body (model)
5583
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_list_request)
5584
+
5585
+ # return_type
5586
+ return_type = opts[:debug_return_type] || 'TransferEventListResponse'
5587
+
5588
+ # auth_names
5589
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5590
+
5591
+ new_options = opts.merge(
5592
+ :operation => :"PlaidApi.transfer_event_list",
5593
+ :header_params => header_params,
5594
+ :query_params => query_params,
5595
+ :form_params => form_params,
5596
+ :body => post_body,
5597
+ :auth_names => auth_names,
5598
+ :return_type => return_type
5599
+ )
5600
+
5601
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5602
+ if @api_client.config.debugging
5603
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5604
+ end
5605
+ return data, status_code, headers
5606
+ end
5607
+
5608
+ # Sync transfer events
5609
+ # `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
5610
+ # @param transfer_event_sync_request [TransferEventSyncRequest]
5611
+ # @param [Hash] opts the optional parameters
5612
+ # @return [TransferEventSyncResponse]
5613
+ def transfer_event_sync(transfer_event_sync_request, opts = {})
5614
+ data, _status_code, _headers = transfer_event_sync_with_http_info(transfer_event_sync_request, opts)
5615
+ data
5616
+ end
5617
+
5618
+ # Sync transfer events
5619
+ # &#x60;/transfer/event/sync&#x60; allows you to request up to the next 25 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events.
5620
+ # @param transfer_event_sync_request [TransferEventSyncRequest]
5621
+ # @param [Hash] opts the optional parameters
5622
+ # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers
5623
+ def transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {})
5624
+ if @api_client.config.debugging
5625
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_sync ...'
5626
+ end
5627
+ # verify the required parameter 'transfer_event_sync_request' is set
5628
+ if @api_client.config.client_side_validation && transfer_event_sync_request.nil?
5629
+ fail ArgumentError, "Missing the required parameter 'transfer_event_sync_request' when calling PlaidApi.transfer_event_sync"
5630
+ end
5631
+ # resource path
5632
+ local_var_path = '/transfer/event/sync'
5633
+
5634
+ # query parameters
5635
+ query_params = opts[:query_params] || {}
5636
+
5637
+ # header parameters
5638
+ header_params = opts[:header_params] || {}
5639
+ # HTTP header 'Accept' (if needed)
5640
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5641
+ # HTTP header 'Content-Type'
5642
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5643
+
5644
+ # form parameters
5645
+ form_params = opts[:form_params] || {}
5646
+
5647
+ # http body (model)
5648
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_sync_request)
5649
+
5650
+ # return_type
5651
+ return_type = opts[:debug_return_type] || 'TransferEventSyncResponse'
5652
+
5653
+ # auth_names
5654
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5655
+
5656
+ new_options = opts.merge(
5657
+ :operation => :"PlaidApi.transfer_event_sync",
5658
+ :header_params => header_params,
5659
+ :query_params => query_params,
5660
+ :form_params => form_params,
5661
+ :body => post_body,
5662
+ :auth_names => auth_names,
5663
+ :return_type => return_type
5664
+ )
5665
+
5666
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5667
+ if @api_client.config.debugging
5668
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5669
+ end
5670
+ return data, status_code, headers
5671
+ end
5672
+
5673
+ # Retrieve a transfer
5674
+ # The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
5675
+ # @param transfer_get_request [TransferGetRequest]
5676
+ # @param [Hash] opts the optional parameters
5677
+ # @return [TransferGetResponse]
5678
+ def transfer_get(transfer_get_request, opts = {})
5679
+ data, _status_code, _headers = transfer_get_with_http_info(transfer_get_request, opts)
5680
+ data
5681
+ end
5682
+
5683
+ # Retrieve a transfer
5684
+ # The &#x60;/transfer/get&#x60; fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
5685
+ # @param transfer_get_request [TransferGetRequest]
5686
+ # @param [Hash] opts the optional parameters
5687
+ # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
5688
+ def transfer_get_with_http_info(transfer_get_request, opts = {})
5689
+ if @api_client.config.debugging
5690
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_get ...'
5691
+ end
5692
+ # verify the required parameter 'transfer_get_request' is set
5693
+ if @api_client.config.client_side_validation && transfer_get_request.nil?
5694
+ fail ArgumentError, "Missing the required parameter 'transfer_get_request' when calling PlaidApi.transfer_get"
5695
+ end
5696
+ # resource path
5697
+ local_var_path = '/transfer/get'
5698
+
5699
+ # query parameters
5700
+ query_params = opts[:query_params] || {}
5701
+
5702
+ # header parameters
5703
+ header_params = opts[:header_params] || {}
5704
+ # HTTP header 'Accept' (if needed)
5705
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5706
+ # HTTP header 'Content-Type'
5707
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5708
+
5709
+ # form parameters
5710
+ form_params = opts[:form_params] || {}
5711
+
5712
+ # http body (model)
5713
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_get_request)
5714
+
5715
+ # return_type
5716
+ return_type = opts[:debug_return_type] || 'TransferGetResponse'
5717
+
5718
+ # auth_names
5719
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5720
+
5721
+ new_options = opts.merge(
5722
+ :operation => :"PlaidApi.transfer_get",
5723
+ :header_params => header_params,
5724
+ :query_params => query_params,
5725
+ :form_params => form_params,
5726
+ :body => post_body,
5727
+ :auth_names => auth_names,
5728
+ :return_type => return_type
5729
+ )
5730
+
5731
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5732
+ if @api_client.config.debugging
5733
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5734
+ end
5735
+ return data, status_code, headers
5736
+ end
5737
+
5738
+ # List transfers
5739
+ # Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
5740
+ # @param transfer_list_request [TransferListRequest]
5741
+ # @param [Hash] opts the optional parameters
5742
+ # @return [TransferListResponse]
5743
+ def transfer_list(transfer_list_request, opts = {})
5744
+ data, _status_code, _headers = transfer_list_with_http_info(transfer_list_request, opts)
5745
+ data
5746
+ end
5747
+
5748
+ # List transfers
5749
+ # Use the &#x60;/transfer/list&#x60; endpoint to see a list of all your transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired transfers.
5750
+ # @param transfer_list_request [TransferListRequest]
5751
+ # @param [Hash] opts the optional parameters
5752
+ # @return [Array<(TransferListResponse, Integer, Hash)>] TransferListResponse data, response status code and response headers
5753
+ def transfer_list_with_http_info(transfer_list_request, opts = {})
5754
+ if @api_client.config.debugging
5755
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_list ...'
5756
+ end
5757
+ # verify the required parameter 'transfer_list_request' is set
5758
+ if @api_client.config.client_side_validation && transfer_list_request.nil?
5759
+ fail ArgumentError, "Missing the required parameter 'transfer_list_request' when calling PlaidApi.transfer_list"
5760
+ end
5761
+ # resource path
5762
+ local_var_path = '/transfer/list'
5763
+
5764
+ # query parameters
5765
+ query_params = opts[:query_params] || {}
5766
+
5767
+ # header parameters
5768
+ header_params = opts[:header_params] || {}
5769
+ # HTTP header 'Accept' (if needed)
5770
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5771
+ # HTTP header 'Content-Type'
5772
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5773
+
5774
+ # form parameters
5775
+ form_params = opts[:form_params] || {}
5776
+
5777
+ # http body (model)
5778
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_list_request)
5779
+
5780
+ # return_type
5781
+ return_type = opts[:debug_return_type] || 'TransferListResponse'
5782
+
5783
+ # auth_names
5784
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5785
+
5786
+ new_options = opts.merge(
5787
+ :operation => :"PlaidApi.transfer_list",
5788
+ :header_params => header_params,
5789
+ :query_params => query_params,
5790
+ :form_params => form_params,
5791
+ :body => post_body,
5792
+ :auth_names => auth_names,
5793
+ :return_type => return_type
5794
+ )
5795
+
5796
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5797
+ if @api_client.config.debugging
5798
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5799
+ end
5800
+ return data, status_code, headers
5801
+ end
5802
+
5090
5803
  # Get webhook verification key
5091
5804
  # Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
5092
5805
  # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]