plaid 14.0.0.beta.2 → 14.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (924) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -1
  3. data/CONTRIBUTING.md +1 -5
  4. data/Gemfile.lock +18 -4
  5. data/LICENSE.txt +1 -1
  6. data/Makefile +2 -21
  7. data/PUBLISH.md +2 -3
  8. data/README.md +7 -6
  9. data/doc/rdoc/.DS_Store +0 -0
  10. data/doc/rdoc/apple-touch-icon.png +0 -0
  11. data/doc/rdoc/classes/Object.html +118 -0
  12. data/doc/rdoc/classes/Plaid.html +772 -0
  13. data/doc/rdoc/classes/Plaid/APIError.html +97 -0
  14. data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
  15. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
  16. data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
  17. data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
  18. data/doc/rdoc/classes/Plaid/Apex.html +149 -0
  19. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
  20. data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
  21. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
  22. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
  23. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
  24. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
  25. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
  26. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
  27. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
  28. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
  29. data/doc/rdoc/classes/Plaid/Auth.html +206 -0
  30. data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
  31. data/doc/rdoc/classes/Plaid/Balance.html +206 -0
  32. data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
  33. data/doc/rdoc/classes/Plaid/Categories.html +191 -0
  34. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
  35. data/doc/rdoc/classes/Plaid/Client.html +802 -0
  36. data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
  37. data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
  38. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
  39. data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
  40. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
  41. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
  42. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
  43. data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
  44. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
  45. data/doc/rdoc/classes/Plaid/Error.html +214 -0
  46. data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
  47. data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
  48. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
  49. data/doc/rdoc/classes/Plaid/Identity.html +199 -0
  50. data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
  51. data/doc/rdoc/classes/Plaid/Income.html +198 -0
  52. data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
  53. data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
  54. data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
  55. data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
  56. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
  57. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
  58. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
  59. data/doc/rdoc/classes/Plaid/Investments.html +204 -0
  60. data/doc/rdoc/classes/Plaid/Item.html +382 -0
  61. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
  62. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
  63. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
  64. data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
  65. data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
  66. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
  67. data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
  68. data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
  69. data/doc/rdoc/classes/Plaid/Models.html +506 -0
  70. data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
  71. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
  72. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
  73. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
  74. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
  77. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
  78. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
  79. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
  80. data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
  81. data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
  82. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
  83. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
  84. data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
  85. data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
  86. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
  87. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
  88. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
  89. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
  90. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
  91. data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
  92. data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
  93. data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
  94. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
  95. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
  96. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
  97. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
  98. data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
  99. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
  100. data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
  101. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
  102. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
  103. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
  104. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
  105. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
  106. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
  107. data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
  108. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
  109. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
  110. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
  111. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
  112. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
  113. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
  114. data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
  115. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
  116. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
  117. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
  118. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
  119. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
  120. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
  121. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
  122. data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
  123. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
  124. data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
  125. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
  126. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
  127. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
  128. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
  129. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
  130. data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
  131. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
  132. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
  133. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
  134. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
  135. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
  136. data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
  137. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
  138. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
  139. data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
  140. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
  141. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
  142. data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
  143. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
  144. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
  145. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
  146. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
  147. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
  148. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
  149. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
  150. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
  151. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
  152. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
  153. data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
  154. data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
  155. data/doc/rdoc/classes/Plaid/Processor.html +143 -0
  156. data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
  157. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
  158. data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
  159. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
  160. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
  161. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
  162. data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
  163. data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
  164. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
  165. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
  166. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
  167. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
  168. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
  169. data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
  170. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
  171. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
  172. data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
  173. data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
  174. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
  175. data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
  176. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
  177. data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
  178. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
  179. data/doc/rdoc/created.rid +28 -0
  180. data/doc/rdoc/css/github.css +123 -0
  181. data/doc/rdoc/css/main.css +333 -0
  182. data/doc/rdoc/css/panel.css +383 -0
  183. data/doc/rdoc/css/reset.css +48 -0
  184. data/doc/rdoc/favicon.ico +0 -0
  185. data/doc/rdoc/files/LICENSE_txt.html +98 -0
  186. data/doc/rdoc/files/README_md.html +388 -0
  187. data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
  188. data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
  189. data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
  190. data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
  191. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
  192. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
  193. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
  194. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
  195. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
  196. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
  197. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
  198. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
  199. data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
  200. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
  201. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
  202. data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
  203. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
  204. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
  205. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
  206. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
  207. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
  208. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
  209. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
  210. data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
  211. data/doc/rdoc/files/lib/plaid_rb.html +120 -0
  212. data/doc/rdoc/i/arrows.png +0 -0
  213. data/doc/rdoc/i/results_bg.png +0 -0
  214. data/doc/rdoc/i/tree_bg.png +0 -0
  215. data/doc/rdoc/index.html +13 -0
  216. data/doc/rdoc/js/highlight.pack.js +1 -0
  217. data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
  218. data/doc/rdoc/js/main.js +29 -0
  219. data/doc/rdoc/js/navigation.js +142 -0
  220. data/doc/rdoc/js/navigation.js.gz +0 -0
  221. data/doc/rdoc/js/search_index.js +1 -0
  222. data/doc/rdoc/js/search_index.js.gz +0 -0
  223. data/doc/rdoc/js/searchdoc.js +468 -0
  224. data/doc/rdoc/js/searcher.js +229 -0
  225. data/doc/rdoc/js/searcher.js.gz +0 -0
  226. data/doc/rdoc/panel/index.html +74 -0
  227. data/doc/rdoc/panel/links.html +60 -0
  228. data/doc/rdoc/panel/tree.js +1 -0
  229. data/lib/plaid.rb +75 -20
  230. data/lib/plaid/.DS_Store +0 -0
  231. data/lib/plaid/api/plaid_api.rb +912 -171
  232. data/lib/plaid/api_client.rb +4 -3
  233. data/lib/plaid/api_error.rb +2 -2
  234. data/lib/plaid/configuration.rb +2 -2
  235. data/lib/plaid/models/account_access.rb +238 -0
  236. data/lib/plaid/models/account_assets.rb +18 -7
  237. data/lib/plaid/models/account_assets_all_of.rb +17 -5
  238. data/lib/plaid/models/account_balance.rb +21 -14
  239. data/lib/plaid/models/account_base.rb +3 -4
  240. data/lib/plaid/models/account_filter.rb +258 -0
  241. data/lib/plaid/models/account_filters_response.rb +2 -2
  242. data/lib/plaid/models/account_identity.rb +3 -4
  243. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  244. data/lib/plaid/models/account_selection_cardinality.rb +38 -0
  245. data/lib/plaid/models/account_subtype.rb +7 -2
  246. data/lib/plaid/models/account_type.rb +2 -2
  247. data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
  248. data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
  249. data/lib/plaid/models/accounts_get_request.rb +4 -4
  250. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  251. data/lib/plaid/models/accounts_get_response.rb +2 -2
  252. data/lib/plaid/models/ach_class.rb +2 -2
  253. data/lib/plaid/models/address.rb +2 -3
  254. data/lib/plaid/models/address_data.rb +3 -7
  255. data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +6 -10
  256. data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +5 -6
  257. data/lib/plaid/models/application.rb +288 -0
  258. data/lib/plaid/models/application_get_request.rb +255 -0
  259. data/lib/plaid/models/application_get_response.rb +239 -0
  260. data/lib/plaid/models/apr.rb +2 -2
  261. data/lib/plaid/models/asset_report.rb +3 -3
  262. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
  263. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  264. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
  265. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
  266. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  267. data/lib/plaid/models/asset_report_create_request.rb +28 -4
  268. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  269. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  270. data/lib/plaid/models/asset_report_filter_request.rb +4 -4
  271. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  272. data/lib/plaid/models/asset_report_get_request.rb +5 -5
  273. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  274. data/lib/plaid/models/asset_report_item.rb +3 -3
  275. data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
  276. data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
  277. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  278. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  279. data/lib/plaid/models/asset_report_remove_request.rb +4 -4
  280. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  281. data/lib/plaid/models/asset_report_transaction.rb +110 -167
  282. data/lib/plaid/models/asset_report_transaction_all_of.rb +7 -22
  283. data/lib/plaid/models/asset_report_user.rb +3 -3
  284. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  285. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  286. data/lib/plaid/models/auth_get_numbers.rb +22 -2
  287. data/lib/plaid/models/auth_get_request.rb +4 -4
  288. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  289. data/lib/plaid/models/auth_get_response.rb +2 -2
  290. data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
  291. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  292. data/lib/plaid/models/bank_transfer.rb +12 -3
  293. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  294. data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
  295. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  296. data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
  297. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  298. data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
  299. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  300. data/lib/plaid/models/bank_transfer_direction.rb +3 -2
  301. data/lib/plaid/models/bank_transfer_event.rb +5 -3
  302. data/lib/plaid/models/bank_transfer_event_list_request.rb +23 -7
  303. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  304. data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
  305. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  306. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  307. data/lib/plaid/models/bank_transfer_failure.rb +3 -3
  308. data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
  309. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  310. data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
  311. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  312. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
  313. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  314. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  315. data/lib/plaid/models/bank_transfer_receiver_details.rb +4 -4
  316. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  317. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  318. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  319. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  320. data/lib/plaid/models/categories_get_response.rb +2 -2
  321. data/lib/plaid/models/category.rb +2 -2
  322. data/lib/plaid/models/cause.rb +2 -2
  323. data/lib/plaid/models/connected_application.rb +357 -0
  324. data/lib/plaid/models/country_code.rb +2 -2
  325. data/lib/plaid/models/credit_card_liability.rb +7 -26
  326. data/lib/plaid/models/credit_filter.rb +3 -3
  327. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  328. data/lib/plaid/models/default_update_webhook.rb +2 -2
  329. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  330. data/lib/plaid/models/deposit_switch_alt_create_request.rb +62 -8
  331. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  332. data/lib/plaid/models/deposit_switch_create_request.rb +62 -8
  333. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  334. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  335. data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
  336. data/lib/plaid/models/deposit_switch_get_response.rb +75 -8
  337. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
  338. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  339. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  340. data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
  341. data/lib/plaid/models/deposit_switch_token_create_response.rb +3 -3
  342. data/lib/plaid/models/depository_filter.rb +3 -3
  343. data/lib/plaid/models/email.rb +2 -2
  344. data/lib/plaid/models/employee.rb +7 -18
  345. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  346. data/lib/plaid/models/employer.rb +8 -4
  347. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  348. data/lib/plaid/models/employers_search_request.rb +4 -4
  349. data/lib/plaid/models/employers_search_response.rb +2 -2
  350. data/lib/plaid/models/error.rb +5 -12
  351. data/lib/plaid/models/external_payment_options.rb +296 -0
  352. data/lib/plaid/models/{payment_initiation_recipient_bacs.rb → external_payment_refund_details.rb} +34 -26
  353. data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +25 -29
  354. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  355. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  356. data/lib/plaid/models/health_incident.rb +19 -6
  357. data/lib/plaid/models/historical_balance.rb +4 -4
  358. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  359. data/lib/plaid/models/holding.rb +5 -5
  360. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  361. data/lib/plaid/models/identity_get_request.rb +4 -4
  362. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  363. data/lib/plaid/models/identity_get_response.rb +2 -2
  364. data/lib/plaid/models/incident_update.rb +5 -5
  365. data/lib/plaid/models/income_breakdown.rb +37 -3
  366. data/lib/plaid/models/income_summary.rb +27 -2
  367. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  368. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  369. data/lib/plaid/models/income_verification_create_request.rb +4 -4
  370. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  371. data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
  372. data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
  373. data/lib/plaid/models/{income_verification_paystub_get_request.rb → income_verification_paystubs_get_request.rb} +8 -8
  374. data/lib/plaid/models/income_verification_paystubs_get_response.rb +241 -0
  375. data/lib/plaid/models/income_verification_refresh_request.rb +245 -0
  376. data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
  377. data/lib/plaid/models/income_verification_status_webhook.rb +3 -3
  378. data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
  379. data/lib/plaid/models/income_verification_summary_get_response.rb +13 -3
  380. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  381. data/lib/plaid/models/inflow_model.rb +2 -2
  382. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  383. data/lib/plaid/models/institution.rb +17 -7
  384. data/lib/plaid/models/institution_status.rb +31 -4
  385. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
  386. data/lib/plaid/models/institutions_get_by_id_request_options.rb +18 -6
  387. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  388. data/lib/plaid/models/institutions_get_request.rb +27 -4
  389. data/lib/plaid/models/institutions_get_request_options.rb +19 -7
  390. data/lib/plaid/models/institutions_get_response.rb +3 -3
  391. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  392. data/lib/plaid/models/{link_token_create_request_account_subtypes_loan.rb → institutions_search_payment_initiation_options.rb} +14 -16
  393. data/lib/plaid/models/institutions_search_request.rb +26 -5
  394. data/lib/plaid/models/institutions_search_request_options.rb +23 -10
  395. data/lib/plaid/models/institutions_search_response.rb +2 -2
  396. data/lib/plaid/models/investment_filter.rb +3 -3
  397. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  398. data/lib/plaid/models/investment_transaction.rb +8 -7
  399. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  400. data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
  401. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  402. data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
  403. data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
  404. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  405. data/lib/plaid/models/item.rb +44 -4
  406. data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
  407. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  408. data/lib/plaid/models/item_application_list_request.rb +241 -0
  409. data/lib/plaid/models/item_application_list_response.rb +237 -0
  410. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  411. data/lib/plaid/models/item_application_scopes_update_request.rb +274 -0
  412. data/lib/plaid/models/{income_verification_paystub_get_response.rb → item_application_scopes_update_response.rb} +12 -16
  413. data/lib/plaid/models/item_error_webhook.rb +2 -2
  414. data/lib/plaid/models/item_get_request.rb +4 -4
  415. data/lib/plaid/models/item_get_response.rb +7 -17
  416. data/lib/plaid/models/item_import_request.rb +25 -4
  417. data/lib/plaid/models/item_import_request_options.rb +2 -2
  418. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  419. data/lib/plaid/models/item_import_response.rb +2 -2
  420. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  421. data/lib/plaid/models/item_public_token_create_request.rb +4 -4
  422. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  423. data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
  424. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  425. data/lib/plaid/models/item_remove_request.rb +4 -4
  426. data/lib/plaid/models/item_remove_response.rb +2 -2
  427. data/lib/plaid/models/item_status.rb +2 -2
  428. data/lib/plaid/models/item_status_investments.rb +4 -4
  429. data/lib/plaid/models/item_status_last_webhook.rb +3 -3
  430. data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +5 -5
  431. data/lib/plaid/models/item_status_transactions.rb +4 -4
  432. data/lib/plaid/models/item_webhook_update_request.rb +4 -4
  433. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  434. data/lib/plaid/models/jwk_public_key.rb +42 -2
  435. data/lib/plaid/models/jwt_header.rb +2 -2
  436. data/lib/plaid/models/liabilities_default_update_webhook.rb +299 -0
  437. data/lib/plaid/models/liabilities_get_request.rb +4 -4
  438. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  439. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  440. data/lib/plaid/models/liabilities_object.rb +5 -5
  441. data/lib/plaid/models/liability_override.rb +9 -26
  442. data/lib/plaid/models/link_token_account_filters.rb +3 -3
  443. data/lib/plaid/models/link_token_create_request.rb +60 -12
  444. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +23 -11
  445. data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
  446. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  447. data/lib/plaid/models/link_token_create_request_income_verification.rb +3 -4
  448. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +23 -2
  449. data/lib/plaid/models/link_token_create_request_user.rb +11 -11
  450. data/lib/plaid/models/link_token_create_response.rb +3 -3
  451. data/lib/plaid/models/{link_token_create_request_account_subtypes_credit.rb → link_token_eu_config.rb} +14 -16
  452. data/lib/plaid/models/link_token_get_metadata_response.rb +12 -2
  453. data/lib/plaid/models/link_token_get_request.rb +4 -4
  454. data/lib/plaid/models/link_token_get_response.rb +12 -2
  455. data/lib/plaid/models/loan_filter.rb +3 -3
  456. data/lib/plaid/models/location.rb +2 -2
  457. data/lib/plaid/models/meta.rb +2 -2
  458. data/lib/plaid/models/mfa.rb +2 -2
  459. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  460. data/lib/plaid/models/mortgage_liability.rb +21 -7
  461. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  462. data/lib/plaid/models/numbers.rb +2 -42
  463. data/lib/plaid/models/numbers_ach.rb +4 -4
  464. data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +7 -7
  465. data/lib/plaid/models/numbers_bacs.rb +2 -2
  466. data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +5 -5
  467. data/lib/plaid/models/numbers_eft.rb +2 -2
  468. data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +5 -5
  469. data/lib/plaid/models/numbers_international.rb +2 -2
  470. data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +5 -5
  471. data/lib/plaid/models/override_account_type.rb +40 -0
  472. data/lib/plaid/models/override_accounts.rb +3 -3
  473. data/lib/plaid/models/owner.rb +3 -3
  474. data/lib/plaid/models/owner_override.rb +2 -2
  475. data/lib/plaid/models/pay_frequency.rb +2 -2
  476. data/lib/plaid/models/pay_period_details.rb +5 -5
  477. data/lib/plaid/models/payment_amount.rb +49 -4
  478. data/lib/plaid/models/payment_initiation_address.rb +133 -2
  479. data/lib/plaid/models/payment_initiation_metadata.rb +267 -0
  480. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +288 -0
  481. data/lib/plaid/models/payment_initiation_payment.rb +413 -0
  482. data/lib/plaid/models/payment_initiation_payment_create_request.rb +70 -10
  483. data/lib/plaid/models/payment_initiation_payment_create_response.rb +36 -2
  484. data/lib/plaid/models/payment_initiation_payment_get_request.rb +25 -4
  485. data/lib/plaid/models/payment_initiation_payment_get_response.rb +95 -22
  486. data/lib/plaid/models/payment_initiation_payment_list_request.rb +6 -19
  487. data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
  488. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +25 -4
  489. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
  490. data/lib/plaid/models/payment_initiation_recipient.rb +21 -10
  491. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +53 -5
  492. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  493. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +25 -4
  494. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +23 -4
  495. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  496. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
  497. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  498. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
  499. data/lib/plaid/models/payment_meta.rb +3 -3
  500. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  501. data/lib/plaid/models/payment_status_update_webhook.rb +48 -4
  502. data/lib/plaid/models/paystub.rb +4 -19
  503. data/lib/plaid/models/paystub_deduction.rb +2 -2
  504. data/lib/plaid/models/{nullable_access_token.rb → paystub_employer.rb} +18 -7
  505. data/lib/plaid/models/paystub_ytd_details.rb +3 -2
  506. data/lib/plaid/models/pending_expiration_webhook.rb +3 -3
  507. data/lib/plaid/models/phone_number.rb +12 -4
  508. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
  509. data/lib/plaid/models/processor_auth_get_request.rb +4 -4
  510. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  511. data/lib/plaid/models/processor_balance_get_request.rb +4 -4
  512. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  513. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  514. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  515. data/lib/plaid/models/processor_identity_get_request.rb +4 -4
  516. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  517. data/lib/plaid/models/processor_number.rb +6 -6
  518. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
  519. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  520. data/lib/plaid/models/processor_token_create_request.rb +39 -5
  521. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  522. data/lib/plaid/models/product_access.rb +262 -0
  523. data/lib/plaid/models/product_status.rb +4 -4
  524. data/lib/plaid/models/product_status_breakdown.rb +2 -3
  525. data/lib/plaid/models/products.rb +4 -2
  526. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  527. data/lib/plaid/models/pslf_status.rb +3 -3
  528. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  529. data/lib/plaid/models/recipient_bacs.rb +54 -2
  530. data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
  531. data/lib/plaid/models/requested_scopes.rb +261 -0
  532. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  533. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  534. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
  535. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  536. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
  537. data/lib/plaid/models/{nullable_recipient_bacs.rb → sandbox_income_fire_webhook_response.rb} +19 -30
  538. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
  539. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  540. data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
  541. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  542. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
  543. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  544. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  545. data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
  546. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  547. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  548. data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
  549. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  550. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +5 -5
  551. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  552. data/lib/plaid/models/scopes.rb +243 -0
  553. data/lib/plaid/models/scopes_nullable.rb +249 -0
  554. data/lib/plaid/models/security.rb +7 -10
  555. data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
  556. data/lib/plaid/models/servicer_address_data.rb +2 -2
  557. data/lib/plaid/models/signal_address_data.rb +263 -0
  558. data/lib/plaid/models/signal_decision_report_request.rb +259 -0
  559. data/lib/plaid/models/signal_decision_report_response.rb +224 -0
  560. data/lib/plaid/models/{link_token_create_request_account_subtypes_investment.rb → signal_device.rb} +26 -16
  561. data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
  562. data/lib/plaid/models/signal_evaluate_request.rb +355 -0
  563. data/lib/plaid/models/signal_evaluate_response.rb +252 -0
  564. data/lib/plaid/models/signal_person_name.rb +265 -0
  565. data/lib/plaid/models/signal_return_report_request.rb +259 -0
  566. data/lib/plaid/models/signal_return_report_response.rb +224 -0
  567. data/lib/plaid/models/signal_scores.rb +227 -0
  568. data/lib/plaid/models/signal_user.rb +252 -0
  569. data/lib/plaid/models/standalone_account_type.rb +2 -2
  570. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  571. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
  572. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  573. data/lib/plaid/models/student_loan.rb +30 -21
  574. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  575. data/lib/plaid/models/student_loan_status.rb +3 -3
  576. data/lib/plaid/models/student_repayment_plan.rb +4 -4
  577. data/lib/plaid/models/transaction.rb +178 -116
  578. data/lib/plaid/models/transaction_all_of.rb +312 -0
  579. data/lib/plaid/models/transaction_base.rb +436 -0
  580. data/lib/plaid/models/transaction_code.rb +2 -2
  581. data/lib/plaid/models/transaction_data.rb +3 -3
  582. data/lib/plaid/models/transaction_override.rb +21 -21
  583. data/lib/plaid/models/transactions_get_request.rb +4 -4
  584. data/lib/plaid/models/transactions_get_request_options.rb +23 -6
  585. data/lib/plaid/models/transactions_get_response.rb +2 -2
  586. data/lib/plaid/models/transactions_refresh_request.rb +9 -4
  587. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  588. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  589. data/lib/plaid/models/user_custom_password.rb +2 -2
  590. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  591. data/lib/plaid/models/verification_expired_webhook.rb +3 -3
  592. data/lib/plaid/models/verification_refresh_status.rb +36 -0
  593. data/lib/plaid/models/verification_status.rb +2 -2
  594. data/lib/plaid/models/warning.rb +36 -2
  595. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  596. data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
  597. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  598. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  599. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  600. data/lib/plaid/version.rb +3 -3
  601. data/pkg/plaid-13.2.0.gem +0 -0
  602. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  603. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  604. data/plaid.gemspec +3 -3
  605. data/templates/ruby/api_client.mustache +3 -1
  606. data/templates/ruby/partial_model_generic.mustache +362 -0
  607. data/test/test_bank_transfers.rb +2 -2
  608. data/test/test_item.rb +1 -10
  609. data/test/test_payment_initiation.rb +2 -3
  610. data/test/test_processor.rb +1 -16
  611. metadata +310 -342
  612. data/docs/ACHClass.md +0 -15
  613. data/docs/APR.md +0 -24
  614. data/docs/AccountAssets.md +0 -40
  615. data/docs/AccountAssetsAllOf.md +0 -24
  616. data/docs/AccountBalance.md +0 -26
  617. data/docs/AccountBase.md +0 -32
  618. data/docs/AccountFiltersResponse.md +0 -24
  619. data/docs/AccountIdentity.md +0 -34
  620. data/docs/AccountIdentityAllOf.md +0 -18
  621. data/docs/AccountSubtype.md +0 -15
  622. data/docs/AccountType.md +0 -15
  623. data/docs/AccountsBalanceGetRequest.md +0 -24
  624. data/docs/AccountsBalanceGetRequestOptions.md +0 -18
  625. data/docs/AccountsGetRequest.md +0 -24
  626. data/docs/AccountsGetRequestOptions.md +0 -18
  627. data/docs/AccountsGetResponse.md +0 -22
  628. data/docs/Address.md +0 -20
  629. data/docs/AddressData.md +0 -26
  630. data/docs/Amount.md +0 -20
  631. data/docs/AssetReport.md +0 -28
  632. data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
  633. data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
  634. data/docs/AssetReportAuditCopyGetRequest.md +0 -22
  635. data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
  636. data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
  637. data/docs/AssetReportCreateRequest.md +0 -26
  638. data/docs/AssetReportCreateRequestOptions.md +0 -22
  639. data/docs/AssetReportCreateResponse.md +0 -22
  640. data/docs/AssetReportFilterRequest.md +0 -24
  641. data/docs/AssetReportFilterResponse.md +0 -22
  642. data/docs/AssetReportGetRequest.md +0 -24
  643. data/docs/AssetReportGetResponse.md +0 -22
  644. data/docs/AssetReportItem.md +0 -26
  645. data/docs/AssetReportPDFGetRequest.md +0 -22
  646. data/docs/AssetReportRefreshRequest.md +0 -26
  647. data/docs/AssetReportRefreshRequestOptions.md +0 -22
  648. data/docs/AssetReportRefreshResponse.md +0 -22
  649. data/docs/AssetReportRemoveRequest.md +0 -22
  650. data/docs/AssetReportRemoveResponse.md +0 -20
  651. data/docs/AssetReportTransaction.md +0 -58
  652. data/docs/AssetReportTransactionAllOf.md +0 -20
  653. data/docs/AssetReportUser.md +0 -30
  654. data/docs/AssetsErrorWebhook.md +0 -24
  655. data/docs/AssetsProductReadyWebhook.md +0 -22
  656. data/docs/AuthGetNumbers.md +0 -24
  657. data/docs/AuthGetRequest.md +0 -24
  658. data/docs/AuthGetRequestOptions.md +0 -18
  659. data/docs/AuthGetResponse.md +0 -24
  660. data/docs/AutomaticallyVerifiedWebhook.md +0 -24
  661. data/docs/BankTransfer.md +0 -50
  662. data/docs/BankTransferBalance.md +0 -20
  663. data/docs/BankTransferBalanceGetRequest.md +0 -22
  664. data/docs/BankTransferBalanceGetResponse.md +0 -22
  665. data/docs/BankTransferCancelRequest.md +0 -22
  666. data/docs/BankTransferCancelResponse.md +0 -18
  667. data/docs/BankTransferCreateRequest.md +0 -46
  668. data/docs/BankTransferCreateResponse.md +0 -20
  669. data/docs/BankTransferDirection.md +0 -15
  670. data/docs/BankTransferEvent.md +0 -40
  671. data/docs/BankTransferEventListRequest.md +0 -40
  672. data/docs/BankTransferEventListResponse.md +0 -20
  673. data/docs/BankTransferEventSyncRequest.md +0 -24
  674. data/docs/BankTransferEventSyncResponse.md +0 -20
  675. data/docs/BankTransferEventType.md +0 -15
  676. data/docs/BankTransferFailure.md +0 -20
  677. data/docs/BankTransferGetRequest.md +0 -22
  678. data/docs/BankTransferGetResponse.md +0 -20
  679. data/docs/BankTransferListRequest.md +0 -32
  680. data/docs/BankTransferListResponse.md +0 -20
  681. data/docs/BankTransferMigrateAccountRequest.md +0 -26
  682. data/docs/BankTransferMigrateAccountResponse.md +0 -22
  683. data/docs/BankTransferNetwork.md +0 -15
  684. data/docs/BankTransferReceiverDetails.md +0 -18
  685. data/docs/BankTransferStatus.md +0 -15
  686. data/docs/BankTransferType.md +0 -15
  687. data/docs/BankTransferUser.md +0 -22
  688. data/docs/CategoriesGetResponse.md +0 -20
  689. data/docs/Category.md +0 -22
  690. data/docs/Cause.md +0 -20
  691. data/docs/CountryCode.md +0 -15
  692. data/docs/CreditCardLiability.md +0 -34
  693. data/docs/CreditFilter.md +0 -18
  694. data/docs/DefaultUpdateWebhook.md +0 -26
  695. data/docs/DepositSwitchAddressData.md +0 -26
  696. data/docs/DepositSwitchAltCreateRequest.md +0 -24
  697. data/docs/DepositSwitchAltCreateResponse.md +0 -20
  698. data/docs/DepositSwitchCreateRequest.md +0 -24
  699. data/docs/DepositSwitchCreateResponse.md +0 -20
  700. data/docs/DepositSwitchGetRequest.md +0 -22
  701. data/docs/DepositSwitchGetResponse.md +0 -38
  702. data/docs/DepositSwitchTargetAccount.md +0 -24
  703. data/docs/DepositSwitchTargetUser.md +0 -28
  704. data/docs/DepositSwitchTokenCreateRequest.md +0 -22
  705. data/docs/DepositSwitchTokenCreateResponse.md +0 -22
  706. data/docs/DepositoryFilter.md +0 -18
  707. data/docs/Email.md +0 -22
  708. data/docs/Employee.md +0 -22
  709. data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
  710. data/docs/Employer.md +0 -24
  711. data/docs/EmployerIncomeSummaryFieldString.md +0 -20
  712. data/docs/EmployersSearchRequest.md +0 -24
  713. data/docs/EmployersSearchResponse.md +0 -20
  714. data/docs/Error.md +0 -34
  715. data/docs/ExternalPaymentSchedule.md +0 -24
  716. data/docs/HealthIncident.md +0 -24
  717. data/docs/HistoricalBalance.md +0 -24
  718. data/docs/HistoricalUpdateWebhook.md +0 -26
  719. data/docs/Holding.md +0 -34
  720. data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
  721. data/docs/IdentityGetRequest.md +0 -24
  722. data/docs/IdentityGetRequestOptions.md +0 -18
  723. data/docs/IdentityGetResponse.md +0 -22
  724. data/docs/IncidentUpdate.md +0 -22
  725. data/docs/IncomeBreakdown.md +0 -24
  726. data/docs/IncomeSummary.md +0 -30
  727. data/docs/IncomeSummaryFieldNumber.md +0 -20
  728. data/docs/IncomeSummaryFieldString.md +0 -20
  729. data/docs/IncomeVerificationCreateRequest.md +0 -22
  730. data/docs/IncomeVerificationCreateResponse.md +0 -20
  731. data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
  732. data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
  733. data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
  734. data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
  735. data/docs/IncomeVerificationStatusWebhook.md +0 -24
  736. data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
  737. data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
  738. data/docs/IncomeVerificationWebhookStatus.md +0 -18
  739. data/docs/InflowModel.md +0 -26
  740. data/docs/InitialUpdateWebhook.md +0 -26
  741. data/docs/Institution.md +0 -36
  742. data/docs/InstitutionStatus.md +0 -30
  743. data/docs/InstitutionsGetByIdRequest.md +0 -26
  744. data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
  745. data/docs/InstitutionsGetByIdResponse.md +0 -20
  746. data/docs/InstitutionsGetRequest.md +0 -28
  747. data/docs/InstitutionsGetRequestOptions.md +0 -24
  748. data/docs/InstitutionsGetResponse.md +0 -22
  749. data/docs/InstitutionsSearchAccountFilter.md +0 -24
  750. data/docs/InstitutionsSearchRequest.md +0 -28
  751. data/docs/InstitutionsSearchRequestOptions.md +0 -22
  752. data/docs/InstitutionsSearchResponse.md +0 -20
  753. data/docs/InvestmentFilter.md +0 -18
  754. data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
  755. data/docs/InvestmentTransaction.md +0 -44
  756. data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
  757. data/docs/InvestmentsHoldingsGetRequest.md +0 -24
  758. data/docs/InvestmentsHoldingsGetResponse.md +0 -26
  759. data/docs/InvestmentsTransactionsGetRequest.md +0 -28
  760. data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
  761. data/docs/InvestmentsTransactionsGetResponse.md +0 -28
  762. data/docs/Item.md +0 -32
  763. data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
  764. data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
  765. data/docs/ItemErrorWebhook.md +0 -24
  766. data/docs/ItemGetRequest.md +0 -22
  767. data/docs/ItemGetResponse.md +0 -24
  768. data/docs/ItemImportRequest.md +0 -26
  769. data/docs/ItemImportRequestOptions.md +0 -18
  770. data/docs/ItemImportRequestUserAuth.md +0 -20
  771. data/docs/ItemImportResponse.md +0 -20
  772. data/docs/ItemProductReadyWebhook.md +0 -24
  773. data/docs/ItemPublicTokenCreateRequest.md +0 -22
  774. data/docs/ItemPublicTokenCreateResponse.md +0 -22
  775. data/docs/ItemPublicTokenExchangeRequest.md +0 -22
  776. data/docs/ItemPublicTokenExchangeResponse.md +0 -22
  777. data/docs/ItemRemoveRequest.md +0 -22
  778. data/docs/ItemRemoveResponse.md +0 -18
  779. data/docs/ItemStatus.md +0 -22
  780. data/docs/ItemStatusInvestments.md +0 -20
  781. data/docs/ItemStatusLastWebhook.md +0 -20
  782. data/docs/ItemStatusTransactions.md +0 -20
  783. data/docs/ItemWebhookUpdateRequest.md +0 -24
  784. data/docs/ItemWebhookUpdateResponse.md +0 -20
  785. data/docs/JWKPublicKey.md +0 -34
  786. data/docs/JWTHeader.md +0 -18
  787. data/docs/LiabilitiesGetRequest.md +0 -24
  788. data/docs/LiabilitiesGetRequestOptions.md +0 -18
  789. data/docs/LiabilitiesGetResponse.md +0 -24
  790. data/docs/LiabilitiesObject.md +0 -22
  791. data/docs/LiabilityOverride.md +0 -66
  792. data/docs/LinkTokenAccountFilters.md +0 -24
  793. data/docs/LinkTokenCreateRequest.md +0 -48
  794. data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
  795. data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
  796. data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
  797. data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
  798. data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
  799. data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
  800. data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
  801. data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
  802. data/docs/LinkTokenCreateRequestUser.md +0 -32
  803. data/docs/LinkTokenCreateResponse.md +0 -22
  804. data/docs/LinkTokenGetMetadataResponse.md +0 -30
  805. data/docs/LinkTokenGetRequest.md +0 -22
  806. data/docs/LinkTokenGetResponse.md +0 -26
  807. data/docs/LoanFilter.md +0 -18
  808. data/docs/Location.md +0 -32
  809. data/docs/MFA.md +0 -26
  810. data/docs/Meta.md +0 -22
  811. data/docs/MortgageInterestRate.md +0 -20
  812. data/docs/MortgageLiability.md +0 -56
  813. data/docs/MortgagePropertyAddress.md +0 -26
  814. data/docs/NullableAccessToken.md +0 -15
  815. data/docs/NullableAddress.md +0 -20
  816. data/docs/NullableAddressData.md +0 -26
  817. data/docs/NullableItemStatus.md +0 -22
  818. data/docs/NullableNumbersACH.md +0 -24
  819. data/docs/NullableNumbersBACS.md +0 -22
  820. data/docs/NullableNumbersEFT.md +0 -24
  821. data/docs/NullableNumbersInternational.md +0 -22
  822. data/docs/NullableRecipientBACS.md +0 -20
  823. data/docs/Numbers.md +0 -32
  824. data/docs/NumbersACH.md +0 -24
  825. data/docs/NumbersBACS.md +0 -22
  826. data/docs/NumbersEFT.md +0 -24
  827. data/docs/NumbersInternational.md +0 -22
  828. data/docs/OverrideAccounts.md +0 -38
  829. data/docs/Owner.md +0 -24
  830. data/docs/OwnerOverride.md +0 -24
  831. data/docs/PSLFStatus.md +0 -22
  832. data/docs/PayFrequency.md +0 -20
  833. data/docs/PayPeriodDetails.md +0 -26
  834. data/docs/PaymentAmount.md +0 -20
  835. data/docs/PaymentInitiationAddress.md +0 -24
  836. data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
  837. data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
  838. data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
  839. data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
  840. data/docs/PaymentInitiationPaymentListRequest.md +0 -24
  841. data/docs/PaymentInitiationPaymentListResponse.md +0 -22
  842. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
  843. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
  844. data/docs/PaymentInitiationRecipient.md +0 -26
  845. data/docs/PaymentInitiationRecipientBacs.md +0 -20
  846. data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
  847. data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
  848. data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
  849. data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
  850. data/docs/PaymentInitiationRecipientListRequest.md +0 -20
  851. data/docs/PaymentInitiationRecipientListResponse.md +0 -20
  852. data/docs/PaymentMeta.md +0 -32
  853. data/docs/PaymentStatusUpdateWebhook.md +0 -30
  854. data/docs/Paystub.md +0 -30
  855. data/docs/PaystubDeduction.md +0 -22
  856. data/docs/PaystubYTDDetails.md +0 -20
  857. data/docs/PendingExpirationWebhook.md +0 -24
  858. data/docs/PhoneNumber.md +0 -22
  859. data/docs/PlaidApi.md +0 -5580
  860. data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
  861. data/docs/ProcessorAuthGetRequest.md +0 -22
  862. data/docs/ProcessorAuthGetResponse.md +0 -22
  863. data/docs/ProcessorBalanceGetRequest.md +0 -22
  864. data/docs/ProcessorBalanceGetResponse.md +0 -20
  865. data/docs/ProcessorIdentityGetRequest.md +0 -22
  866. data/docs/ProcessorIdentityGetResponse.md +0 -20
  867. data/docs/ProcessorNumber.md +0 -24
  868. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
  869. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
  870. data/docs/ProcessorTokenCreateRequest.md +0 -26
  871. data/docs/ProcessorTokenCreateResponse.md +0 -20
  872. data/docs/ProductStatus.md +0 -22
  873. data/docs/ProductStatusBreakdown.md +0 -24
  874. data/docs/Products.md +0 -15
  875. data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
  876. data/docs/RecaptchaRequiredError.md +0 -30
  877. data/docs/RecipientBACS.md +0 -20
  878. data/docs/SandboxBankTransferSimulateRequest.md +0 -26
  879. data/docs/SandboxBankTransferSimulateResponse.md +0 -18
  880. data/docs/SandboxItemFireWebhookRequest.md +0 -24
  881. data/docs/SandboxItemFireWebhookResponse.md +0 -20
  882. data/docs/SandboxItemResetLoginRequest.md +0 -22
  883. data/docs/SandboxItemResetLoginResponse.md +0 -20
  884. data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
  885. data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
  886. data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
  887. data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
  888. data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
  889. data/docs/SandboxPublicTokenCreateRequest.md +0 -26
  890. data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
  891. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
  892. data/docs/SandboxPublicTokenCreateResponse.md +0 -20
  893. data/docs/Security.md +0 -46
  894. data/docs/ServicerAddressData.md +0 -26
  895. data/docs/StandaloneAccountType.md +0 -26
  896. data/docs/StandaloneCurrencyCodeList.md +0 -20
  897. data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
  898. data/docs/StandaloneInvestmentTransactionType.md +0 -28
  899. data/docs/StudentLoan.md +0 -66
  900. data/docs/StudentLoanRepaymentModel.md +0 -22
  901. data/docs/StudentLoanStatus.md +0 -20
  902. data/docs/StudentRepaymentPlan.md +0 -20
  903. data/docs/Transaction.md +0 -54
  904. data/docs/TransactionCode.md +0 -15
  905. data/docs/TransactionData.md +0 -26
  906. data/docs/TransactionOverride.md +0 -26
  907. data/docs/TransactionsGetRequest.md +0 -28
  908. data/docs/TransactionsGetRequestOptions.md +0 -22
  909. data/docs/TransactionsGetResponse.md +0 -26
  910. data/docs/TransactionsRefreshRequest.md +0 -22
  911. data/docs/TransactionsRefreshResponse.md +0 -18
  912. data/docs/TransactionsRemovedWebhook.md +0 -26
  913. data/docs/UserCustomPassword.md +0 -28
  914. data/docs/UserPermissionRevokedWebhook.md +0 -24
  915. data/docs/VerificationExpiredWebhook.md +0 -24
  916. data/docs/VerificationStatus.md +0 -15
  917. data/docs/Warning.md +0 -22
  918. data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
  919. data/docs/WebhookVerificationKeyGetRequest.md +0 -22
  920. data/docs/WebhookVerificationKeyGetResponse.md +0 -20
  921. data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
  922. data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
  923. data/lib/plaid/models/link_token_create_request_account_subtypes_depository.rb +0 -222
  924. data/pkg/plaid-14.0.0.beta.2.gem +0 -0
