plaid 14.1.0 → 14.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (532) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +17 -2
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/PUBLISH.md +4 -3
  6. data/README.md +5 -5
  7. data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +118 -0
  8. data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +118 -0
  9. data/doc/rdoc/classes/Plaid/AddToken.html +197 -0
  10. data/doc/rdoc/classes/Plaid/Models/Payment.html +0 -17
  11. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +0 -17
  12. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +20 -23
  13. data/doc/rdoc/classes/Plaid.html +1 -1
  14. data/doc/rdoc/created.rid +28 -28
  15. data/doc/rdoc/files/LICENSE_txt.html +1 -1
  16. data/doc/rdoc/files/README_md.html +1 -1
  17. data/doc/rdoc/files/lib/plaid/client_rb.html +1 -1
  18. data/doc/rdoc/files/lib/plaid/errors_rb.html +1 -1
  19. data/doc/rdoc/files/lib/plaid/middleware_rb.html +1 -1
  20. data/doc/rdoc/files/lib/plaid/models_rb.html +1 -1
  21. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +1 -1
  22. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +1 -1
  23. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +1 -1
  24. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +1 -1
  25. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +1 -1
  26. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +1 -1
  27. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +1 -1
  28. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +1 -1
  29. data/doc/rdoc/files/lib/plaid/products/income_rb.html +1 -1
  30. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +1 -1
  31. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +1 -1
  32. data/doc/rdoc/files/lib/plaid/products/item_rb.html +1 -1
  33. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +1 -1
  34. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +1 -1
  35. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +1 -1
  36. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +1 -1
  37. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +1 -1
  38. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +1 -1
  39. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +1 -1
  40. data/doc/rdoc/files/lib/plaid/version_rb.html +1 -1
  41. data/doc/rdoc/files/lib/plaid_rb.html +1 -1
  42. data/doc/rdoc/js/navigation.js.gz +0 -0
  43. data/doc/rdoc/js/search_index.js +1 -1
  44. data/doc/rdoc/js/search_index.js.gz +0 -0
  45. data/doc/rdoc/js/searcher.js.gz +0 -0
  46. data/lib/plaid/api/plaid_api.rb +353 -28
  47. data/lib/plaid/api_client.rb +4 -4
  48. data/lib/plaid/api_error.rb +3 -3
  49. data/lib/plaid/configuration.rb +5 -4
  50. data/lib/plaid/models/account_access.rb +1 -1
  51. data/lib/plaid/models/account_assets.rb +1 -1
  52. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  53. data/lib/plaid/models/account_balance.rb +3 -3
  54. data/lib/plaid/models/account_base.rb +1 -1
  55. data/lib/plaid/models/account_filter.rb +1 -1
  56. data/lib/plaid/models/account_filters_response.rb +1 -1
  57. data/lib/plaid/models/account_identity.rb +1 -1
  58. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  59. data/lib/plaid/models/account_selection_cardinality.rb +5 -3
  60. data/lib/plaid/models/account_subtype.rb +6 -3
  61. data/lib/plaid/models/account_type.rb +5 -3
  62. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  63. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  64. data/lib/plaid/models/accounts_get_request.rb +1 -1
  65. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  66. data/lib/plaid/models/accounts_get_response.rb +1 -1
  67. data/lib/plaid/models/ach_class.rb +5 -3
  68. data/lib/plaid/models/address.rb +1 -1
  69. data/lib/plaid/models/address_data.rb +1 -1
  70. data/lib/plaid/models/address_data_nullable.rb +1 -1
  71. data/lib/plaid/models/address_nullable.rb +1 -1
  72. data/lib/plaid/models/application.rb +1 -1
  73. data/lib/plaid/models/application_get_request.rb +1 -1
  74. data/lib/plaid/models/application_get_response.rb +1 -1
  75. data/lib/plaid/models/apr.rb +1 -1
  76. data/lib/plaid/models/asset_report.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  79. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  80. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  82. data/lib/plaid/models/asset_report_create_request.rb +6 -6
  83. data/lib/plaid/models/asset_report_create_request_options.rb +3 -1
  84. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  85. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  86. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  87. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_item.rb +1 -1
  90. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  91. data/lib/plaid/models/asset_report_refresh_request.rb +7 -6
  92. data/lib/plaid/models/asset_report_refresh_request_options.rb +3 -1
  93. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  94. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  95. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  96. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  97. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  98. data/lib/plaid/models/asset_report_user.rb +1 -1
  99. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  100. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  101. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  102. data/lib/plaid/models/auth_get_request.rb +1 -1
  103. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  104. data/lib/plaid/models/auth_get_response.rb +1 -1
  105. data/lib/plaid/models/{income_verification_documents_download_response.rb → auth_metadata.rb} +13 -17
  106. data/lib/plaid/models/auth_supported_methods.rb +255 -0
  107. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  108. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  109. data/lib/plaid/models/bank_transfer.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_direction.rb +5 -3
  118. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_type.rb +5 -3
  124. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_network.rb +5 -3
  132. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_status.rb +5 -3
  134. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep_account.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
  137. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +330 -0
  139. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
  140. data/lib/plaid/models/bank_transfer_type.rb +5 -3
  141. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  142. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  143. data/lib/plaid/models/categories_get_response.rb +1 -1
  144. data/lib/plaid/models/category.rb +1 -1
  145. data/lib/plaid/models/cause.rb +1 -1
  146. data/lib/plaid/models/connected_application.rb +1 -1
  147. data/lib/plaid/models/country_code.rb +5 -3
  148. data/lib/plaid/models/credit_card_liability.rb +17 -2
  149. data/lib/plaid/models/credit_filter.rb +1 -1
  150. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  151. data/lib/plaid/models/deductions.rb +1 -1
  152. data/lib/plaid/models/default_update_webhook.rb +1 -1
  153. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  154. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  155. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  156. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  157. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  158. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  159. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  160. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  161. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  162. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  163. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  164. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  165. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  166. data/lib/plaid/models/depository_filter.rb +1 -1
  167. data/lib/plaid/models/distribution_details.rb +1 -1
  168. data/lib/plaid/models/document_metadata.rb +49 -5
  169. data/lib/plaid/models/earnings.rb +1 -1
  170. data/lib/plaid/models/earnings_total.rb +3 -3
  171. data/lib/plaid/models/email.rb +1 -1
  172. data/lib/plaid/models/employee.rb +1 -1
  173. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  174. data/lib/plaid/models/employer.rb +1 -1
  175. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  176. data/lib/plaid/models/employer_verification.rb +221 -0
  177. data/lib/plaid/models/employers_search_request.rb +1 -1
  178. data/lib/plaid/models/employers_search_response.rb +1 -1
  179. data/lib/plaid/models/employment_details.rb +1 -1
  180. data/lib/plaid/models/employment_verification.rb +306 -0
  181. data/lib/plaid/models/employment_verification_get_request.rb +245 -0
  182. data/lib/plaid/models/employment_verification_get_response.rb +252 -0
  183. data/lib/plaid/models/error.rb +1 -1
  184. data/lib/plaid/models/external_payment_options.rb +1 -1
  185. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  186. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  187. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  188. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  189. data/lib/plaid/models/health_incident.rb +1 -1
  190. data/lib/plaid/models/historical_balance.rb +1 -1
  191. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  192. data/lib/plaid/models/holding.rb +1 -1
  193. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  194. data/lib/plaid/models/holdings_override.rb +1 -1
  195. data/lib/plaid/models/identity_get_request.rb +1 -1
  196. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  197. data/lib/plaid/models/identity_get_response.rb +1 -1
  198. data/lib/plaid/models/incident_update.rb +1 -1
  199. data/lib/plaid/models/income_breakdown.rb +2 -2
  200. data/lib/plaid/models/income_override.rb +222 -0
  201. data/lib/plaid/models/income_summary.rb +1 -1
  202. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  203. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  204. data/lib/plaid/models/income_verification_create_request.rb +15 -5
  205. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  206. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -6
  207. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  208. data/lib/plaid/models/income_verification_paystub_get_response.rb +249 -0
  209. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  210. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  211. data/lib/plaid/models/income_verification_precheck_employer.rb +252 -0
  212. data/lib/plaid/models/income_verification_precheck_employer_address.rb +280 -0
  213. data/lib/plaid/models/{transfer_receiver_details.rb → income_verification_precheck_military_info.rb} +32 -22
  214. data/lib/plaid/models/income_verification_precheck_request.rb +271 -0
  215. data/lib/plaid/models/income_verification_precheck_response.rb +289 -0
  216. data/lib/plaid/models/income_verification_precheck_user.rb +252 -0
  217. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  218. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  219. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  220. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  221. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  222. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  223. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  224. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  225. data/lib/plaid/models/inflow_model.rb +1 -1
  226. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  227. data/lib/plaid/models/institution.rb +16 -6
  228. data/lib/plaid/models/institution_status.rb +1 -1
  229. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  230. data/lib/plaid/models/institutions_get_by_id_request_options.rb +14 -2
  231. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  232. data/lib/plaid/models/institutions_get_request.rb +1 -1
  233. data/lib/plaid/models/institutions_get_request_options.rb +14 -2
  234. data/lib/plaid/models/institutions_get_response.rb +1 -1
  235. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  236. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  237. data/lib/plaid/models/institutions_search_request.rb +1 -1
  238. data/lib/plaid/models/institutions_search_request_options.rb +14 -2
  239. data/lib/plaid/models/institutions_search_response.rb +1 -1
  240. data/lib/plaid/models/investment_filter.rb +1 -1
  241. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  242. data/lib/plaid/models/investment_transaction.rb +1 -1
  243. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  244. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  245. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  246. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  247. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  248. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  249. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  250. data/lib/plaid/models/item.rb +1 -1
  251. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  252. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  253. data/lib/plaid/models/item_application_list_request.rb +1 -1
  254. data/lib/plaid/models/item_application_list_response.rb +1 -1
  255. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  256. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  257. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  258. data/lib/plaid/models/item_error_webhook.rb +1 -1
  259. data/lib/plaid/models/item_get_request.rb +1 -1
  260. data/lib/plaid/models/item_get_response.rb +1 -1
  261. data/lib/plaid/models/item_import_request.rb +1 -1
  262. data/lib/plaid/models/item_import_request_options.rb +1 -1
  263. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  264. data/lib/plaid/models/item_import_response.rb +1 -1
  265. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  266. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  267. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  268. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  269. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  270. data/lib/plaid/models/item_remove_request.rb +1 -1
  271. data/lib/plaid/models/item_remove_response.rb +1 -1
  272. data/lib/plaid/models/item_status.rb +1 -1
  273. data/lib/plaid/models/item_status_investments.rb +1 -1
  274. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  275. data/lib/plaid/models/item_status_nullable.rb +1 -1
  276. data/lib/plaid/models/item_status_transactions.rb +1 -1
  277. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  278. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  279. data/lib/plaid/models/jwk_public_key.rb +1 -1
  280. data/lib/plaid/models/jwt_header.rb +1 -1
  281. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  282. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  283. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  284. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  285. data/lib/plaid/models/liabilities_object.rb +1 -1
  286. data/lib/plaid/models/liability_override.rb +1 -1
  287. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  288. data/lib/plaid/models/link_token_create_request.rb +15 -6
  289. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  290. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  291. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  292. data/lib/plaid/models/link_token_create_request_income_verification.rb +15 -10
  293. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  294. data/lib/plaid/models/link_token_create_request_update.rb +222 -0
  295. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  296. data/lib/plaid/models/link_token_create_response.rb +1 -1
  297. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  298. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  299. data/lib/plaid/models/link_token_get_request.rb +1 -1
  300. data/lib/plaid/models/link_token_get_response.rb +1 -1
  301. data/lib/plaid/models/loan_filter.rb +1 -1
  302. data/lib/plaid/models/location.rb +1 -1
  303. data/lib/plaid/models/meta.rb +1 -1
  304. data/lib/plaid/models/mfa.rb +1 -1
  305. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  306. data/lib/plaid/models/mortgage_liability.rb +1 -1
  307. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  308. data/lib/plaid/models/net_pay.rb +1 -1
  309. data/lib/plaid/models/new_accounts_available_webhook.rb +250 -0
  310. data/lib/plaid/models/numbers.rb +1 -1
  311. data/lib/plaid/models/numbers_ach.rb +1 -1
  312. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  313. data/lib/plaid/models/numbers_bacs.rb +1 -1
  314. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  315. data/lib/plaid/models/numbers_eft.rb +1 -1
  316. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  317. data/lib/plaid/models/numbers_international.rb +1 -1
  318. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  319. data/lib/plaid/models/override_account_type.rb +6 -3
  320. data/lib/plaid/models/override_accounts.rb +14 -5
  321. data/lib/plaid/models/owner.rb +1 -1
  322. data/lib/plaid/models/owner_override.rb +1 -1
  323. data/lib/plaid/models/pay.rb +1 -1
  324. data/lib/plaid/models/pay_frequency.rb +1 -1
  325. data/lib/plaid/models/pay_period_details.rb +1 -1
  326. data/lib/plaid/models/payment_amount.rb +1 -1
  327. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  328. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  329. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  330. data/lib/plaid/models/payment_initiation_payment.rb +14 -2
  331. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  332. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  333. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  334. data/lib/plaid/models/payment_initiation_payment_get_response.rb +14 -2
  335. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  336. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  337. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
  338. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +289 -0
  339. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  340. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  341. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  342. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  343. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  344. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  345. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  346. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  347. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  348. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  349. data/lib/plaid/models/payment_initiation_refund.rb +303 -0
  350. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  351. data/lib/plaid/models/payment_meta.rb +1 -1
  352. data/lib/plaid/models/payment_schedule_interval.rb +5 -3
  353. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  354. data/lib/plaid/models/paystub.rb +1 -1
  355. data/lib/plaid/models/paystub_address.rb +1 -1
  356. data/lib/plaid/models/paystub_deduction.rb +1 -1
  357. data/lib/plaid/models/paystub_details.rb +1 -1
  358. data/lib/plaid/models/paystub_employer.rb +1 -1
  359. data/lib/plaid/models/paystub_override.rb +248 -0
  360. data/lib/plaid/models/paystub_override_employee.rb +229 -0
  361. data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
  362. data/lib/plaid/models/paystub_override_employer.rb +220 -0
  363. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  364. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  365. data/lib/plaid/models/personal_finance_category.rb +240 -0
  366. data/lib/plaid/models/phone_number.rb +1 -1
  367. data/lib/plaid/models/platform_ids.rb +243 -0
  368. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  369. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  370. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  371. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  372. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  373. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  374. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  375. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  376. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  377. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  378. data/lib/plaid/models/processor_number.rb +1 -1
  379. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  380. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  381. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  382. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  383. data/lib/plaid/models/product_access.rb +1 -1
  384. data/lib/plaid/models/product_status.rb +1 -1
  385. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  386. data/lib/plaid/models/products.rb +6 -3
  387. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  388. data/lib/plaid/models/pslf_status.rb +1 -1
  389. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  390. data/lib/plaid/models/recipient_bacs.rb +1 -1
  391. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  392. data/lib/plaid/models/{transfer_direction.rb → recurring_transaction_frequency.rb} +11 -7
  393. data/lib/plaid/models/requested_scopes.rb +1 -1
  394. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  395. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  396. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  397. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  398. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  399. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  400. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  401. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  402. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  403. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  404. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  405. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  406. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  407. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  408. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  409. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  410. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  411. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  412. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  413. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  414. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  415. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  416. data/lib/plaid/models/scopes.rb +1 -1
  417. data/lib/plaid/models/scopes_context.rb +5 -3
  418. data/lib/plaid/models/scopes_nullable.rb +1 -1
  419. data/lib/plaid/models/security.rb +1 -1
  420. data/lib/plaid/models/security_override.rb +1 -1
  421. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  422. data/lib/plaid/models/servicer_address_data.rb +1 -1
  423. data/lib/plaid/models/signal_address_data.rb +1 -1
  424. data/lib/plaid/models/signal_decision_report_request.rb +2 -1
  425. data/lib/plaid/models/signal_decision_report_response.rb +2 -1
  426. data/lib/plaid/models/signal_device.rb +1 -1
  427. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  428. data/lib/plaid/models/signal_evaluate_request.rb +2 -1
  429. data/lib/plaid/models/signal_evaluate_response.rb +2 -6
  430. data/lib/plaid/models/signal_person_name.rb +1 -1
  431. data/lib/plaid/models/signal_return_report_request.rb +2 -1
  432. data/lib/plaid/models/signal_return_report_response.rb +2 -1
  433. data/lib/plaid/models/signal_scores.rb +2 -1
  434. data/lib/plaid/models/signal_user.rb +1 -1
  435. data/lib/plaid/models/standalone_account_type.rb +1 -1
  436. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  437. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  438. data/lib/plaid/models/student_loan.rb +1 -1
  439. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  440. data/lib/plaid/models/student_loan_status.rb +1 -1
  441. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  442. data/lib/plaid/models/taxform.rb +1 -1
  443. data/lib/plaid/models/taxpayer_id.rb +1 -1
  444. data/lib/plaid/models/total.rb +3 -3
  445. data/lib/plaid/models/transaction.rb +16 -6
  446. data/lib/plaid/models/transaction_all_of.rb +16 -6
  447. data/lib/plaid/models/transaction_base.rb +1 -1
  448. data/lib/plaid/models/transaction_code.rb +5 -3
  449. data/lib/plaid/models/transaction_data.rb +1 -1
  450. data/lib/plaid/models/transaction_override.rb +1 -1
  451. data/lib/plaid/models/transaction_stream.rb +377 -0
  452. data/lib/plaid/models/transaction_stream_amount.rb +242 -0
  453. data/lib/plaid/models/transactions_get_request.rb +1 -1
  454. data/lib/plaid/models/transactions_get_request_options.rb +18 -6
  455. data/lib/plaid/models/transactions_get_response.rb +1 -1
  456. data/lib/plaid/models/transactions_recurring_get_request.rb +252 -0
  457. data/lib/plaid/models/transactions_recurring_get_response.rb +254 -0
  458. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  459. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  460. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  461. data/lib/plaid/models/transfer.rb +5 -41
  462. data/lib/plaid/models/transfer_authorization.rb +1 -1
  463. data/lib/plaid/models/transfer_authorization_create_request.rb +2 -53
  464. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  465. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  466. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  467. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -32
  468. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  469. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  470. data/lib/plaid/models/transfer_create_request.rb +7 -45
  471. data/lib/plaid/models/transfer_create_response.rb +1 -1
  472. data/lib/plaid/models/transfer_event.rb +6 -41
  473. data/lib/plaid/models/transfer_event_list_request.rb +6 -29
  474. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  475. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  476. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  477. data/lib/plaid/models/transfer_event_type.rb +5 -5
  478. data/lib/plaid/models/transfer_failure.rb +1 -1
  479. data/lib/plaid/models/transfer_get_request.rb +1 -1
  480. data/lib/plaid/models/transfer_get_response.rb +1 -1
  481. data/lib/plaid/models/transfer_list_request.rb +6 -16
  482. data/lib/plaid/models/transfer_list_response.rb +1 -1
  483. data/lib/plaid/models/transfer_network.rb +5 -3
  484. data/lib/plaid/models/transfer_status.rb +5 -3
  485. data/lib/plaid/models/transfer_type.rb +5 -3
  486. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  487. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  488. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  489. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  490. data/lib/plaid/models/user_custom_password.rb +1 -1
  491. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  492. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  493. data/lib/plaid/models/verification_refresh_status.rb +5 -3
  494. data/lib/plaid/models/verification_status.rb +5 -3
  495. data/lib/plaid/models/w2.rb +1 -1
  496. data/lib/plaid/models/w2_box12.rb +1 -1
  497. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  498. data/lib/plaid/models/warning.rb +1 -1
  499. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  500. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  501. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  502. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  503. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  504. data/lib/plaid/version.rb +2 -2
  505. data/lib/plaid.rb +33 -4
  506. data/pkg/plaid-10.0.0.gem +0 -0
  507. data/pkg/plaid-11.0.0.gem +0 -0
  508. data/pkg/plaid-12.0.0.gem +0 -0
  509. data/pkg/plaid-13.1.0.gem +0 -0
  510. data/pkg/plaid-14.3.0.gem +0 -0
  511. data/pkg/plaid-14.4.0.gem +0 -0
  512. data/pkg/plaid-8.5.0.gem +0 -0
  513. data/pkg/plaid-8.6.0.gem +0 -0
  514. data/pkg/plaid-8.7.0.gem +0 -0
  515. data/pkg/plaid-8.8.0.gem +0 -0
  516. data/pkg/plaid-9.0.0.gem +0 -0
  517. data/plaid.gemspec +1 -1
  518. data/templates/ruby/api_client.mustache +1 -2
  519. data/templates/ruby/api_client_faraday_partial.mustache +2 -1
  520. data/templates/ruby/api_error.mustache +49 -0
  521. data/templates/ruby/configuration.mustache +5 -3
  522. data/templates/ruby/partial_model_enum_class.mustache +22 -0
  523. data/test/test_accounts.rb +4 -8
  524. data/test/test_item.rb +0 -1
  525. metadata +61 -22
  526. data/doc/rdoc/.DS_Store +0 -0
  527. data/lib/plaid/.DS_Store +0 -0
  528. data/pkg/plaid-13.2.0.gem +0 -0
  529. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  530. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  531. data/pkg/plaid-14.0.0.gem +0 -0
  532. data/pkg/plaid-14.1.0.gem +0 -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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -1449,6 +1449,71 @@ module Plaid