Binary file
@@ -3,10 +3,10 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.20.6
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -85,7 +85,7 @@ module Plaid
85
85
  end
86
86
 
87
87
  # Retrieve accounts
88
- # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
88
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
89
89
  # @param accounts_get_request [AccountsGetRequest]
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [AccountsGetResponse]
@@ -95,7 +95,7 @@ module Plaid
95
95
  end
96
96
 
97
97
  # Retrieve accounts
98
- # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
98
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
99
99
  # @param accounts_get_request [AccountsGetRequest]
100
100
  # @param [Hash] opts the optional parameters
101
101
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -149,6 +149,71 @@ module Plaid
149
149
  return data, status_code, headers
150
150
  end
151
151
 
152
+ # Retrieve information about a Plaid application
153
+ # Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
154
+ # @param application_get_request [ApplicationGetRequest]
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [ApplicationGetResponse]
157
+ def application_get(application_get_request, opts = {})
158
+ data, _status_code, _headers = application_get_with_http_info(application_get_request, opts)
159
+ data
160
+ end
161
+
162
+ # Retrieve information about a Plaid application
163
+ # Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
164
+ # @param application_get_request [ApplicationGetRequest]
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [Array<(ApplicationGetResponse, Integer, Hash)>] ApplicationGetResponse data, response status code and response headers
167
+ def application_get_with_http_info(application_get_request, opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug 'Calling API: PlaidApi.application_get ...'
170
+ end
171
+ # verify the required parameter 'application_get_request' is set
172
+ if @api_client.config.client_side_validation && application_get_request.nil?
173
+ fail ArgumentError, "Missing the required parameter 'application_get_request' when calling PlaidApi.application_get"
174
+ end
175
+ # resource path
176
+ local_var_path = '/application/get'
177
+
178
+ # query parameters
179
+ query_params = opts[:query_params] || {}
180
+
181
+ # header parameters
182
+ header_params = opts[:header_params] || {}
183
+ # HTTP header 'Accept' (if needed)
184
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
185
+ # HTTP header 'Content-Type'
186
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
187
+
188
+ # form parameters
189
+ form_params = opts[:form_params] || {}
190
+
191
+ # http body (model)
192
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(application_get_request)
193
+
194
+ # return_type
195
+ return_type = opts[:debug_return_type] || 'ApplicationGetResponse'
196
+
197
+ # auth_names
198
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
199
+
200
+ new_options = opts.merge(
201
+ :operation => :"PlaidApi.application_get",
202
+ :header_params => header_params,
203
+ :query_params => query_params,
204
+ :form_params => form_params,
205
+ :body => post_body,
206
+ :auth_names => auth_names,
207
+ :return_type => return_type
208
+ )
209
+
210
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "API called: PlaidApi#application_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
152
217
  # Create Asset Report Audit Copy
153
218
  # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
154
219
  # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
@@ -345,7 +410,7 @@ module Plaid
345
410
  end
346
411
 
347
412
  # Create an Asset Report
348
- # The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
413
+ # The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
349
414
  # @param asset_report_create_request [AssetReportCreateRequest]
350
415
  # @param [Hash] opts the optional parameters
351
416
  # @return [AssetReportCreateResponse]
@@ -355,7 +420,7 @@ module Plaid
355
420
  end
356
421
 
357
422
  # Create an Asset Report
358
- # The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. When the Asset Report is ready to be retrieved using &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.
423
+ # The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. When the Asset Report is ready to be retrieved using &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.
359
424
  # @param asset_report_create_request [AssetReportCreateRequest]
360
425
  # @param [Hash] opts the optional parameters
361
426
  # @return [Array<(AssetReportCreateResponse, Integer, Hash)>] AssetReportCreateResponse data, response status code and response headers
@@ -410,7 +475,7 @@ module Plaid
410
475
  end
411
476
 
412
477
  # Filter Asset Report
413
- # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select Account view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
478
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
414
479
  # @param asset_report_filter_request [AssetReportFilterRequest]
415
480
  # @param [Hash] opts the optional parameters
416
481
  # @return [AssetReportFilterResponse]
@@ -420,7 +485,7 @@ module Plaid
420
485
  end
421
486
 
422
487
  # Filter Asset Report
423
- # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select Account view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
488
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
424
489
  # @param asset_report_filter_request [AssetReportFilterRequest]
425
490
  # @param [Hash] opts the optional parameters
426
491
  # @return [Array<(AssetReportFilterResponse, Integer, Hash)>] AssetReportFilterResponse data, response status code and response headers
@@ -475,7 +540,7 @@ module Plaid
475
540
  end
476
541
 
477
542
  # Retrieve an Asset Report
478
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
543
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
479
544
  # @param asset_report_get_request [AssetReportGetRequest]
480
545
  # @param [Hash] opts the optional parameters
481
546
  # @return [AssetReportGetResponse]
@@ -485,7 +550,7 @@ module Plaid
485
550
  end
486
551
 
487
552
  # Retrieve an Asset Report
488
- # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
553
+ # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;.
489
554
  # @param asset_report_get_request [AssetReportGetRequest]
490
555
  # @param [Hash] opts the optional parameters
491
556
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -540,7 +605,7 @@ module Plaid
540
605
  end
541
606
 
542
607
  # Retrieve a PDF Asset Report
543
- # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report with Insights](https://plaid.com/documents/sample-asset-report.pdf).
608
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
544
609
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
545
610
  # @param [Hash] opts the optional parameters
546
611
  # @return [File]
@@ -550,7 +615,7 @@ module Plaid
550
615
  end
551
616
 
552
617
  # Retrieve a PDF Asset Report
553
- # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report with Insights](https://plaid.com/documents/sample-asset-report.pdf).
618
+ # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
554
619
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
555
620
  # @param [Hash] opts the optional parameters
556
621
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -735,7 +800,7 @@ module Plaid
735
800
  end
736
801
 
737
802
  # Retrieve auth data
738
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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.
803
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
739
804
  # @param auth_get_request [AuthGetRequest]
740
805
  # @param [Hash] opts the optional parameters
741
806
  # @return [AuthGetResponse]
@@ -745,7 +810,7 @@ module Plaid
745
810
  end
746
811
 
747
812
  # Retrieve auth data
748
- # The &#x60;/auth/get&#x60; endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item&#39;s checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if &#x60;auth&#x60; 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.
813
+ # The &#x60;/auth/get&#x60; endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item&#39;s checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if &#x60;auth&#x60; 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. Also note that &#x60;/auth/get&#x60; will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
749
814
  # @param auth_get_request [AuthGetRequest]
750
815
  # @param [Hash] opts the optional parameters
751
816
  # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
@@ -1449,25 +1514,29 @@ module Plaid
1449
1514
  return data, status_code, headers
1450
1515
  end
1451
1516
 
1452
- # Create a deposit switch when not using Plaid Exchange.'
1453
- # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1517
+ # Create a deposit switch without using Plaid Exchange
1518
+ # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1519
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1454
1520
  # @param [Hash] opts the optional parameters
1455
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1456
1521
  # @return [DepositSwitchAltCreateResponse]
1457
- def deposit_switch_alt_create(opts = {})
1458
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(opts)
1522
+ def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
1523
+ data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
1459
1524
  data
1460
1525
  end
1461
1526
 
1462
- # Create a deposit switch when not using Plaid Exchange.&#39;
1463
- # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1527
+ # Create a deposit switch without using Plaid Exchange
1528
+ # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1529
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1464
1530
  # @param [Hash] opts the optional parameters
1465
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1466
1531
  # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1467
- def deposit_switch_alt_create_with_http_info(opts = {})
1532
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1468
1533
  if @api_client.config.debugging
1469
1534
  @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
1470
1535
  end
1536
+ # verify the required parameter 'deposit_switch_alt_create_request' is set
1537
+ if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
1539
+ end
1471
1540
  # resource path
1472
1541
  local_var_path = '/deposit_switch/alt/create'
1473
1542
 
@@ -1485,7 +1554,7 @@ module Plaid
1485
1554
  form_params = opts[:form_params] || {}
1486
1555
 
1487
1556
  # http body (model)
1488
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'deposit_switch_alt_create_request'])
1557
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
1489
1558
 
1490
1559
  # return_type
1491
1560
  return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
@@ -1706,24 +1775,28 @@ module Plaid
1706
1775
  end
1707
1776
 
1708
1777
  # Search employer database
1709
- # `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Verification of Income product progresses through the beta period, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1778
+ # `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1779
+ # @param employers_search_request [EmployersSearchRequest]
1710
1780
  # @param [Hash] opts the optional parameters
1711
- # @option opts [EmployersSearchRequest] :employers_search_request
1712
1781
  # @return [EmployersSearchResponse]
1713
- def employers_search(opts = {})
1714
- data, _status_code, _headers = employers_search_with_http_info(opts)
1782
+ def employers_search(employers_search_request, opts = {})
1783
+ data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
1715
1784
  data
1716
1785
  end
1717
1786
 
1718
1787
  # Search employer database
1719
- # &#x60;/employers/search&#x60; allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Verification of Income product progresses through the beta period, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1788
+ # &#x60;/employers/search&#x60; allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
1789
+ # @param employers_search_request [EmployersSearchRequest]
1720
1790
  # @param [Hash] opts the optional parameters
1721
- # @option opts [EmployersSearchRequest] :employers_search_request
1722
1791
  # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
1723
- def employers_search_with_http_info(opts = {})
1792
+ def employers_search_with_http_info(employers_search_request, opts = {})
1724
1793
  if @api_client.config.debugging