1449
1449
  return data, status_code, headers
1450
1450
  end
1451
1451
 
1452
+ # List sweeps
1453
+ # The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
1454
+ # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
1455
+ # @param [Hash] opts the optional parameters
1456
+ # @return [BankTransferSweepListResponse]
1457
+ def bank_transfer_sweep_list(bank_transfer_sweep_list_request, opts = {})
1458
+ data, _status_code, _headers = bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts)
1459
+ data
1460
+ end
1461
+
1462
+ # List sweeps
1463
+ # The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
1464
+ # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
1465
+ # @param [Hash] opts the optional parameters
1466
+ # @return [Array<(BankTransferSweepListResponse, Integer, Hash)>] BankTransferSweepListResponse data, response status code and response headers
1467
+ def bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts = {})
1468
+ if @api_client.config.debugging
1469
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_list ...'
1470
+ end
1471
+ # verify the required parameter 'bank_transfer_sweep_list_request' is set
1472
+ if @api_client.config.client_side_validation && bank_transfer_sweep_list_request.nil?
1473
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_list_request' when calling PlaidApi.bank_transfer_sweep_list"
1474
+ end
1475
+ # resource path
1476
+ local_var_path = '/bank_transfer/sweep/list'
1477
+
1478
+ # query parameters
1479
+ query_params = opts[:query_params] || {}
1480
+
1481
+ # header parameters
1482
+ header_params = opts[:header_params] || {}
1483
+ # HTTP header 'Accept' (if needed)
1484
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1485
+ # HTTP header 'Content-Type'
1486
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1487
+
1488
+ # form parameters
1489
+ form_params = opts[:form_params] || {}
1490
+
1491
+ # http body (model)
1492
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_list_request)
1493
+
1494
+ # return_type
1495
+ return_type = opts[:debug_return_type] || 'BankTransferSweepListResponse'
1496
+
1497
+ # auth_names
1498
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1499
+
1500
+ new_options = opts.merge(
1501
+ :operation => :"PlaidApi.bank_transfer_sweep_list",
1502
+ :header_params => header_params,
1503
+ :query_params => query_params,
1504
+ :form_params => form_params,
1505
+ :body => post_body,
1506
+ :auth_names => auth_names,
1507
+ :return_type => return_type
1508
+ )
1509
+
1510
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1511
+ if @api_client.config.debugging
1512
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1513
+ end
1514
+ return data, status_code, headers
1515
+ end
1516
+
1452
1517
  # Get Categories