1725
1794
  @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
1726
1795
  end
1796
+ # verify the required parameter 'employers_search_request' is set
1797
+ if @api_client.config.client_side_validation && employers_search_request.nil?
1798
+ fail ArgumentError, "Missing the required parameter 'employers_search_request' when calling PlaidApi.employers_search"
1799
+ end
1727
1800
  # resource path
1728
1801
  local_var_path = '/employers/search'
1729
1802
 
@@ -1741,7 +1814,7 @@ module Plaid
1741
1814
  form_params = opts[:form_params] || {}
1742
1815
 
1743
1816
  # http body (model)
1744
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'employers_search_request'])
1817
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)
1745
1818
 
1746
1819
  # return_type
1747
1820
  return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
@@ -1831,25 +1904,94 @@ module Plaid
1831
1904
  return data, status_code, headers
1832
1905
  end
1833
1906
 
1907
+ # Create an income verification instance
1908
+ # `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
1909
+ # @param income_verification_create_request [IncomeVerificationCreateRequest]
1910
+ # @param [Hash] opts the optional parameters
1911
+ # @return [IncomeVerificationCreateResponse]
1912
+ def income_verification_create(income_verification_create_request, opts = {})
1913
+ data, _status_code, _headers = income_verification_create_with_http_info(income_verification_create_request, opts)
1914
+ data
1915
+ end
1916
+
1917
+ # Create an income verification instance
1918
+ # &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an &#x60;INCOME&#x60; webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
1919
+ # @param income_verification_create_request [IncomeVerificationCreateRequest]
1920
+ # @param [Hash] opts the optional parameters
1921
+ # @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
1922
+ def income_verification_create_with_http_info(income_verification_create_request, opts = {})
1923
+ if @api_client.config.debugging
1924
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_create ...'
1925
+ end
1926
+ # verify the required parameter 'income_verification_create_request' is set
1927
+ if @api_client.config.client_side_validation && income_verification_create_request.nil?
1928
+ fail ArgumentError, "Missing the required parameter 'income_verification_create_request' when calling PlaidApi.income_verification_create"
1929
+ end
1930
+ # resource path
1931
+ local_var_path = '/income/verification/create'
1932
+
1933
+ # query parameters
1934
+ query_params = opts[:query_params] || {}
1935
+
1936
+ # header parameters
1937
+ header_params = opts[:header_params] || {}
1938
+ # HTTP header 'Accept' (if needed)
1939
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1940
+ # HTTP header 'Content-Type'
1941
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1942
+
1943
+ # form parameters
1944
+ form_params = opts[:form_params] || {}
1945
+
1946
+ # http body (model)
1947
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_create_request)
1948
+
1949
+ # return_type
1950
+ return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
1951
+
1952
+ # auth_names
1953
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1954
+
1955
+ new_options = opts.merge(
1956
+ :operation => :"PlaidApi.income_verification_create",
1957
+ :header_params => header_params,
1958
+ :query_params => query_params,
1959
+ :form_params => form_params,
1960
+ :body => post_body,
1961
+ :auth_names => auth_names,
1962
+ :return_type => return_type
1963
+ )
1964
+
1965
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1966
+ if @api_client.config.debugging
1967
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1968
+ end
1969
+ return data, status_code, headers
1970
+ end
1971
+
1834
1972
  # Download the original documents used for income verification