1453
1518
  # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1454
1519
  # @param body [Object]
@@ -1904,6 +1969,71 @@ module Plaid
1904
1969
  return data, status_code, headers
1905
1970
  end
1906
1971
 
1972
+ # Retrieve a summary of an individual's employment information.
1973
+ # `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
1974
+ # @param employment_verification_get_request [EmploymentVerificationGetRequest]
1975
+ # @param [Hash] opts the optional parameters
1976
+ # @return [EmploymentVerificationGetResponse]
1977
+ def employment_verification_get(employment_verification_get_request, opts = {})
1978
+ data, _status_code, _headers = employment_verification_get_with_http_info(employment_verification_get_request, opts)
1979
+ data
1980
+ end
1981
+
1982
+ # Retrieve a summary of an individual&#39;s employment information.
1983
+ # &#x60;/employment/verification/get&#x60; returns a list of employments through a user payroll that was verified by an end user.
1984
+ # @param employment_verification_get_request [EmploymentVerificationGetRequest]
1985
+ # @param [Hash] opts the optional parameters
1986
+ # @return [Array<(EmploymentVerificationGetResponse, Integer, Hash)>] EmploymentVerificationGetResponse data, response status code and response headers
1987
+ def employment_verification_get_with_http_info(employment_verification_get_request, opts = {})
1988
+ if @api_client.config.debugging
1989
+ @api_client.config.logger.debug 'Calling API: PlaidApi.employment_verification_get ...'
1990
+ end
1991
+ # verify the required parameter 'employment_verification_get_request' is set
1992
+ if @api_client.config.client_side_validation && employment_verification_get_request.nil?
1993
+ fail ArgumentError, "Missing the required parameter 'employment_verification_get_request' when calling PlaidApi.employment_verification_get"
1994
+ end
1995
+ # resource path
1996
+ local_var_path = '/employment/verification/get'
1997
+
1998
+ # query parameters
1999
+ query_params = opts[:query_params] || {}
2000
+
2001
+ # header parameters
2002
+ header_params = opts[:header_params] || {}
2003
+ # HTTP header 'Accept' (if needed)
2004
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2005
+ # HTTP header 'Content-Type'
2006
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2007
+
2008
+ # form parameters
2009
+ form_params = opts[:form_params] || {}
2010
+
2011
+ # http body (model)
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employment_verification_get_request)
2013
+
2014
+ # return_type
2015
+ return_type = opts[:debug_return_type] || 'EmploymentVerificationGetResponse'
2016
+
2017
+ # auth_names
2018
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2019
+
2020
+ new_options = opts.merge(
2021
+ :operation => :"PlaidApi.employment_verification_get",
2022
+ :header_params => header_params,
2023
+ :query_params => query_params,
2024
+ :form_params => form_params,
2025
+ :body => post_body,
2026
+ :auth_names => auth_names,
2027
+ :return_type => return_type
2028
+ )
2029
+
2030
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2031
+ if @api_client.config.debugging
2032
+ @api_client.config.logger.debug "API called: PlaidApi#employment_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2033
+ end
2034
+ return data, status_code, headers
2035
+ end
2036
+
1907
2037
  # Retrieve identity data
1908
2038
  # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
1909
2039
  # @param identity_get_request [IdentityGetRequest]
@@ -2035,7 +2165,7 @@ module Plaid
2035
2165
  end
2036
2166
 
2037
2167
  # Download the original documents used for income verification
2038
- # `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header. For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.
2168
+ # `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
2039
2169
  # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
2040
2170
  # @param [Hash] opts the optional parameters
2041
2171
  # @return [File]
@@ -2045,7 +2175,7 @@ module Plaid
2045
2175
  end
2046
2176
 
2047
2177
  # Download the original documents used for income verification
2048
- # &#x60;/income/verification/documents/download&#x60; provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to &#x60;/income/verification/documents/download&#x60; is a ZIP file in binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.
2178
+ # &#x60;/income/verification/documents/download&#x60; provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to &#x60;/income/verification/documents/download&#x60; is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2049
2179
  # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
2050
2180
  # @param [Hash] opts the optional parameters
2051
2181
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -2102,16 +2232,16 @@ module Plaid
2102
2232
  # (Deprecated) Retrieve information from a single paystub used for income verification
2103
2233
  # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2104
2234
  # @param [Hash] opts the optional parameters
2105
- # @return [nil]
2235
+ # @return [IncomeVerificationPaystubGetResponse]
2106
2236
  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