1835
- # `/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. In the future, when Digital Verification is available, the most recent file available for download with the payroll provider will also be available from this endpoint.
1973
+ # `/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.
1974
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1836
1975
  # @param [Hash] opts the optional parameters
1837
- # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1838
1976
  # @return [File]
1839
- def income_verification_documents_download(opts = {})
1840
- data, _status_code, _headers = income_verification_documents_download_with_http_info(opts)
1977
+ def income_verification_documents_download(income_verification_documents_download_request, opts = {})
1978
+ data, _status_code, _headers = income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts)
1841
1979
  data
1842
1980
  end
1843
1981
 
1844
1982
  # Download the original documents used for income verification
1845
- # &#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. In the future, when Digital Verification is available, the most recent file available for download with the payroll provider will also be available from this endpoint.
1983
+ # &#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.
1984
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1846
1985
  # @param [Hash] opts the optional parameters
1847
- # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1848
1986
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1849
- def income_verification_documents_download_with_http_info(opts = {})
1987
+ def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
1850
1988
  if @api_client.config.debugging
1851
1989
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
1852
1990
  end
1991
+ # verify the required parameter 'income_verification_documents_download_request' is set
1992
+ if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
1993
+ fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
1994
+ end
1853
1995
  # resource path
1854
1996
  local_var_path = '/income/verification/documents/download'
1855
1997
 
@@ -1867,7 +2009,7 @@ module Plaid
1867
2009
  form_params = opts[:form_params] || {}
1868
2010
 
1869
2011
  # http body (model)
1870
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_documents_download_request'])
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)
1871
2013
 
1872
2014
  # return_type
1873
2015
  return_type = opts[:debug_return_type] || 'File'
@@ -1892,27 +2034,96 @@ module Plaid
1892
2034
  return data, status_code, headers
1893
2035
  end
1894
2036
 
1895
- # Retrieve information from the paystub used for income verification
1896
- # `/income/verification/paystub/get` returns the information collected from the paystub that was 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.
2037
+ # Retrieve information from the paystubs used for income verification
2038
+ # `/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
+ # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
2040
+ # @param [Hash] opts the optional parameters
2041
+ # @return [IncomeVerificationPaystubsGetResponse]
2042
+ def income_verification_paystubs_get(income_verification_paystubs_get_request, opts = {})
2043
+ data, _status_code, _headers = income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts)
2044
+ data
2045
+ end
2046
+
2047
+ # Retrieve information from the paystubs used for income verification
2048
+ # &#x60;/income/verification/paystubs/get&#x60; returns the information collected from the paystubs that were used to verify an end user&#39;s income. 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.
2049
+ # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
2050
+ # @param [Hash] opts the optional parameters
2051
+ # @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
2052
+ def income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts = {})
2053
+ if @api_client.config.debugging
2054
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystubs_get ...'
2055
+ end
2056
+ # verify the required parameter 'income_verification_paystubs_get_request' is set
2057
+ if @api_client.config.client_side_validation && income_verification_paystubs_get_request.nil?
2058
+ fail ArgumentError, "Missing the required parameter 'income_verification_paystubs_get_request' when calling PlaidApi.income_verification_paystubs_get"
2059
+ end
2060
+ # resource path
2061
+ local_var_path = '/income/verification/paystubs/get'
2062
+
2063
+ # query parameters
2064
+ query_params = opts[:query_params] || {}
2065
+
2066
+ # header parameters
2067
+ header_params = opts[:header_params] || {}
2068
+ # HTTP header 'Accept' (if needed)
2069
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2070
+ # HTTP header 'Content-Type'
2071
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2072
+
2073
+ # form parameters
2074
+ form_params = opts[:form_params] || {}
2075
+
2076
+ # http body (model)
2077
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystubs_get_request)
2078
+
2079
+ # return_type
2080
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubsGetResponse'
2081
+
2082
+ # auth_names
2083
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2084
+
2085
+ new_options = opts.merge(
2086
+ :operation => :"PlaidApi.income_verification_paystubs_get",
2087
+ :header_params => header_params,
2088
+ :query_params => query_params,
2089
+ :form_params => form_params,
2090
+ :body => post_body,
2091
+ :auth_names => auth_names,
2092
+ :return_type => return_type
2093
+ )
2094
+
2095
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2096
+ if @api_client.config.debugging
2097
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystubs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2098
+ end
2099
+ return data, status_code, headers
2100
+ end
2101
+
2102
+ # Refresh an income verification
2103
+ # `/income/verification/refresh` refreshes a given income verification.
2104
+ # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
1897
2105
  # @param [Hash] opts the optional parameters
1898
- # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1899
- # @return [IncomeVerificationPaystubGetResponse]
1900
- def income_verification_paystub_get(opts = {})
1901
- data, _status_code, _headers = income_verification_paystub_get_with_http_info(opts)
2106
+ # @return [IncomeVerificationRefreshResponse]
2107
+ def income_verification_refresh(income_verification_refresh_request, opts = {})
2108
+ data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
1902
2109
  data
1903
2110
  end
1904
2111
 
1905
- # Retrieve information from the paystub used for income verification
1906
- # &#x60;/income/verification/paystub/get&#x60; returns the information collected from the paystub that was used to verify an end user&#39;s income. 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.
2112
+ # Refresh an income verification
2113
+ # &#x60;/income/verification/refresh&#x60; refreshes a given income verification.
2114
+ # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
1907
2115
  # @param [Hash] opts the optional parameters
1908
- # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1909
- # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
1910
- def income_verification_paystub_get_with_http_info(opts = {})
2116
+ # @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
2117
+ def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
1911
2118
  if @api_client.config.debugging
1912
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
2119
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
2120
+ end
2121
+ # verify the required parameter 'income_verification_refresh_request' is set
2122
+ if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
1913
2124
  end
1914
2125
  # resource path
1915
- local_var_path = '/income/verification/paystub/get'
2126
+ local_var_path = '/income/verification/refresh'
1916
2127
 
1917
2128
  # query parameters
1918
2129
  query_params = opts[:query_params] || {}
@@ -1928,16 +2139,16 @@ module Plaid
1928
2139
  form_params = opts[:form_params] || {}
1929
2140
 
1930
2141
  # http body (model)
1931
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_paystub_get_request'])
2142
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
1932
2143
 
1933
2144
  # return_type
1934
- return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
2145
+ return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
1935
2146
 
1936
2147
  # auth_names
1937
2148
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1938
2149
 
1939
2150
  new_options = opts.merge(
1940
- :operation => :"PlaidApi.income_verification_paystub_get",
2151
+ :operation => :"PlaidApi.income_verification_refresh",
1941
2152
  :header_params => header_params,
1942
2153
  :query_params => query_params,
1943
2154
  :form_params => form_params,
@@ -1948,30 +2159,34 @@ module Plaid
1948
2159
 
1949
2160
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1950
2161
  if @api_client.config.debugging
1951
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2162
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1952
2163
  end
1953
2164
  return data, status_code, headers
1954
2165
  end
1955
2166
 
1956
2167
  # Retrieve a summary of information derived from income verification
1957
2168
  # `/income/verification/summary/get` returns a verification summary for the income that was verified for an end user. 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.
2169
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
1958
2170
  # @param [Hash] opts the optional parameters
1959
- # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1960
2171
  # @return [IncomeVerificationSummaryGetResponse]
1961
- def income_verification_summary_get(opts = {})
1962
- data, _status_code, _headers = income_verification_summary_get_with_http_info(opts)
2172
+ def income_verification_summary_get(income_verification_summary_get_request, opts = {})
2173
+ data, _status_code, _headers = income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts)
1963
2174
  data
1964
2175
  end
1965
2176
 
1966
2177
  # Retrieve a summary of information derived from income verification
1967
2178
  # &#x60;/income/verification/summary/get&#x60; returns a verification summary for the income that was verified for an end user. 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.
2179
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
1968
2180
  # @param [Hash] opts the optional parameters
1969
- # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1970
2181
  # @return [Array<(IncomeVerificationSummaryGetResponse, Integer, Hash)>] IncomeVerificationSummaryGetResponse data, response status code and response headers
1971
- def income_verification_summary_get_with_http_info(opts = {})
2182
+ def income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts = {})
1972
2183
  if @api_client.config.debugging
1973
2184
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
1974
2185
  end
2186
+ # verify the required parameter 'income_verification_summary_get_request' is set
2187
+ if @api_client.config.client_side_validation && income_verification_summary_get_request.nil?
2188
+ fail ArgumentError, "Missing the required parameter 'income_verification_summary_get_request' when calling PlaidApi.income_verification_summary_get"
2189
+ end
1975
2190
  # resource path
1976
2191
  local_var_path = '/income/verification/summary/get'
1977
2192
 
@@ -1989,7 +2204,7 @@ module Plaid
1989
2204
  form_params = opts[:form_params] || {}
1990
2205
 
1991
2206
  # http body (model)
1992
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_summary_get_request'])
2207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_summary_get_request)
1993
2208
 
1994
2209
  # return_type
1995
2210
  return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
@@ -2015,7 +2230,7 @@ module Plaid
2015
2230
  end
2016
2231
 
2017
2232
  # Get details of all supported institutions
2018
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
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.
2019
2234
  # @param institutions_get_request [InstitutionsGetRequest]
2020
2235
  # @param [Hash] opts the optional parameters
2021
2236
  # @return [InstitutionsGetResponse]
@@ -2025,7 +2240,7 @@ module Plaid
2025
2240
  end