2237
+ data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
2238
+ data
2109
2239
  end
2110
2240
 
2111
2241
  # (Deprecated) Retrieve information from a single paystub used for income verification
2112
2242
  # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2113
2243
  # @param [Hash] opts the optional parameters
2114
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2244
+ # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
2115
2245
  def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
2116
2246
  if @api_client.config.debugging
2117
2247
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
@@ -2140,7 +2270,7 @@ module Plaid
2140
2270
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
2141
2271
 
2142
2272
  # return_type
2143
- return_type = opts[:debug_return_type]
2273
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
2144
2274
 
2145
2275
  # auth_names
2146
2276
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -2227,6 +2357,71 @@ module Plaid
2227
2357
  return data, status_code, headers
2228
2358
  end
2229
2359
 
2360
+ # Check a user's eligibility for the income verification product
2361
+ # `/income/verification/precheck` returns whether a given user is supportable by the income product
2362
+ # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
2363
+ # @param [Hash] opts the optional parameters
2364
+ # @return [IncomeVerificationPrecheckResponse]
2365
+ def income_verification_precheck(income_verification_precheck_request, opts = {})
2366
+ data, _status_code, _headers = income_verification_precheck_with_http_info(income_verification_precheck_request, opts)
2367
+ data
2368
+ end
2369
+
2370
+ # Check a user&#39;s eligibility for the income verification product
2371
+ # &#x60;/income/verification/precheck&#x60; returns whether a given user is supportable by the income product
2372
+ # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
2373
+ # @param [Hash] opts the optional parameters
2374
+ # @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
2375
+ def income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {})
2376
+ if @api_client.config.debugging
2377
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_precheck ...'
2378
+ end
2379
+ # verify the required parameter 'income_verification_precheck_request' is set
2380
+ if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
2381
+ fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
2382
+ end
2383
+ # resource path
2384
+ local_var_path = '/income/verification/precheck'
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(income_verification_precheck_request)
2401
+
2402
+ # return_type
2403
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'
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_precheck",
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_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2421
+ end
2422
+ return data, status_code, headers
2423
+ end
2424
+
2230
2425
  # Refresh an income verification
2231
2426
  # `/income/verification/refresh` refreshes a given income verification.
2232
2427
  # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
@@ -3722,6 +3917,71 @@ module Plaid
3722
3917
  return data, status_code, headers
3723
3918
  end
3724
3919
 
3920
+ # Reverse an existing payment
3921
+ # Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
3922
+ # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
3923
+ # @param [Hash] opts the optional parameters
3924
+ # @return [PaymentInitiationPaymentReverseResponse]
3925
+ def payment_initiation_payment_reverse(payment_initiation_payment_reverse_request, opts = {})
3926
+ data, _status_code, _headers = payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts)
3927
+ data
3928
+ end
3929
+
3930
+ # Reverse an existing payment
3931
+ # Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender&#39;s account.
3932
+ # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
3933
+ # @param [Hash] opts the optional parameters
3934
+ # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
3935
+ def payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts = {})
3936
+ if @api_client.config.debugging
3937
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_reverse ...'
3938
+ end
3939
+ # verify the required parameter 'payment_initiation_payment_reverse_request' is set
3940
+ if @api_client.config.client_side_validation && payment_initiation_payment_reverse_request.nil?
3941
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_reverse_request' when calling PlaidApi.payment_initiation_payment_reverse"
3942
+ end
3943
+ # resource path
3944
+ local_var_path = '/payment_initiation/payment/reverse'
3945
+
3946
+ # query parameters
3947
+ query_params = opts[:query_params] || {}
3948
+
3949
+ # header parameters
3950
+ header_params = opts[:header_params] || {}
3951
+ # HTTP header 'Accept' (if needed)
3952
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3953
+ # HTTP header 'Content-Type'
3954
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3955
+
3956
+ # form parameters
3957
+ form_params = opts[:form_params] || {}
3958
+
3959
+ # http body (model)
3960
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_reverse_request)
3961
+
3962
+ # return_type
3963
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentReverseResponse'
3964
+
3965
+ # auth_names
3966
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3967
+
3968
+ new_options = opts.merge(
3969
+ :operation => :"PlaidApi.payment_initiation_payment_reverse",
3970
+ :header_params => header_params,
3971
+ :query_params => query_params,
3972
+ :form_params => form_params,
3973
+ :body => post_body,
3974
+ :auth_names => auth_names,
3975
+ :return_type => return_type
3976
+ )
3977
+
3978
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3979
+ if @api_client.config.debugging
3980
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_reverse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3981
+ end
3982
+ return data, status_code, headers
3983
+ end
3984
+
3725
3985
  # Create payment recipient