2026
2241
 
2027
2242
  # Get details of all supported institutions
2028
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
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.
2029
2244
  # @param institutions_get_request [InstitutionsGetRequest]
2030
2245
  # @param [Hash] opts the optional parameters
2031
2246
  # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
@@ -2048,7 +2263,7 @@ module Plaid
2048
2263
  # HTTP header 'Accept' (if needed)
2049
2264
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2050
2265
  # HTTP header 'Content-Type'
2051
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
2266
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2052
2267
 
2053
2268
  # form parameters
2054
2269
  form_params = opts[:form_params] || {}
@@ -2404,8 +2619,138 @@ module Plaid
2404
2619
  return data, status_code, headers
2405
2620
  end
2406
2621
 
2622
+ # List a user’s connected applications
2623
+ # List a user’s connected applications
2624
+ # @param item_application_list_request [ItemApplicationListRequest]
2625
+ # @param [Hash] opts the optional parameters
2626
+ # @return [ItemApplicationListResponse]
2627
+ def item_application_list(item_application_list_request, opts = {})
2628
+ data, _status_code, _headers = item_application_list_with_http_info(item_application_list_request, opts)
2629
+ data
2630
+ end
2631
+
2632
+ # List a user’s connected applications
2633
+ # List a user’s connected applications
2634
+ # @param item_application_list_request [ItemApplicationListRequest]
2635
+ # @param [Hash] opts the optional parameters
2636
+ # @return [Array<(ItemApplicationListResponse, Integer, Hash)>] ItemApplicationListResponse data, response status code and response headers
2637
+ def item_application_list_with_http_info(item_application_list_request, opts = {})
2638
+ if @api_client.config.debugging
2639
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_application_list ...'
2640
+ end
2641
+ # verify the required parameter 'item_application_list_request' is set
2642
+ if @api_client.config.client_side_validation && item_application_list_request.nil?
2643
+ fail ArgumentError, "Missing the required parameter 'item_application_list_request' when calling PlaidApi.item_application_list"
2644
+ end
2645
+ # resource path
2646
+ local_var_path = '/item/application/list'
2647
+
2648
+ # query parameters
2649
+ query_params = opts[:query_params] || {}
2650
+
2651
+ # header parameters
2652
+ header_params = opts[:header_params] || {}
2653
+ # HTTP header 'Accept' (if needed)
2654
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2655
+ # HTTP header 'Content-Type'
2656
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2657
+
2658
+ # form parameters
2659
+ form_params = opts[:form_params] || {}
2660
+
2661
+ # http body (model)
2662
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_list_request)
2663
+
2664
+ # return_type
2665
+ return_type = opts[:debug_return_type] || 'ItemApplicationListResponse'
2666
+
2667
+ # auth_names
2668
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2669
+
2670
+ new_options = opts.merge(
2671
+ :operation => :"PlaidApi.item_application_list",
2672
+ :header_params => header_params,
2673
+ :query_params => query_params,
2674
+ :form_params => form_params,
2675
+ :body => post_body,
2676
+ :auth_names => auth_names,
2677
+ :return_type => return_type
2678
+ )
2679
+
2680
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2681
+ if @api_client.config.debugging
2682
+ @api_client.config.logger.debug "API called: PlaidApi#item_application_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2683
+ end
2684
+ return data, status_code, headers
2685
+ end
2686
+
2687
+ # Update the scopes of access for a particular application
2688
+ # Enable consumers to update product access on selected accounts for an application.
2689
+ # @param item_application_scopes_update_request [ItemApplicationScopesUpdateRequest]
2690
+ # @param [Hash] opts the optional parameters
2691
+ # @return [ItemApplicationScopesUpdateResponse]
2692
+ def item_application_scopes_update(item_application_scopes_update_request, opts = {})
2693
+ data, _status_code, _headers = item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts)
2694
+ data
2695
+ end
2696
+
2697
+ # Update the scopes of access for a particular application
2698
+ # Enable consumers to update product access on selected accounts for an application.
2699
+ # @param item_application_scopes_update_request [ItemApplicationScopesUpdateRequest]
2700
+ # @param [Hash] opts the optional parameters
2701
+ # @return [Array<(ItemApplicationScopesUpdateResponse, Integer, Hash)>] ItemApplicationScopesUpdateResponse data, response status code and response headers
2702
+ def item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts = {})
2703
+ if @api_client.config.debugging
2704
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_application_scopes_update ...'
2705
+ end
2706
+ # verify the required parameter 'item_application_scopes_update_request' is set
2707
+ if @api_client.config.client_side_validation && item_application_scopes_update_request.nil?
2708
+ fail ArgumentError, "Missing the required parameter 'item_application_scopes_update_request' when calling PlaidApi.item_application_scopes_update"
2709
+ end
2710
+ # resource path
2711
+ local_var_path = '/item/application/scopes/update'
2712
+
2713
+ # query parameters
2714
+ query_params = opts[:query_params] || {}
2715
+
2716
+ # header parameters
2717
+ header_params = opts[:header_params] || {}
2718
+ # HTTP header 'Accept' (if needed)
2719
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2720
+ # HTTP header 'Content-Type'
2721
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2722
+
2723
+ # form parameters
2724
+ form_params = opts[:form_params] || {}
2725
+
2726
+ # http body (model)
2727
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_scopes_update_request)
2728
+
2729
+ # return_type
2730
+ return_type = opts[:debug_return_type] || 'ItemApplicationScopesUpdateResponse'
2731
+
2732
+ # auth_names
2733
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2734
+
2735
+ new_options = opts.merge(
2736
+ :operation => :"PlaidApi.item_application_scopes_update",
2737
+ :header_params => header_params,
2738
+ :query_params => query_params,
2739
+ :form_params => form_params,
2740
+ :body => post_body,
2741
+ :auth_names => auth_names,
2742
+ :return_type => return_type
2743
+ )
2744
+
2745
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2746
+ if @api_client.config.debugging
2747
+ @api_client.config.logger.debug "API called: PlaidApi#item_application_scopes_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2748
+ end
2749
+ return data, status_code, headers
2750
+ end
2751
+
2407
2752
  # Create public token
2408
- # Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](/docs/quickstart) for more information.
2753
+ # Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
2409
2754
  # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2410
2755
  # @param [Hash] opts the optional parameters
2411
2756
  # @return [ItemPublicTokenCreateResponse]
@@ -2415,7 +2760,7 @@ module Plaid
2415
2760
  end
2416
2761
 
2417
2762
  # Create public token
2418
- # Note: As of July 2020, the &#x60;/item/public_token/create&#x60; endpoint is deprecated. Instead, use &#x60;/link/token/create&#x60; with an &#x60;access_token&#x60; to create a Link token for use with [update mode](/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the &#x60;/item/public_token/create&#x60; endpoint and then initialize Link with that &#x60;public_token&#x60;. A &#x60;public_token&#x60; is one-time use and expires after 30 minutes. You use a &#x60;public_token&#x60; to initialize Link in [update mode](/docs/link/update-mode) for a particular Item. You can generate a &#x60;public_token&#x60; for an Item even if you did not use Link to create the Item originally. The &#x60;/item/public_token/create&#x60; endpoint is **not** used to create your initial &#x60;public_token&#x60;. If you have not already received an &#x60;access_token&#x60; for a specific Item, use Link to obtain your &#x60;public_token&#x60; instead. See the [Quickstart](/docs/quickstart) for more information.
2763
+ # Note: As of July 2020, the &#x60;/item/public_token/create&#x60; endpoint is deprecated. Instead, use &#x60;/link/token/create&#x60; with an &#x60;access_token&#x60; to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the &#x60;/item/public_token/create&#x60; endpoint and then initialize Link with that &#x60;public_token&#x60;. A &#x60;public_token&#x60; is one-time use and expires after 30 minutes. You use a &#x60;public_token&#x60; to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a &#x60;public_token&#x60; for an Item even if you did not use Link to create the Item originally. The &#x60;/item/public_token/create&#x60; endpoint is **not** used to create your initial &#x60;public_token&#x60;. If you have not already received an &#x60;access_token&#x60; for a specific Item, use Link to obtain your &#x60;public_token&#x60; instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
2419
2764
  # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2420
2765
  # @param [Hash] opts the optional parameters
2421
2766
  # @return [Array<(ItemPublicTokenCreateResponse, Integer, Hash)>] ItemPublicTokenCreateResponse data, response status code and response headers
@@ -2665,7 +3010,7 @@ module Plaid
2665
3010
  end
2666
3011
 
2667
3012
  # Remove an Item
2668
- # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count.
3013
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.
2669
3014
  # @param item_remove_request [ItemRemoveRequest]
2670
3015
  # @param [Hash] opts the optional parameters
2671
3016
  # @return [ItemRemoveResponse]
@@ -2675,7 +3020,7 @@ module Plaid
2675
3020
  end
2676
3021
 
2677
3022
  # Remove an Item
2678
- # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60; associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count.
3023
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60; associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager.
2679
3024
  # @param item_remove_request [ItemRemoveRequest]
2680
3025
  # @param [Hash] opts the optional parameters
2681
3026
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -2730,7 +3075,7 @@ module Plaid
2730
3075
  end
2731
3076
 
2732
3077
  # Update Webhook URL
2733
- # The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
3078
+ # The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
2734
3079
  # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2735
3080
  # @param [Hash] opts the optional parameters
2736
3081
  # @return [ItemWebhookUpdateResponse]
@@ -2740,7 +3085,7 @@ module Plaid
2740
3085
  end
2741
3086
 
2742
3087
  # Update Webhook URL
2743
- # The POST &#x60;/item/webhook/update&#x60; allows you to update the webhook URL associated with an Item. This request triggers a [&#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60;](/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
3088
+ # The POST &#x60;/item/webhook/update&#x60; allows you to update the webhook URL associated with an Item. This request triggers a [&#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60;](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
2744
3089
  # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2745
3090
  # @param [Hash] opts the optional parameters
2746
3091
  # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
@@ -2795,7 +3140,7 @@ module Plaid
2795
3140
  end
2796
3141
 
2797
3142
  # Retrieve Liabilities data
2798
- # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3143
+ # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
2799
3144
  # @param liabilities_get_request [LiabilitiesGetRequest]
2800
3145
  # @param [Hash] opts the optional parameters
2801
3146
  # @return [LiabilitiesGetResponse]
@@ -2805,7 +3150,7 @@ module Plaid
2805
3150
  end
2806
3151
 
2807
3152
  # Retrieve Liabilities data
2808
- # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filter&#x60; parameter when [creating a Link token](/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3153
+ # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
2809
3154
  # @param liabilities_get_request [LiabilitiesGetRequest]
2810
3155
  # @param [Hash] opts the optional parameters
2811
3156
  # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
@@ -2990,7 +3335,7 @@ module Plaid
2990
3335
  end
2991
3336
 
2992
3337
  # Create a payment
2993
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
3338
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
2994
3339
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
2995
3340
  # @param [Hash] opts the optional parameters
2996
3341
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -3000,7 +3345,7 @@ module Plaid
3000
3345
  end
3001
3346
 
3002
3347
  # Create a payment
3003
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
3348
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3004
3349
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3005
3350
  # @param [Hash] opts the optional parameters
3006
3351
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -3185,7 +3530,7 @@ module Plaid
3185
3530
  end
3186
3531
 
3187
3532
  # Create payment recipient
3188
- # 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`. In the Sandbox environment, you can use the `/payment_initiation/recipient/create` endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid's Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3533
+ # 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`.
3189
3534
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3190
3535
  # @param [Hash] opts the optional parameters
3191
3536
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -3195,7 +3540,7 @@ module Plaid
3195
3540
  end
3196
3541
 
3197
3542
  # Create payment recipient
3198
- # 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 &#x60;recipient_id&#x60;. In the Sandbox environment, you can use the &#x60;/payment_initiation/recipient/create&#x60; endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid&#39;s Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3543
+ # 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 &#x60;recipient_id&#x60;.
3199
3544
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3200
3545
  # @param [Hash] opts the optional parameters
3201
3546
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -3379,85 +3724,24 @@ module Plaid
3379
3724
  return data, status_code, headers
3380
3725
  end
3381
3726
 
3382
- # Create an income verification instance
3383
- # `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an `INCOME` webhook.
3727
+ # Create Apex bank account token
3728
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3729
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3384
3730
  # @param [Hash] opts the optional parameters
3385
- # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3386
- # @return [IncomeVerificationCreateResponse]
3387
- def post_income_verification_create(opts = {})
3388
- data, _status_code, _headers = post_income_verification_create_with_http_info(opts)
3731
+ # @return [ProcessorTokenCreateResponse]
3732
+ def processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {})
3733
+ data, _status_code, _headers = processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts)
3389
3734
  data
3390
3735
  end
3391
3736
 
3392
- # Create an income verification instance
3393
- # &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an &#x60;INCOME&#x60; webhook.
3737
+ # Create Apex bank account token
3738
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3739
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3394
3740
  # @param [Hash] opts the optional parameters
3395
- # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3396
- # @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
3397
- def post_income_verification_create_with_http_info(opts = {})
3741
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3742
+ def processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {})
3398
3743
  if @api_client.config.debugging
3399
- @api_client.config.logger.debug 'Calling API: PlaidApi.post_income_verification_create ...'
3400
- end
3401
- # resource path
3402
- local_var_path = '/income/verification/create'
3403
-
3404
- # query parameters
3405
- query_params = opts[:query_params] || {}
3406
-
3407
- # header parameters
3408
- header_params = opts[:header_params] || {}
3409
- # HTTP header 'Accept' (if needed)
3410
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3411
- # HTTP header 'Content-Type'
3412
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3413
-
3414
- # form parameters
3415
- form_params = opts[:form_params] || {}
3416
-
3417
- # http body (model)
3418
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_create_request'])
3419
-
3420
- # return_type
3421
- return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
3422
-
3423
- # auth_names
3424
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3425
-
3426
- new_options = opts.merge(
3427
- :operation => :"PlaidApi.post_income_verification_create",
3428
- :header_params => header_params,
3429
- :query_params => query_params,
3430
- :form_params => form_params,
3431
- :body => post_body,
3432
- :auth_names => auth_names,
3433
- :return_type => return_type
3434
- )
3435
-
3436
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3437
- if @api_client.config.debugging
3438
- @api_client.config.logger.debug "API called: PlaidApi#post_income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3439
- end
3440
- return data, status_code, headers
3441
- end
3442
-
3443
- # Create Apex bank account token
3444
- # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3445
- # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3446
- # @param [Hash] opts the optional parameters
3447
- # @return [ProcessorTokenCreateResponse]
3448
- def processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {})
3449
- data, _status_code, _headers = processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts)
3450
- data
3451
- end
3452
-
3453
- # Create Apex bank account token
3454
- # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3455
- # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3456
- # @param [Hash] opts the optional parameters
3457
- # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3458
- def processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {})
3459
- if @api_client.config.debugging
3460
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_apex_processor_token_create ...'
3744
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_apex_processor_token_create ...'
3461
3745
  end
3462
3746
  # verify the required parameter 'processor_apex_processor_token_create_request' is set
3463
3747
  if @api_client.config.client_side_validation && processor_apex_processor_token_create_request.nil?
@@ -3635,6 +3919,71 @@ module Plaid
3635
3919
  return data, status_code, headers
3636
3920
  end
3637
3921
 
3922
+ # Create a bank transfer as a processor
3923
+ # Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
3924
+ # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
3925
+ # @param [Hash] opts the optional parameters
3926
+ # @return [ProcessorBankTransferCreateResponse]
3927
+ def processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {})
3928
+ data, _status_code, _headers = processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts)
3929
+ data
3930
+ end
3931
+
3932
+ # Create a bank transfer as a processor
3933
+ # Use the &#x60;/processor/bank_transfer/create&#x60; endpoint to initiate a new bank transfer as a processor
3934
+ # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
3935
+ # @param [Hash] opts the optional parameters
3936
+ # @return [Array<(ProcessorBankTransferCreateResponse, Integer, Hash)>] ProcessorBankTransferCreateResponse data, response status code and response headers
3937
+ def processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {})
3938
+ if @api_client.config.debugging
3939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_bank_transfer_create ...'
3940
+ end
3941
+ # verify the required parameter 'processor_bank_transfer_create_request' is set
3942
+ if @api_client.config.client_side_validation && processor_bank_transfer_create_request.nil?
3943
+ fail ArgumentError, "Missing the required parameter 'processor_bank_transfer_create_request' when calling PlaidApi.processor_bank_transfer_create"
3944
+ end
3945
+ # resource path
3946
+ local_var_path = '/processor/bank_transfer/create'
3947
+
3948
+ # query parameters
3949
+ query_params = opts[:query_params] || {}
3950
+
3951
+ # header parameters
3952
+ header_params = opts[:header_params] || {}
3953
+ # HTTP header 'Accept' (if needed)
3954
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3955
+ # HTTP header 'Content-Type'
3956
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3957
+
3958
+ # form parameters
3959
+ form_params = opts[:form_params] || {}
3960
+
3961
+ # http body (model)
3962
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_bank_transfer_create_request)
3963
+
3964
+ # return_type
3965
+ return_type = opts[:debug_return_type] || 'ProcessorBankTransferCreateResponse'
3966
+
3967
+ # auth_names
3968
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3969
+
3970
+ new_options = opts.merge(
3971
+ :operation => :"PlaidApi.processor_bank_transfer_create",
3972
+ :header_params => header_params,
3973
+ :query_params => query_params,
3974
+ :form_params => form_params,
3975
+ :body => post_body,
3976
+ :auth_names => auth_names,
3977
+ :return_type => return_type
3978
+ )
3979
+
3980
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3981
+ if @api_client.config.debugging
3982
+ @api_client.config.logger.debug "API called: PlaidApi#processor_bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3983
+ end
3984
+ return data, status_code, headers
3985
+ end
3986
+
3638
3987
  # Retrieve Identity data
3639
3988
  # The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
3640
3989
  # @param processor_identity_get_request [ProcessorIdentityGetRequest]
@@ -3701,7 +4050,7 @@ module Plaid
3701
4050
  end
3702
4051
 
3703
4052
  # Create Stripe bank account token
3704
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
4053
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
3705
4054
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3706
4055
  # @param [Hash] opts the optional parameters
3707
4056
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -3711,7 +4060,7 @@ module Plaid
3711
4060
  end
3712
4061
 
3713
4062
  # Create Stripe bank account token
3714
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
4063
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
3715
4064
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3716
4065
  # @param [Hash] opts the optional parameters
3717
4066
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -3830,6 +4179,71 @@ module Plaid
3830
4179
  return data, status_code, headers
3831
4180
  end
3832
4181
 
4182
+ # Manually fire a Bank Transfer webhook
4183
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
4184
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
4185
+ # @param [Hash] opts the optional parameters
4186
+ # @return [SandboxBankTransferFireWebhookResponse]
4187
+ def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
4188
+ data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
4189
+ data
4190
+ end
4191
+
4192
+ # Manually fire a Bank Transfer webhook
4193
+ # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
4194
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
4195
+ # @param [Hash] opts the optional parameters
4196
+ # @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
4197
+ def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
4198
+ if @api_client.config.debugging
4199
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
4200
+ end
4201
+ # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
4202
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
4203
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
4204
+ end
4205
+ # resource path
4206
+ local_var_path = '/sandbox/bank_transfer/fire_webhook'
4207
+
4208
+ # query parameters
4209
+ query_params = opts[:query_params] || {}
4210
+
4211
+ # header parameters
4212
+ header_params = opts[:header_params] || {}
4213
+ # HTTP header 'Accept' (if needed)
4214
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4215
+ # HTTP header 'Content-Type'
4216
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4217
+
4218
+ # form parameters
4219
+ form_params = opts[:form_params] || {}
4220
+
4221
+ # http body (model)
4222
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_fire_webhook_request)
4223
+
4224
+ # return_type
4225
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
4226
+
4227
+ # auth_names
4228
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4229
+
4230
+ new_options = opts.merge(
4231
+ :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
4232
+ :header_params => header_params,
4233
+ :query_params => query_params,
4234
+ :form_params => form_params,
4235
+ :body => post_body,
4236
+ :auth_names => auth_names,
4237
+ :return_type => return_type
4238
+ )
4239
+
4240
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4241
+ if @api_client.config.debugging
4242
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4243
+ end
4244
+ return data, status_code, headers
4245
+ end
4246
+
3833
4247
  # Simulate a bank transfer event in Sandbox
3834
4248
  # Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
3835
4249
  # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
@@ -3895,6 +4309,71 @@ module Plaid
3895
4309
  return data, status_code, headers
3896
4310
  end
3897
4311
 
4312
+ # Manually fire an Income webhook
4313
+ # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
4314
+ # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
4315
+ # @param [Hash] opts the optional parameters
4316
+ # @return [SandboxIncomeFireWebhookResponse]
4317
+ def sandbox_income_fire_webhook(sandbox_income_fire_webhook_request, opts = {})
4318
+ data, _status_code, _headers = sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts)
4319
+ data
4320
+ end
4321
+
4322
+ # Manually fire an Income webhook
4323
+ # Use the &#x60;/sandbox/income/fire_webhook&#x60; endpoint to manually trigger an Income webhook in the Sandbox environment.
4324
+ # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
4325
+ # @param [Hash] opts the optional parameters
4326
+ # @return [Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>] SandboxIncomeFireWebhookResponse data, response status code and response headers
4327
+ def sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts = {})
4328
+ if @api_client.config.debugging
4329
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_income_fire_webhook ...'
4330
+ end
4331
+ # verify the required parameter 'sandbox_income_fire_webhook_request' is set
4332
+ if @api_client.config.client_side_validation && sandbox_income_fire_webhook_request.nil?
4333
+ fail ArgumentError, "Missing the required parameter 'sandbox_income_fire_webhook_request' when calling PlaidApi.sandbox_income_fire_webhook"
4334
+ end
4335
+ # resource path
4336
+ local_var_path = '/sandbox/income/fire_webhook'
4337
+
4338
+ # query parameters
4339
+ query_params = opts[:query_params] || {}
4340
+
4341
+ # header parameters
4342
+ header_params = opts[:header_params] || {}
4343
+ # HTTP header 'Accept' (if needed)
4344
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4345
+ # HTTP header 'Content-Type'
4346
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4347
+
4348
+ # form parameters
4349
+ form_params = opts[:form_params] || {}
4350
+
4351
+ # http body (model)
4352
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_income_fire_webhook_request)
4353
+
4354
+ # return_type
4355
+ return_type = opts[:debug_return_type] || 'SandboxIncomeFireWebhookResponse'
4356
+
4357
+ # auth_names
4358
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4359
+
4360
+ new_options = opts.merge(
4361
+ :operation => :"PlaidApi.sandbox_income_fire_webhook",
4362
+ :header_params => header_params,
4363
+ :query_params => query_params,
4364
+ :form_params => form_params,
4365
+ :body => post_body,
4366
+ :auth_names => auth_names,
4367
+ :return_type => return_type
4368
+ )
4369
+
4370
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4371
+ if @api_client.config.debugging
4372
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4373
+ end
4374
+ return data, status_code, headers
4375
+ end
4376
+
3898
4377
  # Fire a test webhook
3899
4378
  # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.
3900
4379
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
@@ -3961,7 +4440,7 @@ module Plaid
3961
4440
  end
3962
4441
 
3963
4442
  # Force a Sandbox Item into an error state
3964
- # `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
4443
+ # `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
3965
4444
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
3966
4445
  # @param [Hash] opts the optional parameters
3967
4446
  # @return [SandboxItemResetLoginResponse]
@@ -3971,7 +4450,7 @@ module Plaid
3971
4450
  end
3972
4451
 
3973
4452
  # Force a Sandbox Item into an error state
3974
- # &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
4453
+ # &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
3975
4454
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
3976
4455
  # @param [Hash] opts the optional parameters
3977
4456
  # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
@@ -4026,7 +4505,7 @@ module Plaid
4026
4505
  end
4027
4506
 
4028
4507
  # Set verification status for Sandbox account
4029
- # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](/docs/auth/coverage/testing#).
4508
+ # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
4030
4509
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4031
4510
  # @param [Hash] opts the optional parameters
4032
4511
  # @return [SandboxItemSetVerificationStatusResponse]
@@ -4036,7 +4515,7 @@ module Plaid
4036
4515
  end
4037
4516
 
4038
4517
  # Set verification status for Sandbox account
4039
- # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](/docs/auth/coverage/testing#).
4518
+ # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
4040
4519
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4041
4520
  # @param [Hash] opts the optional parameters
4042
4521
  # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
@@ -4090,25 +4569,92 @@ module Plaid
4090
4569
  return data, status_code, headers
4091
4570
  end
4092
4571
 