3726
3986
  # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
3727
3987
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
@@ -5087,26 +5347,26 @@ module Plaid
5087
5347
 
5088
5348
  # Evaluate a planned ACH transaction
5089
5349
  # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.
5090
- # @param request_body [Hash<String, Object>]
5350
+ # @param signal_evaluate_request [SignalEvaluateRequest]
5091
5351
  # @param [Hash] opts the optional parameters
5092
5352
  # @return [SignalEvaluateResponse]
5093
- def signal_evaluate(request_body, opts = {})
5094
- data, _status_code, _headers = signal_evaluate_with_http_info(request_body, opts)
5353
+ def signal_evaluate(signal_evaluate_request, opts = {})
5354
+ data, _status_code, _headers = signal_evaluate_with_http_info(signal_evaluate_request, opts)
5095
5355
  data
5096
5356
  end
5097
5357
 
5098
5358
  # Evaluate a planned ACH transaction
5099
5359
  # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.
5100
- # @param request_body [Hash<String, Object>]
5360
+ # @param signal_evaluate_request [SignalEvaluateRequest]
5101
5361
  # @param [Hash] opts the optional parameters
5102
5362
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
5103
- def signal_evaluate_with_http_info(request_body, opts = {})
5363
+ def signal_evaluate_with_http_info(signal_evaluate_request, opts = {})
5104
5364
  if @api_client.config.debugging
5105
5365
  @api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
5106
5366
  end
5107
- # verify the required parameter 'request_body' is set
5108
- if @api_client.config.client_side_validation && request_body.nil?
5109
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.signal_evaluate"
5367
+ # verify the required parameter 'signal_evaluate_request' is set
5368
+ if @api_client.config.client_side_validation && signal_evaluate_request.nil?
5369
+ fail ArgumentError, "Missing the required parameter 'signal_evaluate_request' when calling PlaidApi.signal_evaluate"
5110
5370
  end
5111
5371
  # resource path
5112
5372
  local_var_path = '/signal/evaluate'
@@ -5125,7 +5385,7 @@ module Plaid
5125
5385
  form_params = opts[:form_params] || {}
5126
5386
 
5127
5387
  # http body (model)
5128
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
5388
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)
5129
5389
 
5130
5390
  # return_type
5131
5391
  return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
@@ -5152,26 +5412,26 @@ module Plaid
5152
5412
 
5153
5413
  # Report a return for an ACH transaction
5154
5414
  # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
5155
- # @param signal_return_report_request [SignalReturnReportRequest]
5415
+ # @param request_body [Hash<String, Object>]
5156
5416
  # @param [Hash] opts the optional parameters
5157
5417
  # @return [SignalReturnReportResponse]
5158
- def signal_return_report(signal_return_report_request, opts = {})
5159
- data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
5418
+ def signal_return_report(request_body, opts = {})
5419
+ data, _status_code, _headers = signal_return_report_with_http_info(request_body, opts)
5160
5420
  data
5161
5421
  end
5162
5422
 
5163
5423
  # Report a return for an ACH transaction
5164
5424
  # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
5165
- # @param signal_return_report_request [SignalReturnReportRequest]
5425
+ # @param request_body [Hash<String, Object>]
5166
5426
  # @param [Hash] opts the optional parameters
5167
5427
  # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
5168
- def signal_return_report_with_http_info(signal_return_report_request, opts = {})
5428
+ def signal_return_report_with_http_info(request_body, opts = {})
5169
5429
  if @api_client.config.debugging
5170
5430
  @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
5171
5431
  end
5172
- # verify the required parameter 'signal_return_report_request' is set
5173
- if @api_client.config.client_side_validation && signal_return_report_request.nil?
5174
- fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
5432
+ # verify the required parameter 'request_body' is set
5433
+ if @api_client.config.client_side_validation && request_body.nil?
5434
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.signal_return_report"
5175
5435
  end
5176
5436
  # resource path
5177
5437
  local_var_path = '/signal/return/report'
@@ -5190,7 +5450,7 @@ module Plaid
5190
5450
  form_params = opts[:form_params] || {}
5191
5451
 
5192
5452
  # http body (model)
5193
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
5453
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
5194
5454
 
5195
5455
  # return_type
5196
5456
  return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
@@ -5280,6 +5540,71 @@ module Plaid
5280
5540
  return data, status_code, headers
5281
5541
  end
5282
5542
 
5543
+ # Get streams of recurring transactions
5544
+ # The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
5545
+ # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
5546
+ # @param [Hash] opts the optional parameters
5547
+ # @return [TransactionsRecurringGetResponse]
5548
+ def transactions_recurring_get(transactions_recurring_get_request, opts = {})
5549
+ data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
5550
+ data
5551
+ end
5552
+
5553
+ # Get streams of recurring transactions
5554
+ # The &#x60;/transactions/recurring/get&#x60; endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
5555
+ # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
5556
+ # @param [Hash] opts the optional parameters
5557
+ # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
5558
+ def transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {})
5559
+ if @api_client.config.debugging
5560
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_get ...'
5561
+ end
5562
+ # verify the required parameter 'transactions_recurring_get_request' is set
5563
+ if @api_client.config.client_side_validation && transactions_recurring_get_request.nil?
5564
+ fail ArgumentError, "Missing the required parameter 'transactions_recurring_get_request' when calling PlaidApi.transactions_recurring_get"
5565
+ end
5566
+ # resource path
5567
+ local_var_path = '/transactions/recurring/get'
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(transactions_recurring_get_request)
5584
+
5585
+ # return_type
5586
+ return_type = opts[:debug_return_type] || 'TransactionsRecurringGetResponse'
5587
+
5588
+ # auth_names
5589
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5590
+
5591
+ new_options = opts.merge(
5592
+ :operation => :"PlaidApi.transactions_recurring_get",
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#transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5604
+ end
5605
+ return data, status_code, headers
5606
+ end
5607
+
5283
5608
  # Refresh transaction data
5284
5609
  # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
5285
5610
  # @param transactions_refresh_request [TransactionsRefreshRequest]
@@ -5346,7 +5671,7 @@ module Plaid
5346
5671
  end
5347
5672
 
5348
5673
  # 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`.
5674
+ # 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, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - 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
5675
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5351
5676
  # @param [Hash] opts the optional parameters
5352
5677
  # @return [TransferAuthorizationCreateResponse]
@@ -5356,7 +5681,7 @@ module Plaid
5356
5681
  end
5357
5682
 
5358
5683
  # 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;.
5684
+ # 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, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - 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
5685
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5361
5686
  # @param [Hash] opts the optional parameters
5362
5687
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -30,11 +30,10 @@ module Plaid
30
30
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
31
  def initialize(config = Configuration.default)
32
32
  @config = config
33
- @user_agent = "Plaid Ruby v#{VERSION}"
33
+ @user_agent = "Plaid Ruby v#"
34
34
  @default_headers = {
35
35
  'Content-Type' => 'application/json',
36
36
  'User-Agent' => @user_agent,
37
- 'Plaid-Version' => '2020-09-14',
38
37
  }
39
38
  end
40
39
 
@@ -72,7 +71,8 @@ module Plaid
72
71
  else
73
72
  fail ApiError.new(:code => response.status,
74
73
  :response_headers => response.headers,
75
- :response_body => response.body),
74
+ :response_body => response.body,
75
+ :data => JSON.parse(response.body)),
76
76
  response.reason_phrase
77
77
  end
78
78
  end
@@ -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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -12,7 +12,7 @@ OpenAPI Generator version: 5.1.0
12
12
 
13
13
  module Plaid
14
14
  class ApiError < StandardError
15
- attr_reader :code, :response_headers, :response_body
15
+ attr_reader :code, :response_headers, :response_body, :data
16
16
 
17
17
  # Usage examples:
18
18
  # ApiError.new
@@ -54,4 +54,4 @@ module Plaid
54
54
  msg
55
55
  end
56
56
  end
57
- end
57
+ end
@@ -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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -88,7 +88,6 @@ module Plaid
88
88
  attr_accessor :temp_folder_path
89
89
 
90
90
  # The time limit for HTTP request in seconds.
91
- # Default to 0 (never times out).
92
91
  attr_accessor :timeout
93
92
 
94
93
  # Set this to false to skip client side validation in the operation.
@@ -145,9 +144,11 @@ module Plaid
145
144
  @server_operation_index = {}
146
145
  @server_variables = {}
147
146
  @server_operation_variables = {}
148
- @api_key = {}
147
+ @api_key = {
148
+ 'Plaid-Version' => '2020-09-14',
149
+ }
149
150
  @api_key_prefix = {}
150
- @timeout = 0
151
+ @timeout = 60
151
152
  @client_side_validation = true
152
153
  @ssl_verify = true
153
154
  @ssl_verify_mode = nil
@@ -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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.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.26.1
6
+ The version of the OpenAPI document: 2020-09-14_1.37.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0