4572
+ # Save the selected accounts when connecting to the Platypus Oauth institution
4573
+ # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
4574
+ # @param [Hash] opts the optional parameters
4575
+ # @return [Object]
4576
+ def sandbox_oauth_select_accounts(sandbox_oauth_select_accounts_request, opts = {})
4577
+ data, _status_code, _headers = sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts)
4578
+ data
4579
+ end
4580
+
4581
+ # Save the selected accounts when connecting to the Platypus Oauth institution
4582
+ # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
4583
+ # @param [Hash] opts the optional parameters
4584
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
4585
+ def sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts = {})
4586
+ if @api_client.config.debugging
4587
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_oauth_select_accounts ...'
4588
+ end
4589
+ # verify the required parameter 'sandbox_oauth_select_accounts_request' is set
4590
+ if @api_client.config.client_side_validation && sandbox_oauth_select_accounts_request.nil?
4591
+ fail ArgumentError, "Missing the required parameter 'sandbox_oauth_select_accounts_request' when calling PlaidApi.sandbox_oauth_select_accounts"
4592
+ end
4593
+ # resource path
4594
+ local_var_path = '/sandbox/oauth/select_accounts'
4595
+
4596
+ # query parameters
4597
+ query_params = opts[:query_params] || {}
4598
+
4599
+ # header parameters
4600
+ header_params = opts[:header_params] || {}
4601
+ # HTTP header 'Accept' (if needed)
4602
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4603
+ # HTTP header 'Content-Type'
4604
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4605
+
4606
+ # form parameters
4607
+ form_params = opts[:form_params] || {}
4608
+
4609
+ # http body (model)
4610
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_oauth_select_accounts_request)
4611
+
4612
+ # return_type
4613
+ return_type = opts[:debug_return_type] || 'Object'
4614
+
4615
+ # auth_names
4616
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4617
+
4618
+ new_options = opts.merge(
4619
+ :operation => :"PlaidApi.sandbox_oauth_select_accounts",
4620
+ :header_params => header_params,
4621
+ :query_params => query_params,
4622
+ :form_params => form_params,
4623
+ :body => post_body,
4624
+ :auth_names => auth_names,
4625
+ :return_type => return_type
4626
+ )
4627
+
4628
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4629
+ if @api_client.config.debugging
4630
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_oauth_select_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4631
+ end
4632
+ return data, status_code, headers
4633
+ end
4634
+
4093
4635
  # Create a test Item and processor token
4094
- # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4636
+ # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
4637
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4095
4638
  # @param [Hash] opts the optional parameters
4096
- # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4097
4639
  # @return [SandboxProcessorTokenCreateResponse]
4098
- def sandbox_processor_token_create(opts = {})
4099
- data, _status_code, _headers = sandbox_processor_token_create_with_http_info(opts)
4640
+ def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
4641
+ data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
4100
4642
  data
4101
4643
  end
4102
4644
 
4103
4645
  # Create a test Item and processor token
4104
- # Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4646
+ # Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
4647
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4105
4648
  # @param [Hash] opts the optional parameters
4106
- # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4107
4649
  # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
4108
- def sandbox_processor_token_create_with_http_info(opts = {})
4650
+ def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
4109
4651
  if @api_client.config.debugging
4110
4652
  @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
4111
4653
  end
4654
+ # verify the required parameter 'sandbox_processor_token_create_request' is set
4655
+ if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
4656
+ fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
4657
+ end
4112
4658
  # resource path
4113
4659
  local_var_path = '/sandbox/processor_token/create'
4114
4660
 
@@ -4126,7 +4672,7 @@ module Plaid
4126
4672
  form_params = opts[:form_params] || {}
4127
4673
 
4128
4674
  # http body (model)
4129
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sandbox_processor_token_create_request'])
4675
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)
4130
4676
 
4131
4677
  # return_type
4132
4678
  return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
@@ -4152,7 +4698,7 @@ module Plaid
4152
4698
  end
4153
4699
 
4154
4700
  # Create a test Item
4155
- # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4701
+ # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
4156
4702
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4157
4703
  # @param [Hash] opts the optional parameters
4158
4704
  # @return [SandboxPublicTokenCreateResponse]
@@ -4162,7 +4708,7 @@ module Plaid
4162
4708
  end
4163
4709
 
4164
4710
  # Create a test Item
4165
- # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](/docs/sandbox/user-custom) to generate a test account with custom data.
4711
+ # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
4166
4712
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4167
4713
  # @param [Hash] opts the optional parameters
4168
4714
  # @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
@@ -4216,8 +4762,203 @@ module Plaid
4216
4762
  return data, status_code, headers
4217
4763
  end
4218
4764
 
4765
+ # Report whether you initiated an ACH transaction
4766
+ # 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
+ # @param signal_decision_report_request [SignalDecisionReportRequest]
4768
+ # @param [Hash] opts the optional parameters
4769
+ # @return [SignalDecisionReportResponse]
4770
+ def signal_decision_report(signal_decision_report_request, opts = {})
4771
+ data, _status_code, _headers = signal_decision_report_with_http_info(signal_decision_report_request, opts)
4772
+ data
4773
+ end
4774
+
4775
+ # Report whether you initiated an ACH transaction
4776
+ # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an &#x60;INVALID_REQUEST&#x60; error if called a second time with a different value for &#x60;initiated&#x60;.
4777
+ # @param signal_decision_report_request [SignalDecisionReportRequest]
4778
+ # @param [Hash] opts the optional parameters
4779
+ # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
4780
+ def signal_decision_report_with_http_info(signal_decision_report_request, opts = {})
4781
+ if @api_client.config.debugging
4782
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_decision_report ...'
4783
+ end
4784
+ # verify the required parameter 'signal_decision_report_request' is set
4785
+ if @api_client.config.client_side_validation && signal_decision_report_request.nil?
4786
+ fail ArgumentError, "Missing the required parameter 'signal_decision_report_request' when calling PlaidApi.signal_decision_report"
4787
+ end
4788
+ # resource path
4789
+ local_var_path = '/signal/decision/report'
4790
+
4791
+ # query parameters
4792
+ query_params = opts[:query_params] || {}
4793
+
4794
+ # header parameters
4795
+ header_params = opts[:header_params] || {}
4796
+ # HTTP header 'Accept' (if needed)
4797
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4798
+ # HTTP header 'Content-Type'
4799
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4800
+
4801
+ # form parameters
4802
+ form_params = opts[:form_params] || {}
4803
+
4804
+ # http body (model)
4805
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_decision_report_request)
4806
+
4807
+ # return_type
4808
+ return_type = opts[:debug_return_type] || 'SignalDecisionReportResponse'
4809
+
4810
+ # auth_names
4811
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4812
+
4813
+ new_options = opts.merge(
4814
+ :operation => :"PlaidApi.signal_decision_report",
4815
+ :header_params => header_params,
4816
+ :query_params => query_params,
4817
+ :form_params => form_params,
4818
+ :body => post_body,
4819
+ :auth_names => auth_names,
4820
+ :return_type => return_type
4821
+ )
4822
+
4823
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4824
+ if @api_client.config.debugging
4825
+ @api_client.config.logger.debug "API called: PlaidApi#signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4826
+ end
4827
+ return data, status_code, headers
4828
+ end
4829
+
4830
+ # Evaluate a planned ACH transaction
4831
+ # 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.
4832
+ # @param request_body [Hash<String, Object>]
4833
+ # @param [Hash] opts the optional parameters
4834
+ # @return [SignalEvaluateResponse]
4835
+ def signal_evaluate(request_body, opts = {})
4836
+ data, _status_code, _headers = signal_evaluate_with_http_info(request_body, opts)
4837
+ data
4838
+ end
4839
+
4840
+ # Evaluate a planned ACH transaction
4841
+ # 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.
4842
+ # @param request_body [Hash<String, Object>]
4843
+ # @param [Hash] opts the optional parameters
4844
+ # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
4845
+ def signal_evaluate_with_http_info(request_body, opts = {})
4846
+ if @api_client.config.debugging
4847
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
4848
+ end
4849
+ # verify the required parameter 'request_body' is set
4850
+ if @api_client.config.client_side_validation && request_body.nil?
4851
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.signal_evaluate"
4852
+ end
4853
+ # resource path
4854
+ local_var_path = '/signal/evaluate'
4855
+
4856
+ # query parameters
4857
+ query_params = opts[:query_params] || {}
4858
+
4859
+ # header parameters
4860
+ header_params = opts[:header_params] || {}
4861
+ # HTTP header 'Accept' (if needed)
4862
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4863
+ # HTTP header 'Content-Type'
4864
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4865
+
4866
+ # form parameters
4867
+ form_params = opts[:form_params] || {}
4868
+
4869
+ # http body (model)
4870
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
4871
+
4872
+ # return_type
4873
+ return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
4874
+
4875
+ # auth_names
4876
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4877
+
4878
+ new_options = opts.merge(
4879
+ :operation => :"PlaidApi.signal_evaluate",
4880
+ :header_params => header_params,
4881
+ :query_params => query_params,
4882
+ :form_params => form_params,
4883
+ :body => post_body,
4884
+ :auth_names => auth_names,
4885
+ :return_type => return_type
4886
+ )
4887
+
4888
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4889
+ if @api_client.config.debugging
4890
+ @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4891
+ end
4892
+ return data, status_code, headers
4893
+ end
4894
+
4895
+ # Report a return for an ACH transaction
4896
+ # 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.
4897
+ # @param signal_return_report_request [SignalReturnReportRequest]
4898
+ # @param [Hash] opts the optional parameters
4899
+ # @return [SignalReturnReportResponse]
4900
+ def signal_return_report(signal_return_report_request, opts = {})
4901
+ data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
4902
+ data
4903
+ end
4904
+
4905
+ # Report a return for an ACH transaction
4906
+ # 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.
4907
+ # @param signal_return_report_request [SignalReturnReportRequest]
4908
+ # @param [Hash] opts the optional parameters
4909
+ # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
4910
+ def signal_return_report_with_http_info(signal_return_report_request, opts = {})
4911
+ if @api_client.config.debugging
4912
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
4913
+ end
4914
+ # verify the required parameter 'signal_return_report_request' is set
4915
+ if @api_client.config.client_side_validation && signal_return_report_request.nil?
4916
+ fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
4917
+ end
4918
+ # resource path
4919
+ local_var_path = '/signal/return/report'
4920
+
4921
+ # query parameters
4922
+ query_params = opts[:query_params] || {}
4923
+
4924
+ # header parameters
4925
+ header_params = opts[:header_params] || {}
4926
+ # HTTP header 'Accept' (if needed)
4927
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4928
+ # HTTP header 'Content-Type'
4929
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4930
+
4931
+ # form parameters
4932
+ form_params = opts[:form_params] || {}
4933
+
4934
+ # http body (model)
4935
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
4936
+
4937
+ # return_type
4938
+ return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
4939
+
4940
+ # auth_names
4941
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4942
+
4943
+ new_options = opts.merge(
4944
+ :operation => :"PlaidApi.signal_return_report",
4945
+ :header_params => header_params,
4946
+ :query_params => query_params,
4947
+ :form_params => form_params,
4948
+ :body => post_body,
4949
+ :auth_names => auth_names,
4950
+ :return_type => return_type
4951
+ )
4952
+
4953
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4954
+ if @api_client.config.debugging
4955
+ @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4956
+ end
4957
+ return data, status_code, headers
4958
+ end
4959
+
4219
4960
  # Get transaction data
4220
- # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
4961
+ # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
4221
4962
  # @param transactions_get_request [TransactionsGetRequest]
4222
4963
  # @param [Hash] opts the optional parameters
4223
4964
  # @return [TransactionsGetResponse]
@@ -4227,7 +4968,7 @@ module Plaid
4227
4968
  end
4228
4969
 
4229
4970
  # Get transaction data
4230
- # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the &#x60;/liabilities/get&#x60; endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
4971
+ # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
4231
4972
  # @param transactions_get_request [TransactionsGetRequest]
4232
4973
  # @param [Hash] opts the optional parameters
4233
4974
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -4282,7 +5023,7 @@ module Plaid
4282
5023
  end
4283
5024
 
4284
5025
  # Refresh transaction data
4285
- # `/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`](/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](/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.
5026
+ # `/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.
4286
5027
  # @param transactions_refresh_request [TransactionsRefreshRequest]
4287
5028
  # @param [Hash] opts the optional parameters
4288
5029
  # @return [TransactionsRefreshResponse]
@@ -4292,7 +5033,7 @@ module Plaid
4292
5033
  end
4293
5034
 
4294
5035
  # Refresh transaction data
4295
- # &#x60;/transactions/refresh&#x60; 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 &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: [&#x60;TRANSACTIONS_REMOVED&#x60;](/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
5036
+ # &#x60;/transactions/refresh&#x60; 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 &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](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 &#x60;/transactions/get&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
4296
5037
  # @param transactions_refresh_request [TransactionsRefreshRequest]
4297
5038
  # @param [Hash] opts the optional parameters
4298
5039
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers