plaid 13.2.0 → 14.0.0.beta.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (611) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +82 -8
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +43 -34
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +2 -0
  8. data/PUBLISH.md +6 -7
  9. data/README.md +99 -93
  10. data/Rakefile +8 -79
  11. data/UPGRADING.md +4 -0
  12. data/doc/rdoc/apple-touch-icon.png +0 -0
  13. data/doc/rdoc/classes/Object.html +118 -0
  14. data/doc/rdoc/classes/Plaid.html +772 -0
  15. data/doc/rdoc/classes/Plaid/APIError.html +97 -0
  16. data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
  17. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
  18. data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
  19. data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
  20. data/doc/rdoc/classes/Plaid/Apex.html +149 -0
  21. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
  22. data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
  23. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
  24. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
  25. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
  26. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
  27. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
  28. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
  29. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
  30. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
  31. data/doc/rdoc/classes/Plaid/Auth.html +206 -0
  32. data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
  33. data/doc/rdoc/classes/Plaid/Balance.html +206 -0
  34. data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
  35. data/doc/rdoc/classes/Plaid/Categories.html +191 -0
  36. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
  37. data/doc/rdoc/classes/Plaid/Client.html +802 -0
  38. data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
  39. data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
  40. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
  41. data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
  42. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
  43. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
  44. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
  45. data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
  46. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
  47. data/doc/rdoc/classes/Plaid/Error.html +214 -0
  48. data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
  49. data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
  50. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
  51. data/doc/rdoc/classes/Plaid/Identity.html +199 -0
  52. data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
  53. data/doc/rdoc/classes/Plaid/Income.html +198 -0
  54. data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
  55. data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
  56. data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
  57. data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
  58. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
  59. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
  60. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
  61. data/doc/rdoc/classes/Plaid/Investments.html +204 -0
  62. data/doc/rdoc/classes/Plaid/Item.html +382 -0
  63. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
  64. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
  65. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
  66. data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
  67. data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
  68. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
  69. data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
  70. data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
  71. data/doc/rdoc/classes/Plaid/Models.html +506 -0
  72. data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
  73. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
  74. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
  77. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
  78. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
  79. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
  80. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
  81. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
  82. data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
  83. data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
  84. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
  85. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
  86. data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
  87. data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
  88. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
  89. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
  90. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
  91. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
  92. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
  93. data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
  94. data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
  95. data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
  96. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
  97. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
  98. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
  99. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
  100. data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
  101. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
  102. data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
  103. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
  104. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
  105. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
  106. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
  107. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
  108. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
  109. data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
  110. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
  111. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
  112. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
  113. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
  114. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
  115. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
  116. data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
  117. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
  118. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
  119. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
  120. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
  121. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
  122. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
  123. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
  124. data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
  125. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
  126. data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
  127. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
  128. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
  129. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
  130. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
  131. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
  132. data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
  133. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
  134. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
  135. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
  136. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
  137. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
  138. data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
  139. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
  140. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
  141. data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
  142. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
  143. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
  144. data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
  145. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
  146. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
  147. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
  148. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
  149. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
  150. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
  151. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
  152. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
  153. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
  154. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
  155. data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
  156. data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
  157. data/doc/rdoc/classes/Plaid/Processor.html +143 -0
  158. data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
  159. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
  160. data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
  161. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
  162. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
  163. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
  164. data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
  165. data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
  166. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
  167. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
  168. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
  169. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
  170. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
  171. data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
  172. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
  173. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
  174. data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
  175. data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
  176. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
  177. data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
  178. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
  179. data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
  180. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
  181. data/doc/rdoc/created.rid +28 -0
  182. data/doc/rdoc/css/github.css +123 -0
  183. data/doc/rdoc/css/main.css +333 -0
  184. data/doc/rdoc/css/panel.css +383 -0
  185. data/doc/rdoc/css/reset.css +48 -0
  186. data/doc/rdoc/favicon.ico +0 -0
  187. data/doc/rdoc/files/LICENSE_txt.html +98 -0
  188. data/doc/rdoc/files/README_md.html +388 -0
  189. data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
  190. data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
  191. data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
  192. data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
  193. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
  194. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
  195. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
  196. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
  197. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
  198. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
  199. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
  200. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
  201. data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
  202. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
  203. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
  204. data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
  205. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
  206. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
  207. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
  208. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
  209. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
  210. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
  211. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
  212. data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
  213. data/doc/rdoc/files/lib/plaid_rb.html +120 -0
  214. data/doc/rdoc/i/arrows.png +0 -0
  215. data/doc/rdoc/i/results_bg.png +0 -0
  216. data/doc/rdoc/i/tree_bg.png +0 -0
  217. data/doc/rdoc/index.html +13 -0
  218. data/doc/rdoc/js/highlight.pack.js +1 -0
  219. data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
  220. data/doc/rdoc/js/main.js +29 -0
  221. data/doc/rdoc/js/navigation.js +142 -0
  222. data/doc/rdoc/js/navigation.js.gz +0 -0
  223. data/doc/rdoc/js/search_index.js +1 -0
  224. data/doc/rdoc/js/search_index.js.gz +0 -0
  225. data/doc/rdoc/js/searchdoc.js +468 -0
  226. data/doc/rdoc/js/searcher.js +229 -0
  227. data/doc/rdoc/js/searcher.js.gz +0 -0
  228. data/doc/rdoc/panel/index.html +74 -0
  229. data/doc/rdoc/panel/links.html +60 -0
  230. data/doc/rdoc/panel/tree.js +1 -0
  231. data/lib/plaid.rb +352 -61
  232. data/lib/plaid/api/plaid_api.rb +4572 -0
  233. data/lib/plaid/api_client.rb +383 -0
  234. data/lib/plaid/api_error.rb +57 -0
  235. data/lib/plaid/configuration.rb +297 -0
  236. data/lib/plaid/models/account_assets.rb +406 -0
  237. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  238. data/lib/plaid/models/account_balance.rb +280 -0
  239. data/lib/plaid/models/account_base.rb +345 -0
  240. data/lib/plaid/models/account_filters_response.rb +246 -0
  241. data/lib/plaid/models/account_identity.rb +369 -0
  242. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  243. data/lib/plaid/models/account_subtype.rb +102 -0
  244. data/lib/plaid/models/account_type.rb +41 -0
  245. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  246. data/lib/plaid/models/accounts_balance_get_request_options.rb +232 -0
  247. data/lib/plaid/models/accounts_get_request.rb +254 -0
  248. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  249. data/lib/plaid/models/accounts_get_response.rb +256 -0
  250. data/lib/plaid/models/ach_class.rb +50 -0
  251. data/lib/plaid/models/address.rb +235 -0
  252. data/lib/plaid/models/address_data.rb +277 -0
  253. data/lib/plaid/models/application.rb +273 -0
  254. data/lib/plaid/models/application_get_request.rb +255 -0
  255. data/lib/plaid/models/application_get_response.rb +239 -0
  256. data/lib/plaid/models/apr.rb +296 -0
  257. data/lib/plaid/models/asset_report.rb +301 -0
  258. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  259. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  260. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  261. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  262. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  263. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  264. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  265. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  266. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  267. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  268. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  269. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  270. data/lib/plaid/models/asset_report_item.rb +287 -0
  271. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  272. data/lib/plaid/models/asset_report_refresh_request.rb +290 -0
  273. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  274. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  275. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  276. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  277. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  278. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  279. data/lib/plaid/models/asset_report_user.rb +287 -0
  280. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  281. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  282. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  283. data/lib/plaid/models/auth_get_request.rb +254 -0
  284. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  285. data/lib/plaid/models/auth_get_response.rb +270 -0
  286. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  287. data/lib/plaid/models/bank_transfer.rb +453 -0
  288. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  289. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  290. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  291. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  292. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  293. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  294. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  295. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  296. data/lib/plaid/models/bank_transfer_event.rb +390 -0
  297. data/lib/plaid/models/bank_transfer_event_list_request.rb +422 -0
  298. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  299. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  300. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  301. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  302. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  303. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  304. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  305. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  306. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  307. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  308. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  309. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  310. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  311. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  312. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  313. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  314. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  315. data/lib/plaid/models/categories_get_response.rb +242 -0
  316. data/lib/plaid/models/category.rb +257 -0
  317. data/lib/plaid/models/cause.rb +235 -0
  318. data/lib/plaid/models/country_code.rb +42 -0
  319. data/lib/plaid/models/credit_card_liability.rb +324 -0
  320. data/lib/plaid/models/credit_filter.rb +227 -0
  321. data/lib/plaid/models/default_update_webhook.rb +280 -0
  322. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  323. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  324. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  325. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  326. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  327. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  328. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  329. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  330. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  331. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  332. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  333. data/lib/plaid/models/depository_filter.rb +227 -0
  334. data/lib/plaid/models/email.rb +289 -0
  335. data/lib/plaid/models/employee.rb +242 -0
  336. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  337. data/lib/plaid/models/employer.rb +261 -0
  338. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  339. data/lib/plaid/models/employers_search_request.rb +262 -0
  340. data/lib/plaid/models/employers_search_response.rb +242 -0
  341. data/lib/plaid/models/error.rb +360 -0
  342. data/lib/plaid/models/external_payment_options.rb +242 -0
  343. data/lib/plaid/models/external_payment_refund_details.rb +240 -0
  344. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  345. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  346. data/lib/plaid/models/health_incident.rb +253 -0
  347. data/lib/plaid/models/historical_balance.rb +262 -0
  348. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  349. data/lib/plaid/models/holding.rb +329 -0
  350. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  351. data/lib/plaid/models/identity_get_request.rb +254 -0
  352. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  353. data/lib/plaid/models/identity_get_response.rb +256 -0
  354. data/lib/plaid/models/incident_update.rb +273 -0
  355. data/lib/plaid/models/income_breakdown.rb +253 -0
  356. data/lib/plaid/models/income_summary.rb +275 -0
  357. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  358. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  359. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  360. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  361. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  362. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  363. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  364. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  365. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  366. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  367. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  368. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  369. data/lib/plaid/models/inflow_model.rb +285 -0
  370. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  371. data/lib/plaid/models/institution.rb +354 -0
  372. data/lib/plaid/models/institution_status.rb +307 -0
  373. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  374. data/lib/plaid/models/institutions_get_by_id_request_options.rb +246 -0
  375. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  376. data/lib/plaid/models/institutions_get_request.rb +328 -0
  377. data/lib/plaid/models/institutions_get_request_options.rb +266 -0
  378. data/lib/plaid/models/institutions_get_response.rb +257 -0
  379. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  380. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +220 -0
  381. data/lib/plaid/models/institutions_search_request.rb +309 -0
  382. data/lib/plaid/models/institutions_search_request_options.rb +252 -0
  383. data/lib/plaid/models/institutions_search_response.rb +242 -0
  384. data/lib/plaid/models/investment_filter.rb +227 -0
  385. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  386. data/lib/plaid/models/investment_transaction.rb +446 -0
  387. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  388. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  389. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  390. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  391. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  392. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  393. data/lib/plaid/models/item.rb +351 -0
  394. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  395. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  396. data/lib/plaid/models/item_error_webhook.rb +265 -0
  397. data/lib/plaid/models/item_get_request.rb +245 -0
  398. data/lib/plaid/models/item_get_response.rb +249 -0
  399. data/lib/plaid/models/item_import_request.rb +291 -0
  400. data/lib/plaid/models/item_import_request_options.rb +220 -0
  401. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  402. data/lib/plaid/models/item_import_response.rb +240 -0
  403. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  404. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  405. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  406. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  407. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  408. data/lib/plaid/models/item_remove_request.rb +245 -0
  409. data/lib/plaid/models/item_remove_response.rb +225 -0
  410. data/lib/plaid/models/item_status.rb +249 -0
  411. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  412. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  413. data/lib/plaid/models/jwk_public_key.rb +339 -0
  414. data/lib/plaid/models/jwt_header.rb +224 -0
  415. data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
  416. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  417. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  418. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  419. data/lib/plaid/models/liabilities_object.rb +249 -0
  420. data/lib/plaid/models/liability_override.rb +566 -0
  421. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  422. data/lib/plaid/models/link_token_create_request.rb +429 -0
  423. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  424. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  425. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  426. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  427. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  428. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  429. data/lib/plaid/models/link_token_create_response.rb +255 -0
  430. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  431. data/lib/plaid/models/link_token_get_request.rb +245 -0
  432. data/lib/plaid/models/link_token_get_response.rb +266 -0
  433. data/lib/plaid/models/loan_filter.rb +227 -0
  434. data/lib/plaid/models/location.rb +298 -0
  435. data/lib/plaid/models/meta.rb +255 -0
  436. data/lib/plaid/models/mfa.rb +285 -0
  437. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  438. data/lib/plaid/models/mortgage_liability.rb +430 -0
  439. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  440. data/lib/plaid/models/nullable_access_token.rb +209 -0
  441. data/lib/plaid/models/nullable_address.rb +241 -0
  442. data/lib/plaid/models/nullable_address_data.rb +283 -0
  443. data/lib/plaid/models/nullable_item_status.rb +255 -0
  444. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  445. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  446. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  447. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  448. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  449. data/lib/plaid/models/numbers.rb +330 -0
  450. data/lib/plaid/models/numbers_ach.rb +266 -0
  451. data/lib/plaid/models/numbers_bacs.rb +255 -0
  452. data/lib/plaid/models/numbers_eft.rb +270 -0
  453. data/lib/plaid/models/numbers_international.rb +255 -0
  454. data/lib/plaid/models/override_accounts.rb +366 -0
  455. data/lib/plaid/models/owner.rb +278 -0
  456. data/lib/plaid/models/owner_override.rb +278 -0
  457. data/lib/plaid/models/pay_frequency.rb +272 -0
  458. data/lib/plaid/models/pay_period_details.rb +265 -0
  459. data/lib/plaid/models/payment_amount.rb +274 -0
  460. data/lib/plaid/models/payment_initiation_address.rb +269 -0
  461. data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
  462. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +236 -0
  463. data/lib/plaid/models/payment_initiation_payment.rb +395 -0
  464. data/lib/plaid/models/payment_initiation_payment_create_request.rb +294 -0
  465. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  466. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  467. data/lib/plaid/models/payment_initiation_payment_get_response.rb +418 -0
  468. data/lib/plaid/models/payment_initiation_payment_list_request.rb +271 -0
  469. data/lib/plaid/models/payment_initiation_payment_list_response.rb +253 -0
  470. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  471. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  472. data/lib/plaid/models/payment_initiation_recipient.rb +282 -0
  473. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +276 -0
  474. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  475. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  476. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +305 -0
  477. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  478. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  479. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  480. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
  481. data/lib/plaid/models/payment_meta.rb +298 -0
  482. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  483. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  484. data/lib/plaid/models/paystub.rb +306 -0
  485. data/lib/plaid/models/paystub_deduction.rb +242 -0
  486. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  487. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  488. data/lib/plaid/models/phone_number.rb +281 -0
  489. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  490. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  491. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  492. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  493. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  494. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  495. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  496. data/lib/plaid/models/processor_number.rb +250 -0
  497. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  498. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  499. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  500. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  501. data/lib/plaid/models/product_status.rb +288 -0
  502. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  503. data/lib/plaid/models/products.rb +47 -0
  504. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  505. data/lib/plaid/models/pslf_status.rb +243 -0
  506. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  507. data/lib/plaid/models/recipient_bacs.rb +230 -0
  508. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  509. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  510. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  511. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  512. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +294 -0
  513. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  514. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  515. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  516. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  517. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  518. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  519. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  520. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  521. data/lib/plaid/models/sandbox_public_token_create_request.rb +292 -0
  522. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  523. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  524. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  525. data/lib/plaid/models/security.rb +379 -0
  526. data/lib/plaid/models/servicer_address_data.rb +265 -0
  527. data/lib/plaid/models/standalone_account_type.rb +285 -0
  528. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  529. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  530. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  531. data/lib/plaid/models/student_loan.rb +472 -0
  532. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  533. data/lib/plaid/models/student_loan_status.rb +266 -0
  534. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  535. data/lib/plaid/models/transaction.rb +500 -0
  536. data/lib/plaid/models/transaction_code.rb +48 -0
  537. data/lib/plaid/models/transaction_data.rb +285 -0
  538. data/lib/plaid/models/transaction_override.rb +280 -0
  539. data/lib/plaid/models/transactions_get_request.rb +284 -0
  540. data/lib/plaid/models/transactions_get_request_options.rb +289 -0
  541. data/lib/plaid/models/transactions_get_response.rb +288 -0
  542. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  543. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  544. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  545. data/lib/plaid/models/user_custom_password.rb +297 -0
  546. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  547. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  548. data/lib/plaid/models/verification_status.rb +40 -0
  549. data/lib/plaid/models/warning.rb +254 -0
  550. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  551. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  552. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  553. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  554. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  555. data/lib/plaid/version.rb +13 -2
  556. data/pkg/plaid-13.2.0.gem +0 -0
  557. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  558. data/plaid.gemspec +44 -49
  559. data/templates/ruby/api_client.mustache +266 -0
  560. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  561. data/templates/ruby/configuration.mustache +353 -0
  562. data/templates/ruby/gemspec.mustache +41 -0
  563. data/templates/ruby/partial_model_generic.mustache +362 -0
  564. data/test/test_accounts.rb +103 -0
  565. data/test/test_asset_report.rb +147 -0
  566. data/test/test_auth.rb +61 -0
  567. data/test/test_bank_transfers.rb +219 -0
  568. data/test/test_categories.rb +10 -0
  569. data/test/test_configuration.rb +26 -0
  570. data/test/test_deposit_switch.rb +73 -0
  571. data/test/test_helper.rb +109 -0
  572. data/test/test_identity.rb +38 -0
  573. data/test/test_institutions.rb +159 -0
  574. data/test/test_investments.rb +208 -0
  575. data/test/test_item.rb +285 -0
  576. data/test/test_liabilities.rb +45 -0
  577. data/test/test_link_token.rb +97 -0
  578. data/test/test_payment_initiation.rb +94 -0
  579. data/test/test_processor.rb +67 -0
  580. data/test/test_transactions.rb +168 -0
  581. data/test/test_webhooks.rb +22 -0
  582. metadata +606 -97
  583. data/.circleci/config.yml +0 -21
  584. data/.env.sample +0 -3
  585. data/.github/workflows/add_to_project.yml +0 -21
  586. data/.rubocop.yml +0 -18
  587. data/bin/console +0 -14
  588. data/bin/setup +0 -8
  589. data/lib/plaid/client.rb +0 -190
  590. data/lib/plaid/errors.rb +0 -89
  591. data/lib/plaid/middleware.rb +0 -31
  592. data/lib/plaid/models.rb +0 -2221
  593. data/lib/plaid/products/accounts.rb +0 -63
  594. data/lib/plaid/products/asset_report.rb +0 -199
  595. data/lib/plaid/products/auth.rb +0 -42
  596. data/lib/plaid/products/base_product.rb +0 -64
  597. data/lib/plaid/products/categories.rb +0 -21
  598. data/lib/plaid/products/credit_details.rb +0 -40
  599. data/lib/plaid/products/deposit_switch.rb +0 -99
  600. data/lib/plaid/products/identity.rb +0 -31
  601. data/lib/plaid/products/income.rb +0 -31
  602. data/lib/plaid/products/institutions.rb +0 -91
  603. data/lib/plaid/products/investments.rb +0 -127
  604. data/lib/plaid/products/item.rb +0 -209
  605. data/lib/plaid/products/liabilities.rb +0 -39
  606. data/lib/plaid/products/link_token.rb +0 -74
  607. data/lib/plaid/products/payment_initiation.rb +0 -251
  608. data/lib/plaid/products/processor.rb +0 -190
  609. data/lib/plaid/products/sandbox.rb +0 -148
  610. data/lib/plaid/products/transactions.rb +0 -81
  611. data/lib/plaid/products/webhooks.rb +0 -23
@@ -0,0 +1,4572 @@
1
+ =begin
2
+ #The Plaid API
3
+
4
+ #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
+
6
+ The version of the OpenAPI document: 2020-09-14_1.16.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Plaid
16
+ class PlaidApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Retrieve real-time balance data
23
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
24
+ # @param accounts_balance_get_request [AccountsBalanceGetRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [AccountsGetResponse]
27
+ def accounts_balance_get(accounts_balance_get_request, opts = {})
28
+ data, _status_code, _headers = accounts_balance_get_with_http_info(accounts_balance_get_request, opts)
29
+ data
30
+ end
31
+
32
+ # Retrieve real-time balance data
33
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
34
+ # @param accounts_balance_get_request [AccountsBalanceGetRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
37
+ def accounts_balance_get_with_http_info(accounts_balance_get_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: PlaidApi.accounts_balance_get ...'
40
+ end
41
+ # verify the required parameter 'accounts_balance_get_request' is set
42
+ if @api_client.config.client_side_validation && accounts_balance_get_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'accounts_balance_get_request' when calling PlaidApi.accounts_balance_get"
44
+ end
45
+ # resource path
46
+ local_var_path = '/accounts/balance/get'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(accounts_balance_get_request)
63
+
64
+ # return_type
65
+ return_type = opts[:debug_return_type] || 'AccountsGetResponse'
66
+
67
+ # auth_names
68
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
69
+
70
+ new_options = opts.merge(
71
+ :operation => :"PlaidApi.accounts_balance_get",
72
+ :header_params => header_params,
73
+ :query_params => query_params,
74
+ :form_params => form_params,
75
+ :body => post_body,
76
+ :auth_names => auth_names,
77
+ :return_type => return_type
78
+ )
79
+
80
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
81
+ if @api_client.config.debugging
82
+ @api_client.config.logger.debug "API called: PlaidApi#accounts_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
+ end
84
+ return data, status_code, headers
85
+ end
86
+
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. 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
+ # @param accounts_get_request [AccountsGetRequest]
90
+ # @param [Hash] opts the optional parameters
91
+ # @return [AccountsGetResponse]
92
+ def accounts_get(accounts_get_request, opts = {})
93
+ data, _status_code, _headers = accounts_get_with_http_info(accounts_get_request, opts)
94
+ data
95
+ end
96
+
97
+ # Retrieve accounts
98
+ # The &#x60;/accounts/get&#x60; 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 &#x60;/accounts/balance/get&#x60; instead.
99
+ # @param accounts_get_request [AccountsGetRequest]
100
+ # @param [Hash] opts the optional parameters
101
+ # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
102
+ def accounts_get_with_http_info(accounts_get_request, opts = {})
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug 'Calling API: PlaidApi.accounts_get ...'
105
+ end
106
+ # verify the required parameter 'accounts_get_request' is set
107
+ if @api_client.config.client_side_validation && accounts_get_request.nil?
108
+ fail ArgumentError, "Missing the required parameter 'accounts_get_request' when calling PlaidApi.accounts_get"
109
+ end
110
+ # resource path
111
+ local_var_path = '/accounts/get'
112
+
113
+ # query parameters
114
+ query_params = opts[:query_params] || {}
115
+
116
+ # header parameters
117
+ header_params = opts[:header_params] || {}
118
+ # HTTP header 'Accept' (if needed)
119
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
120
+ # HTTP header 'Content-Type'
121
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
122
+
123
+ # form parameters
124
+ form_params = opts[:form_params] || {}
125
+
126
+ # http body (model)
127
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(accounts_get_request)
128
+
129
+ # return_type
130
+ return_type = opts[:debug_return_type] || 'AccountsGetResponse'
131
+
132
+ # auth_names
133
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
134
+
135
+ new_options = opts.merge(
136
+ :operation => :"PlaidApi.accounts_get",
137
+ :header_params => header_params,
138
+ :query_params => query_params,
139
+ :form_params => form_params,
140
+ :body => post_body,
141
+ :auth_names => auth_names,
142
+ :return_type => return_type
143
+ )
144
+
145
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: PlaidApi#accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
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
+
217
+ # Create Asset Report Audit Copy
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.
219
+ # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
220
+ # @param [Hash] opts the optional parameters
221
+ # @return [AssetReportAuditCopyCreateResponse]
222
+ def asset_report_audit_copy_create(asset_report_audit_copy_create_request, opts = {})
223
+ data, _status_code, _headers = asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts)
224
+ data
225
+ end
226
+
227
+ # Create Asset Report Audit Copy
228
+ # 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 &#x60;/asset_report/audit_copy/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;auditor_id&#x60;, for example &#x60;fannie_mae&#x60;. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
229
+ # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
230
+ # @param [Hash] opts the optional parameters
231
+ # @return [Array<(AssetReportAuditCopyCreateResponse, Integer, Hash)>] AssetReportAuditCopyCreateResponse data, response status code and response headers
232
+ def asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_create ...'
235
+ end
236
+ # verify the required parameter 'asset_report_audit_copy_create_request' is set
237
+ if @api_client.config.client_side_validation && asset_report_audit_copy_create_request.nil?
238
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_create_request' when calling PlaidApi.asset_report_audit_copy_create"
239
+ end
240
+ # resource path
241
+ local_var_path = '/asset_report/audit_copy/create'
242
+
243
+ # query parameters
244
+ query_params = opts[:query_params] || {}
245
+
246
+ # header parameters
247
+ header_params = opts[:header_params] || {}
248
+ # HTTP header 'Accept' (if needed)
249
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
250
+ # HTTP header 'Content-Type'
251
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
252
+
253
+ # form parameters
254
+ form_params = opts[:form_params] || {}
255
+
256
+ # http body (model)
257
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_create_request)
258
+
259
+ # return_type
260
+ return_type = opts[:debug_return_type] || 'AssetReportAuditCopyCreateResponse'
261
+
262
+ # auth_names
263
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
264
+
265
+ new_options = opts.merge(
266
+ :operation => :"PlaidApi.asset_report_audit_copy_create",
267
+ :header_params => header_params,
268
+ :query_params => query_params,
269
+ :form_params => form_params,
270
+ :body => post_body,
271
+ :auth_names => auth_names,
272
+ :return_type => return_type
273
+ )
274
+
275
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
276
+ if @api_client.config.debugging
277
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
+ end
279
+ return data, status_code, headers
280
+ end
281
+
282
+ # Retrieve an Asset Report Audit Copy
283
+ # `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`.
284
+ # @param asset_report_audit_copy_get_request [AssetReportAuditCopyGetRequest]
285
+ # @param [Hash] opts the optional parameters
286
+ # @return [AssetReportGetResponse]
287
+ def asset_report_audit_copy_get(asset_report_audit_copy_get_request, opts = {})
288
+ data, _status_code, _headers = asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts)
289
+ data
290
+ end
291
+
292
+ # Retrieve an Asset Report Audit Copy
293
+ # &#x60;/asset_report/audit_copy/get&#x60; allows auditors to get a copy of an Asset Report that was previously shared via the &#x60;/asset_report/audit_copy/create&#x60; endpoint. The caller of &#x60;/asset_report/audit_copy/create&#x60; must provide the &#x60;audit_copy_token&#x60; to the auditor. This token can then be used to call &#x60;/asset_report/audit_copy/create&#x60;.
294
+ # @param asset_report_audit_copy_get_request [AssetReportAuditCopyGetRequest]
295
+ # @param [Hash] opts the optional parameters
296
+ # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
297
+ def asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts = {})
298
+ if @api_client.config.debugging
299
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_get ...'
300
+ end
301
+ # verify the required parameter 'asset_report_audit_copy_get_request' is set
302
+ if @api_client.config.client_side_validation && asset_report_audit_copy_get_request.nil?
303
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_get_request' when calling PlaidApi.asset_report_audit_copy_get"
304
+ end
305
+ # resource path
306
+ local_var_path = '/asset_report/audit_copy/get'
307
+
308
+ # query parameters
309
+ query_params = opts[:query_params] || {}
310
+
311
+ # header parameters
312
+ header_params = opts[:header_params] || {}
313
+ # HTTP header 'Accept' (if needed)
314
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
315
+ # HTTP header 'Content-Type'
316
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
317
+
318
+ # form parameters
319
+ form_params = opts[:form_params] || {}
320
+
321
+ # http body (model)
322
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_get_request)
323
+
324
+ # return_type
325
+ return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
326
+
327
+ # auth_names
328
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
329
+
330
+ new_options = opts.merge(
331
+ :operation => :"PlaidApi.asset_report_audit_copy_get",
332
+ :header_params => header_params,
333
+ :query_params => query_params,
334
+ :form_params => form_params,
335
+ :body => post_body,
336
+ :auth_names => auth_names,
337
+ :return_type => return_type
338
+ )
339
+
340
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
341
+ if @api_client.config.debugging
342
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
+ end
344
+ return data, status_code, headers
345
+ end
346
+
347
+ # Remove Asset Report Audit Copy
348
+ # The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
349
+ # @param asset_report_audit_copy_remove_request [AssetReportAuditCopyRemoveRequest]
350
+ # @param [Hash] opts the optional parameters
351
+ # @return [AssetReportAuditCopyRemoveResponse]
352
+ def asset_report_audit_copy_remove(asset_report_audit_copy_remove_request, opts = {})
353
+ data, _status_code, _headers = asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts)
354
+ data
355
+ end
356
+
357
+ # Remove Asset Report Audit Copy
358
+ # The &#x60;/asset_report/audit_copy/remove&#x60; endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the &#x60;audit_copy_token&#x60; associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
359
+ # @param asset_report_audit_copy_remove_request [AssetReportAuditCopyRemoveRequest]
360
+ # @param [Hash] opts the optional parameters
361
+ # @return [Array<(AssetReportAuditCopyRemoveResponse, Integer, Hash)>] AssetReportAuditCopyRemoveResponse data, response status code and response headers
362
+ def asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts = {})
363
+ if @api_client.config.debugging
364
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_remove ...'
365
+ end
366
+ # verify the required parameter 'asset_report_audit_copy_remove_request' is set
367
+ if @api_client.config.client_side_validation && asset_report_audit_copy_remove_request.nil?
368
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_remove_request' when calling PlaidApi.asset_report_audit_copy_remove"
369
+ end
370
+ # resource path
371
+ local_var_path = '/asset_report/audit_copy/remove'
372
+
373
+ # query parameters
374
+ query_params = opts[:query_params] || {}
375
+
376
+ # header parameters
377
+ header_params = opts[:header_params] || {}
378
+ # HTTP header 'Accept' (if needed)
379
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
380
+ # HTTP header 'Content-Type'
381
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
382
+
383
+ # form parameters
384
+ form_params = opts[:form_params] || {}
385
+
386
+ # http body (model)
387
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_remove_request)
388
+
389
+ # return_type
390
+ return_type = opts[:debug_return_type] || 'AssetReportAuditCopyRemoveResponse'
391
+
392
+ # auth_names
393
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
394
+
395
+ new_options = opts.merge(
396
+ :operation => :"PlaidApi.asset_report_audit_copy_remove",
397
+ :header_params => header_params,
398
+ :query_params => query_params,
399
+ :form_params => form_params,
400
+ :body => post_body,
401
+ :auth_names => auth_names,
402
+ :return_type => return_type
403
+ )
404
+
405
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
406
+ if @api_client.config.debugging
407
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
408
+ end
409
+ return data, status_code, headers
410
+ end
411
+
412
+ # Create an Asset Report
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](/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.
414
+ # @param asset_report_create_request [AssetReportCreateRequest]
415
+ # @param [Hash] opts the optional parameters
416
+ # @return [AssetReportCreateResponse]
417
+ def asset_report_create(asset_report_create_request, opts = {})
418
+ data, _status_code, _headers = asset_report_create_with_http_info(asset_report_create_request, opts)
419
+ data
420
+ end
421
+
422
+ # Create an Asset Report
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](/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.
424
+ # @param asset_report_create_request [AssetReportCreateRequest]
425
+ # @param [Hash] opts the optional parameters
426
+ # @return [Array<(AssetReportCreateResponse, Integer, Hash)>] AssetReportCreateResponse data, response status code and response headers
427
+ def asset_report_create_with_http_info(asset_report_create_request, opts = {})
428
+ if @api_client.config.debugging
429
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_create ...'
430
+ end
431
+ # verify the required parameter 'asset_report_create_request' is set
432
+ if @api_client.config.client_side_validation && asset_report_create_request.nil?
433
+ fail ArgumentError, "Missing the required parameter 'asset_report_create_request' when calling PlaidApi.asset_report_create"
434
+ end
435
+ # resource path
436
+ local_var_path = '/asset_report/create'
437
+
438
+ # query parameters
439
+ query_params = opts[:query_params] || {}
440
+
441
+ # header parameters
442
+ header_params = opts[:header_params] || {}
443
+ # HTTP header 'Accept' (if needed)
444
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
445
+ # HTTP header 'Content-Type'
446
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
447
+
448
+ # form parameters
449
+ form_params = opts[:form_params] || {}
450
+
451
+ # http body (model)
452
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_create_request)
453
+
454
+ # return_type
455
+ return_type = opts[:debug_return_type] || 'AssetReportCreateResponse'
456
+
457
+ # auth_names
458
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
459
+
460
+ new_options = opts.merge(
461
+ :operation => :"PlaidApi.asset_report_create",
462
+ :header_params => header_params,
463
+ :query_params => query_params,
464
+ :form_params => form_params,
465
+ :body => post_body,
466
+ :auth_names => auth_names,
467
+ :return_type => return_type
468
+ )
469
+
470
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
471
+ if @api_client.config.debugging
472
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
473
+ end
474
+ return data, status_code, headers
475
+ end
476
+
477
+ # Filter Asset Report
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 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.
479
+ # @param asset_report_filter_request [AssetReportFilterRequest]
480
+ # @param [Hash] opts the optional parameters
481
+ # @return [AssetReportFilterResponse]
482
+ def asset_report_filter(asset_report_filter_request, opts = {})
483
+ data, _status_code, _headers = asset_report_filter_with_http_info(asset_report_filter_request, opts)
484
+ data
485
+ end
486
+
487
+ # Filter Asset Report
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 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.
489
+ # @param asset_report_filter_request [AssetReportFilterRequest]
490
+ # @param [Hash] opts the optional parameters
491
+ # @return [Array<(AssetReportFilterResponse, Integer, Hash)>] AssetReportFilterResponse data, response status code and response headers
492
+ def asset_report_filter_with_http_info(asset_report_filter_request, opts = {})
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_filter ...'
495
+ end
496
+ # verify the required parameter 'asset_report_filter_request' is set
497
+ if @api_client.config.client_side_validation && asset_report_filter_request.nil?
498
+ fail ArgumentError, "Missing the required parameter 'asset_report_filter_request' when calling PlaidApi.asset_report_filter"
499
+ end
500
+ # resource path
501
+ local_var_path = '/asset_report/filter'
502
+
503
+ # query parameters
504
+ query_params = opts[:query_params] || {}
505
+
506
+ # header parameters
507
+ header_params = opts[:header_params] || {}
508
+ # HTTP header 'Accept' (if needed)
509
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
510
+ # HTTP header 'Content-Type'
511
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
512
+
513
+ # form parameters
514
+ form_params = opts[:form_params] || {}
515
+
516
+ # http body (model)
517
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_filter_request)
518
+
519
+ # return_type
520
+ return_type = opts[:debug_return_type] || 'AssetReportFilterResponse'
521
+
522
+ # auth_names
523
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
524
+
525
+ new_options = opts.merge(
526
+ :operation => :"PlaidApi.asset_report_filter",
527
+ :header_params => header_params,
528
+ :query_params => query_params,
529
+ :form_params => form_params,
530
+ :body => post_body,
531
+ :auth_names => auth_names,
532
+ :return_type => return_type
533
+ )
534
+
535
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
536
+ if @api_client.config.debugging
537
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
538
+ end
539
+ return data, status_code, headers
540
+ end
541
+
542
+ # Retrieve an Asset Report
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`](/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`.
544
+ # @param asset_report_get_request [AssetReportGetRequest]
545
+ # @param [Hash] opts the optional parameters
546
+ # @return [AssetReportGetResponse]
547
+ def asset_report_get(asset_report_get_request, opts = {})
548
+ data, _status_code, _headers = asset_report_get_with_http_info(asset_report_get_request, opts)
549
+ data
550
+ end
551
+
552
+ # Retrieve an Asset Report
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;](/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;.
554
+ # @param asset_report_get_request [AssetReportGetRequest]
555
+ # @param [Hash] opts the optional parameters
556
+ # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
557
+ def asset_report_get_with_http_info(asset_report_get_request, opts = {})
558
+ if @api_client.config.debugging
559
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_get ...'
560
+ end
561
+ # verify the required parameter 'asset_report_get_request' is set
562
+ if @api_client.config.client_side_validation && asset_report_get_request.nil?
563
+ fail ArgumentError, "Missing the required parameter 'asset_report_get_request' when calling PlaidApi.asset_report_get"
564
+ end
565
+ # resource path
566
+ local_var_path = '/asset_report/get'
567
+
568
+ # query parameters
569
+ query_params = opts[:query_params] || {}
570
+
571
+ # header parameters
572
+ header_params = opts[:header_params] || {}
573
+ # HTTP header 'Accept' (if needed)
574
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
575
+ # HTTP header 'Content-Type'
576
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
577
+
578
+ # form parameters
579
+ form_params = opts[:form_params] || {}
580
+
581
+ # http body (model)
582
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_get_request)
583
+
584
+ # return_type
585
+ return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
586
+
587
+ # auth_names
588
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
589
+
590
+ new_options = opts.merge(
591
+ :operation => :"PlaidApi.asset_report_get",
592
+ :header_params => header_params,
593
+ :query_params => query_params,
594
+ :form_params => form_params,
595
+ :body => post_body,
596
+ :auth_names => auth_names,
597
+ :return_type => return_type
598
+ )
599
+
600
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
601
+ if @api_client.config.debugging
602
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
603
+ end
604
+ return data, status_code, headers
605
+ end
606
+
607
+ # Retrieve a PDF Asset Report
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`](/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).
609
+ # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
610
+ # @param [Hash] opts the optional parameters
611
+ # @return [File]
612
+ def asset_report_pdf_get(asset_report_pdf_get_request, opts = {})
613
+ data, _status_code, _headers = asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts)
614
+ data
615
+ end
616
+
617
+ # Retrieve a PDF Asset Report
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;](/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).
619
+ # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
620
+ # @param [Hash] opts the optional parameters
621
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
622
+ def asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts = {})
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_pdf_get ...'
625
+ end
626
+ # verify the required parameter 'asset_report_pdf_get_request' is set
627
+ if @api_client.config.client_side_validation && asset_report_pdf_get_request.nil?
628
+ fail ArgumentError, "Missing the required parameter 'asset_report_pdf_get_request' when calling PlaidApi.asset_report_pdf_get"
629
+ end
630
+ # resource path
631
+ local_var_path = '/asset_report/pdf/get'
632
+
633
+ # query parameters
634
+ query_params = opts[:query_params] || {}
635
+
636
+ # header parameters
637
+ header_params = opts[:header_params] || {}
638
+ # HTTP header 'Accept' (if needed)
639
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
640
+ # HTTP header 'Content-Type'
641
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
642
+
643
+ # form parameters
644
+ form_params = opts[:form_params] || {}
645
+
646
+ # http body (model)
647
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_pdf_get_request)
648
+
649
+ # return_type
650
+ return_type = opts[:debug_return_type] || 'File'
651
+
652
+ # auth_names
653
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
654
+
655
+ new_options = opts.merge(
656
+ :operation => :"PlaidApi.asset_report_pdf_get",
657
+ :header_params => header_params,
658
+ :query_params => query_params,
659
+ :form_params => form_params,
660
+ :body => post_body,
661
+ :auth_names => auth_names,
662
+ :return_type => return_type
663
+ )
664
+
665
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
666
+ if @api_client.config.debugging
667
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
668
+ end
669
+ return data, status_code, headers
670
+ end
671
+
672
+ # Refresh an Asset Report
673
+ # An Asset Report is an immutable snapshot of a user's assets. In order to \"refresh\" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string (\"\") for any previously-populated fields you would like set as empty.
674
+ # @param asset_report_refresh_request [AssetReportRefreshRequest]
675
+ # @param [Hash] opts the optional parameters
676
+ # @return [AssetReportRefreshResponse]
677
+ def asset_report_refresh(asset_report_refresh_request, opts = {})
678
+ data, _status_code, _headers = asset_report_refresh_with_http_info(asset_report_refresh_request, opts)
679
+ data
680
+ end
681
+
682
+ # Refresh an Asset Report
683
+ # An Asset Report is an immutable snapshot of a user&#39;s assets. In order to \&quot;refresh\&quot; an Asset Report you created previously, you can use the &#x60;/asset_report/refresh&#x60; endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to &#x60;/asset_report/filter&#x60;. By default, the new Asset Report will also use the same parameters you submitted with your original &#x60;/asset_report/create&#x60; request, but the original &#x60;days_requested&#x60; value and the values of any parameters in the &#x60;options&#x60; object can be overridden with new values. To change these arguments, simply supply new values for them in your request to &#x60;/asset_report/refresh&#x60;. Submit an empty string (\&quot;\&quot;) for any previously-populated fields you would like set as empty.
684
+ # @param asset_report_refresh_request [AssetReportRefreshRequest]
685
+ # @param [Hash] opts the optional parameters
686
+ # @return [Array<(AssetReportRefreshResponse, Integer, Hash)>] AssetReportRefreshResponse data, response status code and response headers
687
+ def asset_report_refresh_with_http_info(asset_report_refresh_request, opts = {})
688
+ if @api_client.config.debugging
689
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_refresh ...'
690
+ end
691
+ # verify the required parameter 'asset_report_refresh_request' is set
692
+ if @api_client.config.client_side_validation && asset_report_refresh_request.nil?
693
+ fail ArgumentError, "Missing the required parameter 'asset_report_refresh_request' when calling PlaidApi.asset_report_refresh"
694
+ end
695
+ # resource path
696
+ local_var_path = '/asset_report/refresh'
697
+
698
+ # query parameters
699
+ query_params = opts[:query_params] || {}
700
+
701
+ # header parameters
702
+ header_params = opts[:header_params] || {}
703
+ # HTTP header 'Accept' (if needed)
704
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
705
+ # HTTP header 'Content-Type'
706
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
707
+
708
+ # form parameters
709
+ form_params = opts[:form_params] || {}
710
+
711
+ # http body (model)
712
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_refresh_request)
713
+
714
+ # return_type
715
+ return_type = opts[:debug_return_type] || 'AssetReportRefreshResponse'
716
+
717
+ # auth_names
718
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
719
+
720
+ new_options = opts.merge(
721
+ :operation => :"PlaidApi.asset_report_refresh",
722
+ :header_params => header_params,
723
+ :query_params => query_params,
724
+ :form_params => form_params,
725
+ :body => post_body,
726
+ :auth_names => auth_names,
727
+ :return_type => return_type
728
+ )
729
+
730
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
731
+ if @api_client.config.debugging
732
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
733
+ end
734
+ return data, status_code, headers
735
+ end
736
+
737
+ # Delete an Asset Report
738
+ # The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
739
+ # @param asset_report_remove_request [AssetReportRemoveRequest]
740
+ # @param [Hash] opts the optional parameters
741
+ # @return [AssetReportRemoveResponse]
742
+ def asset_report_remove(asset_report_remove_request, opts = {})
743
+ data, _status_code, _headers = asset_report_remove_with_http_info(asset_report_remove_request, opts)
744
+ data
745
+ end
746
+
747
+ # Delete an Asset Report
748
+ # The &#x60;/item/remove&#x60; endpoint allows you to invalidate an &#x60;access_token&#x60;, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The &#x60;/asset_report/remove&#x60; endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its &#x60;asset_report_token&#x60;, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any &#x60;audit_copy_tokens&#x60; associated with the Asset Report.
749
+ # @param asset_report_remove_request [AssetReportRemoveRequest]
750
+ # @param [Hash] opts the optional parameters
751
+ # @return [Array<(AssetReportRemoveResponse, Integer, Hash)>] AssetReportRemoveResponse data, response status code and response headers
752
+ def asset_report_remove_with_http_info(asset_report_remove_request, opts = {})
753
+ if @api_client.config.debugging
754
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_remove ...'
755
+ end
756
+ # verify the required parameter 'asset_report_remove_request' is set
757
+ if @api_client.config.client_side_validation && asset_report_remove_request.nil?
758
+ fail ArgumentError, "Missing the required parameter 'asset_report_remove_request' when calling PlaidApi.asset_report_remove"
759
+ end
760
+ # resource path
761
+ local_var_path = '/asset_report/remove'
762
+
763
+ # query parameters
764
+ query_params = opts[:query_params] || {}
765
+
766
+ # header parameters
767
+ header_params = opts[:header_params] || {}
768
+ # HTTP header 'Accept' (if needed)
769
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
770
+ # HTTP header 'Content-Type'
771
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
772
+
773
+ # form parameters
774
+ form_params = opts[:form_params] || {}
775
+
776
+ # http body (model)
777
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_remove_request)
778
+
779
+ # return_type
780
+ return_type = opts[:debug_return_type] || 'AssetReportRemoveResponse'
781
+
782
+ # auth_names
783
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
784
+
785
+ new_options = opts.merge(
786
+ :operation => :"PlaidApi.asset_report_remove",
787
+ :header_params => header_params,
788
+ :query_params => query_params,
789
+ :form_params => form_params,
790
+ :body => post_body,
791
+ :auth_names => auth_names,
792
+ :return_type => return_type
793
+ )
794
+
795
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
796
+ if @api_client.config.debugging
797
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
+ end
799
+ return data, status_code, headers
800
+ end
801
+
802
+ # Retrieve auth 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.
804
+ # @param auth_get_request [AuthGetRequest]
805
+ # @param [Hash] opts the optional parameters
806
+ # @return [AuthGetResponse]
807
+ def auth_get(auth_get_request, opts = {})
808
+ data, _status_code, _headers = auth_get_with_http_info(auth_get_request, opts)
809
+ data
810
+ end
811
+
812
+ # Retrieve auth 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.
814
+ # @param auth_get_request [AuthGetRequest]
815
+ # @param [Hash] opts the optional parameters
816
+ # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
817
+ def auth_get_with_http_info(auth_get_request, opts = {})
818
+ if @api_client.config.debugging
819
+ @api_client.config.logger.debug 'Calling API: PlaidApi.auth_get ...'
820
+ end
821
+ # verify the required parameter 'auth_get_request' is set
822
+ if @api_client.config.client_side_validation && auth_get_request.nil?
823
+ fail ArgumentError, "Missing the required parameter 'auth_get_request' when calling PlaidApi.auth_get"
824
+ end
825
+ # resource path
826
+ local_var_path = '/auth/get'
827
+
828
+ # query parameters
829
+ query_params = opts[:query_params] || {}
830
+
831
+ # header parameters
832
+ header_params = opts[:header_params] || {}
833
+ # HTTP header 'Accept' (if needed)
834
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
835
+ # HTTP header 'Content-Type'
836
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
837
+
838
+ # form parameters
839
+ form_params = opts[:form_params] || {}
840
+
841
+ # http body (model)
842
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(auth_get_request)
843
+
844
+ # return_type
845
+ return_type = opts[:debug_return_type] || 'AuthGetResponse'
846
+
847
+ # auth_names
848
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
849
+
850
+ new_options = opts.merge(
851
+ :operation => :"PlaidApi.auth_get",
852
+ :header_params => header_params,
853
+ :query_params => query_params,
854
+ :form_params => form_params,
855
+ :body => post_body,
856
+ :auth_names => auth_names,
857
+ :return_type => return_type
858
+ )
859
+
860
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
861
+ if @api_client.config.debugging
862
+ @api_client.config.logger.debug "API called: PlaidApi#auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
863
+ end
864
+ return data, status_code, headers
865
+ end
866
+
867
+ # Get balance of your Bank Transfer account
868
+ # Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
869
+ # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
870
+ # @param [Hash] opts the optional parameters
871
+ # @return [BankTransferBalanceGetResponse]
872
+ def bank_transfer_balance_get(bank_transfer_balance_get_request, opts = {})
873
+ data, _status_code, _headers = bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts)
874
+ data
875
+ end
876
+
877
+ # Get balance of your Bank Transfer account
878
+ # Use the &#x60;/bank_transfer/balance/get&#x60; endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
879
+ # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
880
+ # @param [Hash] opts the optional parameters
881
+ # @return [Array<(BankTransferBalanceGetResponse, Integer, Hash)>] BankTransferBalanceGetResponse data, response status code and response headers
882
+ def bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts = {})
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_balance_get ...'
885
+ end
886
+ # verify the required parameter 'bank_transfer_balance_get_request' is set
887
+ if @api_client.config.client_side_validation && bank_transfer_balance_get_request.nil?
888
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_balance_get_request' when calling PlaidApi.bank_transfer_balance_get"
889
+ end
890
+ # resource path
891
+ local_var_path = '/bank_transfer/balance/get'
892
+
893
+ # query parameters
894
+ query_params = opts[:query_params] || {}
895
+
896
+ # header parameters
897
+ header_params = opts[:header_params] || {}
898
+ # HTTP header 'Accept' (if needed)
899
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
900
+ # HTTP header 'Content-Type'
901
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
902
+
903
+ # form parameters
904
+ form_params = opts[:form_params] || {}
905
+
906
+ # http body (model)
907
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_balance_get_request)
908
+
909
+ # return_type
910
+ return_type = opts[:debug_return_type] || 'BankTransferBalanceGetResponse'
911
+
912
+ # auth_names
913
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
914
+
915
+ new_options = opts.merge(
916
+ :operation => :"PlaidApi.bank_transfer_balance_get",
917
+ :header_params => header_params,
918
+ :query_params => query_params,
919
+ :form_params => form_params,
920
+ :body => post_body,
921
+ :auth_names => auth_names,
922
+ :return_type => return_type
923
+ )
924
+
925
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
926
+ if @api_client.config.debugging
927
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
928
+ end
929
+ return data, status_code, headers
930
+ end
931
+
932
+ # Cancel a bank transfer
933
+ # Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.
934
+ # @param bank_transfer_cancel_request [BankTransferCancelRequest]
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [BankTransferCancelResponse]
937
+ def bank_transfer_cancel(bank_transfer_cancel_request, opts = {})
938
+ data, _status_code, _headers = bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts)
939
+ data
940
+ end
941
+
942
+ # Cancel a bank transfer
943
+ # Use the &#x60;/bank_transfer/cancel&#x60; endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/bank_transfer/get&#x60; is &#x60;true&#x60;.
944
+ # @param bank_transfer_cancel_request [BankTransferCancelRequest]
945
+ # @param [Hash] opts the optional parameters
946
+ # @return [Array<(BankTransferCancelResponse, Integer, Hash)>] BankTransferCancelResponse data, response status code and response headers
947
+ def bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts = {})
948
+ if @api_client.config.debugging
949
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_cancel ...'
950
+ end
951
+ # verify the required parameter 'bank_transfer_cancel_request' is set
952
+ if @api_client.config.client_side_validation && bank_transfer_cancel_request.nil?
953
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_cancel_request' when calling PlaidApi.bank_transfer_cancel"
954
+ end
955
+ # resource path
956
+ local_var_path = '/bank_transfer/cancel'
957
+
958
+ # query parameters
959
+ query_params = opts[:query_params] || {}
960
+
961
+ # header parameters
962
+ header_params = opts[:header_params] || {}
963
+ # HTTP header 'Accept' (if needed)
964
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
965
+ # HTTP header 'Content-Type'
966
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
967
+
968
+ # form parameters
969
+ form_params = opts[:form_params] || {}
970
+
971
+ # http body (model)
972
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_cancel_request)
973
+
974
+ # return_type
975
+ return_type = opts[:debug_return_type] || 'BankTransferCancelResponse'
976
+
977
+ # auth_names
978
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
979
+
980
+ new_options = opts.merge(
981
+ :operation => :"PlaidApi.bank_transfer_cancel",
982
+ :header_params => header_params,
983
+ :query_params => query_params,
984
+ :form_params => form_params,
985
+ :body => post_body,
986
+ :auth_names => auth_names,
987
+ :return_type => return_type
988
+ )
989
+
990
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
991
+ if @api_client.config.debugging
992
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
993
+ end
994
+ return data, status_code, headers
995
+ end
996
+
997
+ # Create a bank transfer
998
+ # Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
999
+ # @param bank_transfer_create_request [BankTransferCreateRequest]
1000
+ # @param [Hash] opts the optional parameters
1001
+ # @return [BankTransferCreateResponse]
1002
+ def bank_transfer_create(bank_transfer_create_request, opts = {})
1003
+ data, _status_code, _headers = bank_transfer_create_with_http_info(bank_transfer_create_request, opts)
1004
+ data
1005
+ end
1006
+
1007
+ # Create a bank transfer
1008
+ # Use the &#x60;/bank_transfer/create&#x60; endpoint to initiate a new bank transfer.
1009
+ # @param bank_transfer_create_request [BankTransferCreateRequest]
1010
+ # @param [Hash] opts the optional parameters
1011
+ # @return [Array<(BankTransferCreateResponse, Integer, Hash)>] BankTransferCreateResponse data, response status code and response headers
1012
+ def bank_transfer_create_with_http_info(bank_transfer_create_request, opts = {})
1013
+ if @api_client.config.debugging
1014
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_create ...'
1015
+ end
1016
+ # verify the required parameter 'bank_transfer_create_request' is set
1017
+ if @api_client.config.client_side_validation && bank_transfer_create_request.nil?
1018
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_create_request' when calling PlaidApi.bank_transfer_create"
1019
+ end
1020
+ # resource path
1021
+ local_var_path = '/bank_transfer/create'
1022
+
1023
+ # query parameters
1024
+ query_params = opts[:query_params] || {}
1025
+
1026
+ # header parameters
1027
+ header_params = opts[:header_params] || {}
1028
+ # HTTP header 'Accept' (if needed)
1029
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1030
+ # HTTP header 'Content-Type'
1031
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1032
+
1033
+ # form parameters
1034
+ form_params = opts[:form_params] || {}
1035
+
1036
+ # http body (model)
1037
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_create_request)
1038
+
1039
+ # return_type
1040
+ return_type = opts[:debug_return_type] || 'BankTransferCreateResponse'
1041
+
1042
+ # auth_names
1043
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1044
+
1045
+ new_options = opts.merge(
1046
+ :operation => :"PlaidApi.bank_transfer_create",
1047
+ :header_params => header_params,
1048
+ :query_params => query_params,
1049
+ :form_params => form_params,
1050
+ :body => post_body,
1051
+ :auth_names => auth_names,
1052
+ :return_type => return_type
1053
+ )
1054
+
1055
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1056
+ if @api_client.config.debugging
1057
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1058
+ end
1059
+ return data, status_code, headers
1060
+ end
1061
+
1062
+ # List bank transfer events
1063
+ # Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
1064
+ # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1065
+ # @param [Hash] opts the optional parameters
1066
+ # @return [BankTransferEventListResponse]
1067
+ def bank_transfer_event_list(bank_transfer_event_list_request, opts = {})
1068
+ data, _status_code, _headers = bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts)
1069
+ data
1070
+ end
1071
+
1072
+ # List bank transfer events
1073
+ # Use the &#x60;/bank_transfer/event/list&#x60; endpoint to get a list of bank transfer events based on specified filter criteria.
1074
+ # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1075
+ # @param [Hash] opts the optional parameters
1076
+ # @return [Array<(BankTransferEventListResponse, Integer, Hash)>] BankTransferEventListResponse data, response status code and response headers
1077
+ def bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts = {})
1078
+ if @api_client.config.debugging
1079
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_list ...'
1080
+ end
1081
+ # verify the required parameter 'bank_transfer_event_list_request' is set
1082
+ if @api_client.config.client_side_validation && bank_transfer_event_list_request.nil?
1083
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_event_list_request' when calling PlaidApi.bank_transfer_event_list"
1084
+ end
1085
+ # resource path
1086
+ local_var_path = '/bank_transfer/event/list'
1087
+
1088
+ # query parameters
1089
+ query_params = opts[:query_params] || {}
1090
+
1091
+ # header parameters
1092
+ header_params = opts[:header_params] || {}
1093
+ # HTTP header 'Accept' (if needed)
1094
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1095
+ # HTTP header 'Content-Type'
1096
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1097
+
1098
+ # form parameters
1099
+ form_params = opts[:form_params] || {}
1100
+
1101
+ # http body (model)
1102
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_event_list_request)
1103
+
1104
+ # return_type
1105
+ return_type = opts[:debug_return_type] || 'BankTransferEventListResponse'
1106
+
1107
+ # auth_names
1108
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1109
+
1110
+ new_options = opts.merge(
1111
+ :operation => :"PlaidApi.bank_transfer_event_list",
1112
+ :header_params => header_params,
1113
+ :query_params => query_params,
1114
+ :form_params => form_params,
1115
+ :body => post_body,
1116
+ :auth_names => auth_names,
1117
+ :return_type => return_type
1118
+ )
1119
+
1120
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1121
+ if @api_client.config.debugging
1122
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1123
+ end
1124
+ return data, status_code, headers
1125
+ end
1126
+
1127
+ # Sync bank transfer events
1128
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1129
+ # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1130
+ # @param [Hash] opts the optional parameters
1131
+ # @return [BankTransferEventSyncResponse]
1132
+ def bank_transfer_event_sync(bank_transfer_event_sync_request, opts = {})
1133
+ data, _status_code, _headers = bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts)
1134
+ data
1135
+ end
1136
+
1137
+ # Sync bank transfer events
1138
+ # &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 bank transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/bank_transfer/event/sync&#x60; endpoint to guarantee you have seen all bank transfer events.
1139
+ # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1140
+ # @param [Hash] opts the optional parameters
1141
+ # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
1142
+ def bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts = {})
1143
+ if @api_client.config.debugging
1144
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_sync ...'
1145
+ end
1146
+ # verify the required parameter 'bank_transfer_event_sync_request' is set
1147
+ if @api_client.config.client_side_validation && bank_transfer_event_sync_request.nil?
1148
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_event_sync_request' when calling PlaidApi.bank_transfer_event_sync"
1149
+ end
1150
+ # resource path
1151
+ local_var_path = '/bank_transfer/event/sync'
1152
+
1153
+ # query parameters
1154
+ query_params = opts[:query_params] || {}
1155
+
1156
+ # header parameters
1157
+ header_params = opts[:header_params] || {}
1158
+ # HTTP header 'Accept' (if needed)
1159
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1160
+ # HTTP header 'Content-Type'
1161
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1162
+
1163
+ # form parameters
1164
+ form_params = opts[:form_params] || {}
1165
+
1166
+ # http body (model)
1167
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_event_sync_request)
1168
+
1169
+ # return_type
1170
+ return_type = opts[:debug_return_type] || 'BankTransferEventSyncResponse'
1171
+
1172
+ # auth_names
1173
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1174
+
1175
+ new_options = opts.merge(
1176
+ :operation => :"PlaidApi.bank_transfer_event_sync",
1177
+ :header_params => header_params,
1178
+ :query_params => query_params,
1179
+ :form_params => form_params,
1180
+ :body => post_body,
1181
+ :auth_names => auth_names,
1182
+ :return_type => return_type
1183
+ )
1184
+
1185
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1186
+ if @api_client.config.debugging
1187
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1188
+ end
1189
+ return data, status_code, headers
1190
+ end
1191
+
1192
+ # Retrieve a bank transfer
1193
+ # The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
1194
+ # @param bank_transfer_get_request [BankTransferGetRequest]
1195
+ # @param [Hash] opts the optional parameters
1196
+ # @return [BankTransferGetResponse]
1197
+ def bank_transfer_get(bank_transfer_get_request, opts = {})
1198
+ data, _status_code, _headers = bank_transfer_get_with_http_info(bank_transfer_get_request, opts)
1199
+ data
1200
+ end
1201
+
1202
+ # Retrieve a bank transfer
1203
+ # The &#x60;/bank_transfer/get&#x60; fetches information about the bank transfer corresponding to the given &#x60;bank_transfer_id&#x60;.
1204
+ # @param bank_transfer_get_request [BankTransferGetRequest]
1205
+ # @param [Hash] opts the optional parameters
1206
+ # @return [Array<(BankTransferGetResponse, Integer, Hash)>] BankTransferGetResponse data, response status code and response headers
1207
+ def bank_transfer_get_with_http_info(bank_transfer_get_request, opts = {})
1208
+ if @api_client.config.debugging
1209
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_get ...'
1210
+ end
1211
+ # verify the required parameter 'bank_transfer_get_request' is set
1212
+ if @api_client.config.client_side_validation && bank_transfer_get_request.nil?
1213
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_get_request' when calling PlaidApi.bank_transfer_get"
1214
+ end
1215
+ # resource path
1216
+ local_var_path = '/bank_transfer/get'
1217
+
1218
+ # query parameters
1219
+ query_params = opts[:query_params] || {}
1220
+
1221
+ # header parameters
1222
+ header_params = opts[:header_params] || {}
1223
+ # HTTP header 'Accept' (if needed)
1224
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1225
+ # HTTP header 'Content-Type'
1226
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1227
+
1228
+ # form parameters
1229
+ form_params = opts[:form_params] || {}
1230
+
1231
+ # http body (model)
1232
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_get_request)
1233
+
1234
+ # return_type
1235
+ return_type = opts[:debug_return_type] || 'BankTransferGetResponse'
1236
+
1237
+ # auth_names
1238
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1239
+
1240
+ new_options = opts.merge(
1241
+ :operation => :"PlaidApi.bank_transfer_get",
1242
+ :header_params => header_params,
1243
+ :query_params => query_params,
1244
+ :form_params => form_params,
1245
+ :body => post_body,
1246
+ :auth_names => auth_names,
1247
+ :return_type => return_type
1248
+ )
1249
+
1250
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1251
+ if @api_client.config.debugging
1252
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1253
+ end
1254
+ return data, status_code, headers
1255
+ end
1256
+
1257
+ # List bank transfers
1258
+ # Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
1259
+ # @param bank_transfer_list_request [BankTransferListRequest]
1260
+ # @param [Hash] opts the optional parameters
1261
+ # @return [BankTransferListResponse]
1262
+ def bank_transfer_list(bank_transfer_list_request, opts = {})
1263
+ data, _status_code, _headers = bank_transfer_list_with_http_info(bank_transfer_list_request, opts)
1264
+ data
1265
+ end
1266
+
1267
+ # List bank transfers
1268
+ # Use the &#x60;/bank_transfer/list&#x60; endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired bank transfers.
1269
+ # @param bank_transfer_list_request [BankTransferListRequest]
1270
+ # @param [Hash] opts the optional parameters
1271
+ # @return [Array<(BankTransferListResponse, Integer, Hash)>] BankTransferListResponse data, response status code and response headers
1272
+ def bank_transfer_list_with_http_info(bank_transfer_list_request, opts = {})
1273
+ if @api_client.config.debugging
1274
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_list ...'
1275
+ end
1276
+ # verify the required parameter 'bank_transfer_list_request' is set
1277
+ if @api_client.config.client_side_validation && bank_transfer_list_request.nil?
1278
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_list_request' when calling PlaidApi.bank_transfer_list"
1279
+ end
1280
+ # resource path
1281
+ local_var_path = '/bank_transfer/list'
1282
+
1283
+ # query parameters
1284
+ query_params = opts[:query_params] || {}
1285
+
1286
+ # header parameters
1287
+ header_params = opts[:header_params] || {}
1288
+ # HTTP header 'Accept' (if needed)
1289
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1290
+ # HTTP header 'Content-Type'
1291
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1292
+
1293
+ # form parameters
1294
+ form_params = opts[:form_params] || {}
1295
+
1296
+ # http body (model)
1297
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_list_request)
1298
+
1299
+ # return_type
1300
+ return_type = opts[:debug_return_type] || 'BankTransferListResponse'
1301
+
1302
+ # auth_names
1303
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1304
+
1305
+ new_options = opts.merge(
1306
+ :operation => :"PlaidApi.bank_transfer_list",
1307
+ :header_params => header_params,
1308
+ :query_params => query_params,
1309
+ :form_params => form_params,
1310
+ :body => post_body,
1311
+ :auth_names => auth_names,
1312
+ :return_type => return_type
1313
+ )
1314
+
1315
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1316
+ if @api_client.config.debugging
1317
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1318
+ end
1319
+ return data, status_code, headers
1320
+ end
1321
+
1322
+ # Migrate account into Bank Transfers
1323
+ # As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
1324
+ # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1325
+ # @param [Hash] opts the optional parameters
1326
+ # @return [BankTransferMigrateAccountResponse]
1327
+ def bank_transfer_migrate_account(bank_transfer_migrate_account_request, opts = {})
1328
+ data, _status_code, _headers = bank_transfer_migrate_account_with_http_info(bank_transfer_migrate_account_request, opts)
1329
+ data
1330
+ end
1331
+
1332
+ # Migrate account into Bank Transfers
1333
+ # As an alternative to adding Items via Link, you can also use the &#x60;/bank_transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/bank_transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
1334
+ # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1335
+ # @param [Hash] opts the optional parameters
1336
+ # @return [Array<(BankTransferMigrateAccountResponse, Integer, Hash)>] BankTransferMigrateAccountResponse data, response status code and response headers
1337
+ def bank_transfer_migrate_account_with_http_info(bank_transfer_migrate_account_request, opts = {})
1338
+ if @api_client.config.debugging
1339
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_migrate_account ...'
1340
+ end
1341
+ # verify the required parameter 'bank_transfer_migrate_account_request' is set
1342
+ if @api_client.config.client_side_validation && bank_transfer_migrate_account_request.nil?
1343
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_migrate_account_request' when calling PlaidApi.bank_transfer_migrate_account"
1344
+ end
1345
+ # resource path
1346
+ local_var_path = '/bank_transfer/migrate_account'
1347
+
1348
+ # query parameters
1349
+ query_params = opts[:query_params] || {}
1350
+
1351
+ # header parameters
1352
+ header_params = opts[:header_params] || {}
1353
+ # HTTP header 'Accept' (if needed)
1354
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1355
+ # HTTP header 'Content-Type'
1356
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1357
+
1358
+ # form parameters
1359
+ form_params = opts[:form_params] || {}
1360
+
1361
+ # http body (model)
1362
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_migrate_account_request)
1363
+
1364
+ # return_type
1365
+ return_type = opts[:debug_return_type] || 'BankTransferMigrateAccountResponse'
1366
+
1367
+ # auth_names
1368
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1369
+
1370
+ new_options = opts.merge(
1371
+ :operation => :"PlaidApi.bank_transfer_migrate_account",
1372
+ :header_params => header_params,
1373
+ :query_params => query_params,
1374
+ :form_params => form_params,
1375
+ :body => post_body,
1376
+ :auth_names => auth_names,
1377
+ :return_type => return_type
1378
+ )
1379
+
1380
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1381
+ if @api_client.config.debugging
1382
+ @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1383
+ end
1384
+ return data, status_code, headers
1385
+ end
1386
+
1387
+ # Get Categories
1388
+ # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1389
+ # @param body [Object]
1390
+ # @param [Hash] opts the optional parameters
1391
+ # @return [CategoriesGetResponse]
1392
+ def categories_get(body, opts = {})
1393
+ data, _status_code, _headers = categories_get_with_http_info(body, opts)
1394
+ data
1395
+ end
1396
+
1397
+ # Get Categories
1398
+ # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1399
+ # @param body [Object]
1400
+ # @param [Hash] opts the optional parameters
1401
+ # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
1402
+ def categories_get_with_http_info(body, opts = {})
1403
+ if @api_client.config.debugging
1404
+ @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
1405
+ end
1406
+ # verify the required parameter 'body' is set
1407
+ if @api_client.config.client_side_validation && body.nil?
1408
+ fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
1409
+ end
1410
+ # resource path
1411
+ local_var_path = '/categories/get'
1412
+
1413
+ # query parameters
1414
+ query_params = opts[:query_params] || {}
1415
+
1416
+ # header parameters
1417
+ header_params = opts[:header_params] || {}
1418
+ # HTTP header 'Accept' (if needed)
1419
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1420
+ # HTTP header 'Content-Type'
1421
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1422
+
1423
+ # form parameters
1424
+ form_params = opts[:form_params] || {}
1425
+
1426
+ # http body (model)
1427
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
1428
+
1429
+ # return_type
1430
+ return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
1431
+
1432
+ # auth_names
1433
+ auth_names = opts[:debug_auth_names] || []
1434
+
1435
+ new_options = opts.merge(
1436
+ :operation => :"PlaidApi.categories_get",
1437
+ :header_params => header_params,
1438
+ :query_params => query_params,
1439
+ :form_params => form_params,
1440
+ :body => post_body,
1441
+ :auth_names => auth_names,
1442
+ :return_type => return_type
1443
+ )
1444
+
1445
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1446
+ if @api_client.config.debugging
1447
+ @api_client.config.logger.debug "API called: PlaidApi#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1448
+ end
1449
+ return data, status_code, headers
1450
+ end
1451
+
1452
+ # Create payment token
1453
+ # The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
1454
+ # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
1455
+ # @param [Hash] opts the optional parameters
1456
+ # @return [PaymentInitiationPaymentTokenCreateResponse]
1457
+ def create_payment_token(payment_initiation_payment_token_create_request, opts = {})
1458
+ data, _status_code, _headers = create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts)
1459
+ data
1460
+ end
1461
+
1462
+ # Create payment token
1463
+ # The &#x60;/payment_initiation/payment/token/create&#x60; endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, &#x60;link_token&#x60;-based flow. The recommended flow is to provide the &#x60;payment_id&#x60; to &#x60;/link/token/create&#x60;, which returns a &#x60;link_token&#x60; used to initialize Link. The &#x60;/payment_initiation/payment/token/create&#x60; is used to create a &#x60;payment_token&#x60;, which can then be used in Link initialization to enter a payment initiation flow. You can only use a &#x60;payment_token&#x60; once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
1464
+ # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
1465
+ # @param [Hash] opts the optional parameters
1466
+ # @return [Array<(PaymentInitiationPaymentTokenCreateResponse, Integer, Hash)>] PaymentInitiationPaymentTokenCreateResponse data, response status code and response headers
1467
+ def create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts = {})
1468
+ if @api_client.config.debugging
1469
+ @api_client.config.logger.debug 'Calling API: PlaidApi.create_payment_token ...'
1470
+ end
1471
+ # verify the required parameter 'payment_initiation_payment_token_create_request' is set
1472
+ if @api_client.config.client_side_validation && payment_initiation_payment_token_create_request.nil?
1473
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_token_create_request' when calling PlaidApi.create_payment_token"
1474
+ end
1475
+ # resource path
1476
+ local_var_path = '/payment_initiation/payment/token/create'
1477
+
1478
+ # query parameters
1479
+ query_params = opts[:query_params] || {}
1480
+
1481
+ # header parameters
1482
+ header_params = opts[:header_params] || {}
1483
+ # HTTP header 'Accept' (if needed)
1484
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1485
+ # HTTP header 'Content-Type'
1486
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1487
+
1488
+ # form parameters
1489
+ form_params = opts[:form_params] || {}
1490
+
1491
+ # http body (model)
1492
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_token_create_request)
1493
+
1494
+ # return_type
1495
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentTokenCreateResponse'
1496
+
1497
+ # auth_names
1498
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1499
+
1500
+ new_options = opts.merge(
1501
+ :operation => :"PlaidApi.create_payment_token",
1502
+ :header_params => header_params,
1503
+ :query_params => query_params,
1504
+ :form_params => form_params,
1505
+ :body => post_body,
1506
+ :auth_names => auth_names,
1507
+ :return_type => return_type
1508
+ )
1509
+
1510
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1511
+ if @api_client.config.debugging
1512
+ @api_client.config.logger.debug "API called: PlaidApi#create_payment_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1513
+ end
1514
+ return data, status_code, headers
1515
+ end
1516
+
1517
+ # Create a deposit switch when not 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]
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @return [DepositSwitchAltCreateResponse]
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)
1524
+ data
1525
+ end
1526
+
1527
+ # Create a deposit switch when not using Plaid Exchange.&#39;
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]
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1532
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1533
+ if @api_client.config.debugging
1534
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
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
1540
+ # resource path
1541
+ local_var_path = '/deposit_switch/alt/create'
1542
+
1543
+ # query parameters
1544
+ query_params = opts[:query_params] || {}
1545
+
1546
+ # header parameters
1547
+ header_params = opts[:header_params] || {}
1548
+ # HTTP header 'Accept' (if needed)
1549
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1550
+ # HTTP header 'Content-Type'
1551
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1552
+
1553
+ # form parameters
1554
+ form_params = opts[:form_params] || {}
1555
+
1556
+ # http body (model)
1557
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
1558
+
1559
+ # return_type
1560
+ return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
1561
+
1562
+ # auth_names
1563
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1564
+
1565
+ new_options = opts.merge(
1566
+ :operation => :"PlaidApi.deposit_switch_alt_create",
1567
+ :header_params => header_params,
1568
+ :query_params => query_params,
1569
+ :form_params => form_params,
1570
+ :body => post_body,
1571
+ :auth_names => auth_names,
1572
+ :return_type => return_type
1573
+ )
1574
+
1575
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1576
+ if @api_client.config.debugging
1577
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1578
+ end
1579
+ return data, status_code, headers
1580
+ end
1581
+
1582
+ # Create a deposit switch
1583
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1584
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1585
+ # @param [Hash] opts the optional parameters
1586
+ # @return [DepositSwitchCreateResponse]
1587
+ def deposit_switch_create(deposit_switch_create_request, opts = {})
1588
+ data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
1589
+ data
1590
+ end
1591
+
1592
+ # Create a deposit switch
1593
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1594
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1595
+ # @param [Hash] opts the optional parameters
1596
+ # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
1597
+ def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
1598
+ if @api_client.config.debugging
1599
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
1600
+ end
1601
+ # verify the required parameter 'deposit_switch_create_request' is set
1602
+ if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
1603
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
1604
+ end
1605
+ # resource path
1606
+ local_var_path = '/deposit_switch/create'
1607
+
1608
+ # query parameters
1609
+ query_params = opts[:query_params] || {}
1610
+
1611
+ # header parameters
1612
+ header_params = opts[:header_params] || {}
1613
+ # HTTP header 'Accept' (if needed)
1614
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1615
+ # HTTP header 'Content-Type'
1616
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1617
+
1618
+ # form parameters
1619
+ form_params = opts[:form_params] || {}
1620
+
1621
+ # http body (model)
1622
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_create_request)
1623
+
1624
+ # return_type
1625
+ return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
1626
+
1627
+ # auth_names
1628
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1629
+
1630
+ new_options = opts.merge(
1631
+ :operation => :"PlaidApi.deposit_switch_create",
1632
+ :header_params => header_params,
1633
+ :query_params => query_params,
1634
+ :form_params => form_params,
1635
+ :body => post_body,
1636
+ :auth_names => auth_names,
1637
+ :return_type => return_type
1638
+ )
1639
+
1640
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1641
+ if @api_client.config.debugging
1642
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1643
+ end
1644
+ return data, status_code, headers
1645
+ end
1646
+
1647
+ # Retrieve a deposit switch
1648
+ # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
1649
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
1650
+ # @param [Hash] opts the optional parameters
1651
+ # @return [DepositSwitchGetResponse]
1652
+ def deposit_switch_get(deposit_switch_get_request, opts = {})
1653
+ data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
1654
+ data
1655
+ end
1656
+
1657
+ # Retrieve a deposit switch
1658
+ # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
1659
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
1660
+ # @param [Hash] opts the optional parameters
1661
+ # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
1662
+ def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
1663
+ if @api_client.config.debugging
1664
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
1665
+ end
1666
+ # verify the required parameter 'deposit_switch_get_request' is set
1667
+ if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
1668
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
1669
+ end
1670
+ # resource path
1671
+ local_var_path = '/deposit_switch/get'
1672
+
1673
+ # query parameters
1674
+ query_params = opts[:query_params] || {}
1675
+
1676
+ # header parameters
1677
+ header_params = opts[:header_params] || {}
1678
+ # HTTP header 'Accept' (if needed)
1679
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1680
+ # HTTP header 'Content-Type'
1681
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1682
+
1683
+ # form parameters
1684
+ form_params = opts[:form_params] || {}
1685
+
1686
+ # http body (model)
1687
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_get_request)
1688
+
1689
+ # return_type
1690
+ return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
1691
+
1692
+ # auth_names
1693
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1694
+
1695
+ new_options = opts.merge(
1696
+ :operation => :"PlaidApi.deposit_switch_get",
1697
+ :header_params => header_params,
1698
+ :query_params => query_params,
1699
+ :form_params => form_params,
1700
+ :body => post_body,
1701
+ :auth_names => auth_names,
1702
+ :return_type => return_type
1703
+ )
1704
+
1705
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1706
+ if @api_client.config.debugging
1707
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1708
+ end
1709
+ return data, status_code, headers
1710
+ end
1711
+
1712
+ # Create a deposit switch token
1713
+ # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
1714
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
1715
+ # @param [Hash] opts the optional parameters
1716
+ # @return [DepositSwitchTokenCreateResponse]
1717
+ def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
1718
+ data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
1719
+ data
1720
+ end
1721
+
1722
+ # Create a deposit switch token
1723
+ # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
1724
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
1725
+ # @param [Hash] opts the optional parameters
1726
+ # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
1727
+ def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
1728
+ if @api_client.config.debugging
1729
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
1730
+ end
1731
+ # verify the required parameter 'deposit_switch_token_create_request' is set
1732
+ if @api_client.config.client_side_validation && deposit_switch_token_create_request.nil?
1733
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_token_create_request' when calling PlaidApi.deposit_switch_token_create"
1734
+ end
1735
+ # resource path
1736
+ local_var_path = '/deposit_switch/token/create'
1737
+
1738
+ # query parameters
1739
+ query_params = opts[:query_params] || {}
1740
+
1741
+ # header parameters
1742
+ header_params = opts[:header_params] || {}
1743
+ # HTTP header 'Accept' (if needed)
1744
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1745
+ # HTTP header 'Content-Type'
1746
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1747
+
1748
+ # form parameters
1749
+ form_params = opts[:form_params] || {}
1750
+
1751
+ # http body (model)
1752
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_token_create_request)
1753
+
1754
+ # return_type
1755
+ return_type = opts[:debug_return_type] || 'DepositSwitchTokenCreateResponse'
1756
+
1757
+ # auth_names
1758
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1759
+
1760
+ new_options = opts.merge(
1761
+ :operation => :"PlaidApi.deposit_switch_token_create",
1762
+ :header_params => header_params,
1763
+ :query_params => query_params,
1764
+ :form_params => form_params,
1765
+ :body => post_body,
1766
+ :auth_names => auth_names,
1767
+ :return_type => return_type
1768
+ )
1769
+
1770
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1771
+ if @api_client.config.debugging
1772
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1773
+ end
1774
+ return data, status_code, headers
1775
+ end
1776
+
1777
+ # Search employer database
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 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.
1779
+ # @param employers_search_request [EmployersSearchRequest]
1780
+ # @param [Hash] opts the optional parameters
1781
+ # @return [EmployersSearchResponse]
1782
+ def employers_search(employers_search_request, opts = {})
1783
+ data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
1784
+ data
1785
+ end
1786
+
1787
+ # Search employer database
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 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.
1789
+ # @param employers_search_request [EmployersSearchRequest]
1790
+ # @param [Hash] opts the optional parameters
1791
+ # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
1792
+ def employers_search_with_http_info(employers_search_request, opts = {})
1793
+ if @api_client.config.debugging
1794
+ @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
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
1800
+ # resource path
1801
+ local_var_path = '/employers/search'
1802
+
1803
+ # query parameters
1804
+ query_params = opts[:query_params] || {}
1805
+
1806
+ # header parameters
1807
+ header_params = opts[:header_params] || {}
1808
+ # HTTP header 'Accept' (if needed)
1809
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1810
+ # HTTP header 'Content-Type'
1811
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1812
+
1813
+ # form parameters
1814
+ form_params = opts[:form_params] || {}
1815
+
1816
+ # http body (model)
1817
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)
1818
+
1819
+ # return_type
1820
+ return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
1821
+
1822
+ # auth_names
1823
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1824
+
1825
+ new_options = opts.merge(
1826
+ :operation => :"PlaidApi.employers_search",
1827
+ :header_params => header_params,
1828
+ :query_params => query_params,
1829
+ :form_params => form_params,
1830
+ :body => post_body,
1831
+ :auth_names => auth_names,
1832
+ :return_type => return_type
1833
+ )
1834
+
1835
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1836
+ if @api_client.config.debugging
1837
+ @api_client.config.logger.debug "API called: PlaidApi#employers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1838
+ end
1839
+ return data, status_code, headers
1840
+ end
1841
+
1842
+ # Retrieve identity data
1843
+ # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
1844
+ # @param identity_get_request [IdentityGetRequest]
1845
+ # @param [Hash] opts the optional parameters
1846
+ # @return [IdentityGetResponse]
1847
+ def identity_get(identity_get_request, opts = {})
1848
+ data, _status_code, _headers = identity_get_with_http_info(identity_get_request, opts)
1849
+ data
1850
+ end
1851
+
1852
+ # Retrieve identity data
1853
+ # The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
1854
+ # @param identity_get_request [IdentityGetRequest]
1855
+ # @param [Hash] opts the optional parameters
1856
+ # @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
1857
+ def identity_get_with_http_info(identity_get_request, opts = {})
1858
+ if @api_client.config.debugging
1859
+ @api_client.config.logger.debug 'Calling API: PlaidApi.identity_get ...'
1860
+ end
1861
+ # verify the required parameter 'identity_get_request' is set
1862
+ if @api_client.config.client_side_validation && identity_get_request.nil?
1863
+ fail ArgumentError, "Missing the required parameter 'identity_get_request' when calling PlaidApi.identity_get"
1864
+ end
1865
+ # resource path
1866
+ local_var_path = '/identity/get'
1867
+
1868
+ # query parameters
1869
+ query_params = opts[:query_params] || {}
1870
+
1871
+ # header parameters
1872
+ header_params = opts[:header_params] || {}
1873
+ # HTTP header 'Accept' (if needed)
1874
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1875
+ # HTTP header 'Content-Type'
1876
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1877
+
1878
+ # form parameters
1879
+ form_params = opts[:form_params] || {}
1880
+
1881
+ # http body (model)
1882
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_get_request)
1883
+
1884
+ # return_type
1885
+ return_type = opts[:debug_return_type] || 'IdentityGetResponse'
1886
+
1887
+ # auth_names
1888
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1889
+
1890
+ new_options = opts.merge(
1891
+ :operation => :"PlaidApi.identity_get",
1892
+ :header_params => header_params,
1893
+ :query_params => query_params,
1894
+ :form_params => form_params,
1895
+ :body => post_body,
1896
+ :auth_names => auth_names,
1897
+ :return_type => return_type
1898
+ )
1899
+
1900
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1901
+ if @api_client.config.debugging
1902
+ @api_client.config.logger.debug "API called: PlaidApi#identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
+ end
1904
+ return data, status_code, headers
1905
+ end
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 upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an `INCOME` webhook.
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 upload their income documents. Once the documents have been uploaded and parsed, Plaid will fire an &#x60;INCOME&#x60; webhook.
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
+
1972
+ # Download the original documents used for income verification
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. 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.
1974
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1975
+ # @param [Hash] opts the optional parameters
1976
+ # @return [File]
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)
1979
+ data
1980
+ end
1981
+
1982
+ # Download the original documents used for income verification
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. 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.
1984
+ # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
1985
+ # @param [Hash] opts the optional parameters
1986
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1987
+ def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
1988
+ if @api_client.config.debugging
1989
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
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
1995
+ # resource path
1996
+ local_var_path = '/income/verification/documents/download'
1997
+
1998
+ # query parameters
1999
+ query_params = opts[:query_params] || {}
2000
+
2001
+ # header parameters
2002
+ header_params = opts[:header_params] || {}
2003
+ # HTTP header 'Accept' (if needed)
2004
+ header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
2005
+ # HTTP header 'Content-Type'
2006
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2007
+
2008
+ # form parameters
2009
+ form_params = opts[:form_params] || {}
2010
+
2011
+ # http body (model)
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)
2013
+
2014
+ # return_type
2015
+ return_type = opts[:debug_return_type] || 'File'
2016
+
2017
+ # auth_names
2018
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2019
+
2020
+ new_options = opts.merge(
2021
+ :operation => :"PlaidApi.income_verification_documents_download",
2022
+ :header_params => header_params,
2023
+ :query_params => query_params,
2024
+ :form_params => form_params,
2025
+ :body => post_body,
2026
+ :auth_names => auth_names,
2027
+ :return_type => return_type
2028
+ )
2029
+
2030
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2031
+ if @api_client.config.debugging
2032
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2033
+ end
2034
+ return data, status_code, headers
2035
+ end
2036
+
2037
+ # Retrieve information from the paystub used for income verification
2038
+ # `/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.
2039
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2040
+ # @param [Hash] opts the optional parameters
2041
+ # @return [IncomeVerificationPaystubGetResponse]
2042
+ def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
2043
+ data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
2044
+ data
2045
+ end
2046
+
2047
+ # Retrieve information from the paystub used for income verification
2048
+ # &#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.
2049
+ # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2050
+ # @param [Hash] opts the optional parameters
2051
+ # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
2052
+ def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
2053
+ if @api_client.config.debugging
2054
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
2055
+ end
2056
+ # verify the required parameter 'income_verification_paystub_get_request' is set
2057
+ if @api_client.config.client_side_validation && income_verification_paystub_get_request.nil?
2058
+ fail ArgumentError, "Missing the required parameter 'income_verification_paystub_get_request' when calling PlaidApi.income_verification_paystub_get"
2059
+ end
2060
+ # resource path
2061
+ local_var_path = '/income/verification/paystub/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_paystub_get_request)
2078
+
2079
+ # return_type
2080
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
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_paystub_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_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2098
+ end
2099
+ return data, status_code, headers
2100
+ end
2101
+
2102
+ # Retrieve a summary of information derived from income verification
2103
+ # `/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.
2104
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2105
+ # @param [Hash] opts the optional parameters
2106
+ # @return [IncomeVerificationSummaryGetResponse]
2107
+ def income_verification_summary_get(income_verification_summary_get_request, opts = {})
2108
+ data, _status_code, _headers = income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts)
2109
+ data
2110
+ end
2111
+
2112
+ # Retrieve a summary of information derived from income verification
2113
+ # &#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.
2114
+ # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2115
+ # @param [Hash] opts the optional parameters
2116
+ # @return [Array<(IncomeVerificationSummaryGetResponse, Integer, Hash)>] IncomeVerificationSummaryGetResponse data, response status code and response headers
2117
+ def income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts = {})
2118
+ if @api_client.config.debugging
2119
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
2120
+ end
2121
+ # verify the required parameter 'income_verification_summary_get_request' is set
2122
+ if @api_client.config.client_side_validation && income_verification_summary_get_request.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'income_verification_summary_get_request' when calling PlaidApi.income_verification_summary_get"
2124
+ end
2125
+ # resource path
2126
+ local_var_path = '/income/verification/summary/get'
2127
+
2128
+ # query parameters
2129
+ query_params = opts[:query_params] || {}
2130
+
2131
+ # header parameters
2132
+ header_params = opts[:header_params] || {}
2133
+ # HTTP header 'Accept' (if needed)
2134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2135
+ # HTTP header 'Content-Type'
2136
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2137
+
2138
+ # form parameters
2139
+ form_params = opts[:form_params] || {}
2140
+
2141
+ # http body (model)
2142
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_summary_get_request)
2143
+
2144
+ # return_type
2145
+ return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
2146
+
2147
+ # auth_names
2148
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2149
+
2150
+ new_options = opts.merge(
2151
+ :operation => :"PlaidApi.income_verification_summary_get",
2152
+ :header_params => header_params,
2153
+ :query_params => query_params,
2154
+ :form_params => form_params,
2155
+ :body => post_body,
2156
+ :auth_names => auth_names,
2157
+ :return_type => return_type
2158
+ )
2159
+
2160
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2161
+ if @api_client.config.debugging
2162
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2163
+ end
2164
+ return data, status_code, headers
2165
+ end
2166
+
2167
+ # Get details of all supported institutions
2168
+ # 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.
2169
+ # @param institutions_get_request [InstitutionsGetRequest]
2170
+ # @param [Hash] opts the optional parameters
2171
+ # @return [InstitutionsGetResponse]
2172
+ def institutions_get(institutions_get_request, opts = {})
2173
+ data, _status_code, _headers = institutions_get_with_http_info(institutions_get_request, opts)
2174
+ data
2175
+ end
2176
+
2177
+ # Get details of all supported institutions
2178
+ # 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.
2179
+ # @param institutions_get_request [InstitutionsGetRequest]
2180
+ # @param [Hash] opts the optional parameters
2181
+ # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
2182
+ def institutions_get_with_http_info(institutions_get_request, opts = {})
2183
+ if @api_client.config.debugging
2184
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get ...'
2185
+ end
2186
+ # verify the required parameter 'institutions_get_request' is set
2187
+ if @api_client.config.client_side_validation && institutions_get_request.nil?
2188
+ fail ArgumentError, "Missing the required parameter 'institutions_get_request' when calling PlaidApi.institutions_get"
2189
+ end
2190
+ # resource path
2191
+ local_var_path = '/institutions/get'
2192
+
2193
+ # query parameters
2194
+ query_params = opts[:query_params] || {}
2195
+
2196
+ # header parameters
2197
+ header_params = opts[:header_params] || {}
2198
+ # HTTP header 'Accept' (if needed)
2199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2200
+ # HTTP header 'Content-Type'
2201
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2202
+
2203
+ # form parameters
2204
+ form_params = opts[:form_params] || {}
2205
+
2206
+ # http body (model)
2207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_request)
2208
+
2209
+ # return_type
2210
+ return_type = opts[:debug_return_type] || 'InstitutionsGetResponse'
2211
+
2212
+ # auth_names
2213
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2214
+
2215
+ new_options = opts.merge(
2216
+ :operation => :"PlaidApi.institutions_get",
2217
+ :header_params => header_params,
2218
+ :query_params => query_params,
2219
+ :form_params => form_params,
2220
+ :body => post_body,
2221
+ :auth_names => auth_names,
2222
+ :return_type => return_type
2223
+ )
2224
+
2225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2226
+ if @api_client.config.debugging
2227
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2228
+ end
2229
+ return data, status_code, headers
2230
+ end
2231
+
2232
+ # Get details of an institution
2233
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2234
+ # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2235
+ # @param [Hash] opts the optional parameters
2236
+ # @return [InstitutionsGetByIdResponse]
2237
+ def institutions_get_by_id(institutions_get_by_id_request, opts = {})
2238
+ data, _status_code, _headers = institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts)
2239
+ data
2240
+ end
2241
+
2242
+ # Get details of an institution
2243
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2244
+ # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2245
+ # @param [Hash] opts the optional parameters
2246
+ # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
2247
+ def institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts = {})
2248
+ if @api_client.config.debugging
2249
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get_by_id ...'
2250
+ end
2251
+ # verify the required parameter 'institutions_get_by_id_request' is set
2252
+ if @api_client.config.client_side_validation && institutions_get_by_id_request.nil?
2253
+ fail ArgumentError, "Missing the required parameter 'institutions_get_by_id_request' when calling PlaidApi.institutions_get_by_id"
2254
+ end
2255
+ # resource path
2256
+ local_var_path = '/institutions/get_by_id'
2257
+
2258
+ # query parameters
2259
+ query_params = opts[:query_params] || {}
2260
+
2261
+ # header parameters
2262
+ header_params = opts[:header_params] || {}
2263
+ # HTTP header 'Accept' (if needed)
2264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2265
+ # HTTP header 'Content-Type'
2266
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2267
+
2268
+ # form parameters
2269
+ form_params = opts[:form_params] || {}
2270
+
2271
+ # http body (model)
2272
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_by_id_request)
2273
+
2274
+ # return_type
2275
+ return_type = opts[:debug_return_type] || 'InstitutionsGetByIdResponse'
2276
+
2277
+ # auth_names
2278
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2279
+
2280
+ new_options = opts.merge(
2281
+ :operation => :"PlaidApi.institutions_get_by_id",
2282
+ :header_params => header_params,
2283
+ :query_params => query_params,
2284
+ :form_params => form_params,
2285
+ :body => post_body,
2286
+ :auth_names => auth_names,
2287
+ :return_type => return_type
2288
+ )
2289
+
2290
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2291
+ if @api_client.config.debugging
2292
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2293
+ end
2294
+ return data, status_code, headers
2295
+ end
2296
+
2297
+ # Search institutions
2298
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2299
+ # @param institutions_search_request [InstitutionsSearchRequest]
2300
+ # @param [Hash] opts the optional parameters
2301
+ # @return [InstitutionsSearchResponse]
2302
+ def institutions_search(institutions_search_request, opts = {})
2303
+ data, _status_code, _headers = institutions_search_with_http_info(institutions_search_request, opts)
2304
+ data
2305
+ end
2306
+
2307
+ # Search institutions
2308
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2309
+ # @param institutions_search_request [InstitutionsSearchRequest]
2310
+ # @param [Hash] opts the optional parameters
2311
+ # @return [Array<(InstitutionsSearchResponse, Integer, Hash)>] InstitutionsSearchResponse data, response status code and response headers
2312
+ def institutions_search_with_http_info(institutions_search_request, opts = {})
2313
+ if @api_client.config.debugging
2314
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_search ...'
2315
+ end
2316
+ # verify the required parameter 'institutions_search_request' is set
2317
+ if @api_client.config.client_side_validation && institutions_search_request.nil?
2318
+ fail ArgumentError, "Missing the required parameter 'institutions_search_request' when calling PlaidApi.institutions_search"
2319
+ end
2320
+ # resource path
2321
+ local_var_path = '/institutions/search'
2322
+
2323
+ # query parameters
2324
+ query_params = opts[:query_params] || {}
2325
+
2326
+ # header parameters
2327
+ header_params = opts[:header_params] || {}
2328
+ # HTTP header 'Accept' (if needed)
2329
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2330
+ # HTTP header 'Content-Type'
2331
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2332
+
2333
+ # form parameters
2334
+ form_params = opts[:form_params] || {}
2335
+
2336
+ # http body (model)
2337
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_search_request)
2338
+
2339
+ # return_type
2340
+ return_type = opts[:debug_return_type] || 'InstitutionsSearchResponse'
2341
+
2342
+ # auth_names
2343
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2344
+
2345
+ new_options = opts.merge(
2346
+ :operation => :"PlaidApi.institutions_search",
2347
+ :header_params => header_params,
2348
+ :query_params => query_params,
2349
+ :form_params => form_params,
2350
+ :body => post_body,
2351
+ :auth_names => auth_names,
2352
+ :return_type => return_type
2353
+ )
2354
+
2355
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2356
+ if @api_client.config.debugging
2357
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2358
+ end
2359
+ return data, status_code, headers
2360
+ end
2361
+
2362
+ # Get Investment holdings
2363
+ # The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
2364
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
2365
+ # @param [Hash] opts the optional parameters
2366
+ # @return [InvestmentsHoldingsGetResponse]
2367
+ def investments_holdings_get(investments_holdings_get_request, opts = {})
2368
+ data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
2369
+ data
2370
+ end
2371
+
2372
+ # Get Investment holdings
2373
+ # The &#x60;/investments/holdings/get&#x60; endpoint allows developers to receive user-authorized stock position data for &#x60;investment&#x60;-type accounts.
2374
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
2375
+ # @param [Hash] opts the optional parameters
2376
+ # @return [Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>] InvestmentsHoldingsGetResponse data, response status code and response headers
2377
+ def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
2378
+ if @api_client.config.debugging
2379
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
2380
+ end
2381
+ # verify the required parameter 'investments_holdings_get_request' is set
2382
+ if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
2383
+ fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
2384
+ end
2385
+ # resource path
2386
+ local_var_path = '/investments/holdings/get'
2387
+
2388
+ # query parameters
2389
+ query_params = opts[:query_params] || {}
2390
+
2391
+ # header parameters
2392
+ header_params = opts[:header_params] || {}
2393
+ # HTTP header 'Accept' (if needed)
2394
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2395
+ # HTTP header 'Content-Type'
2396
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2397
+
2398
+ # form parameters
2399
+ form_params = opts[:form_params] || {}
2400
+
2401
+ # http body (model)
2402
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)
2403
+
2404
+ # return_type
2405
+ return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'
2406
+
2407
+ # auth_names
2408
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2409
+
2410
+ new_options = opts.merge(
2411
+ :operation => :"PlaidApi.investments_holdings_get",
2412
+ :header_params => header_params,
2413
+ :query_params => query_params,
2414
+ :form_params => form_params,
2415
+ :body => post_body,
2416
+ :auth_names => auth_names,
2417
+ :return_type => return_type
2418
+ )
2419
+
2420
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2421
+ if @api_client.config.debugging
2422
+ @api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2423
+ end
2424
+ return data, status_code, headers
2425
+ end
2426
+
2427
+ # Get investment transactions
2428
+ # The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
2429
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
2430
+ # @param [Hash] opts the optional parameters
2431
+ # @return [InvestmentsTransactionsGetResponse]
2432
+ def investments_transactions_get(investments_transactions_get_request, opts = {})
2433
+ data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
2434
+ data
2435
+ end
2436
+
2437
+ # Get investment transactions
2438
+ # The &#x60;/investments/transactions/get&#x60; endpoint allows developers to retrieve user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions.
2439
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
2440
+ # @param [Hash] opts the optional parameters
2441
+ # @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
2442
+ def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
2443
+ if @api_client.config.debugging
2444
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
2445
+ end
2446
+ # verify the required parameter 'investments_transactions_get_request' is set
2447
+ if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
2448
+ fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
2449
+ end
2450
+ # resource path
2451
+ local_var_path = '/investments/transactions/get'
2452
+
2453
+ # query parameters
2454
+ query_params = opts[:query_params] || {}
2455
+
2456
+ # header parameters
2457
+ header_params = opts[:header_params] || {}
2458
+ # HTTP header 'Accept' (if needed)
2459
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2460
+ # HTTP header 'Content-Type'
2461
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2462
+
2463
+ # form parameters
2464
+ form_params = opts[:form_params] || {}
2465
+
2466
+ # http body (model)
2467
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)
2468
+
2469
+ # return_type
2470
+ return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'
2471
+
2472
+ # auth_names
2473
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2474
+
2475
+ new_options = opts.merge(
2476
+ :operation => :"PlaidApi.investments_transactions_get",
2477
+ :header_params => header_params,
2478
+ :query_params => query_params,
2479
+ :form_params => form_params,
2480
+ :body => post_body,
2481
+ :auth_names => auth_names,
2482
+ :return_type => return_type
2483
+ )
2484
+
2485
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2486
+ if @api_client.config.debugging
2487
+ @api_client.config.logger.debug "API called: PlaidApi#investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2488
+ end
2489
+ return data, status_code, headers
2490
+ end
2491
+
2492
+ # Invalidate access_token
2493
+ # By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
2494
+ # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest]
2495
+ # @param [Hash] opts the optional parameters
2496
+ # @return [ItemAccessTokenInvalidateResponse]
2497
+ def item_access_token_invalidate(item_access_token_invalidate_request, opts = {})
2498
+ data, _status_code, _headers = item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts)
2499
+ data
2500
+ end
2501
+
2502
+ # Invalidate access_token
2503
+ # By default, the &#x60;access_token&#x60; associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the &#x60;/item/access_token/invalidate&#x60; endpoint to rotate the &#x60;access_token&#x60; associated with an Item. The endpoint returns a new &#x60;access_token&#x60; and immediately invalidates the previous &#x60;access_token&#x60;.
2504
+ # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest]
2505
+ # @param [Hash] opts the optional parameters
2506
+ # @return [Array<(ItemAccessTokenInvalidateResponse, Integer, Hash)>] ItemAccessTokenInvalidateResponse data, response status code and response headers
2507
+ def item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts = {})
2508
+ if @api_client.config.debugging
2509
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_access_token_invalidate ...'
2510
+ end
2511
+ # verify the required parameter 'item_access_token_invalidate_request' is set
2512
+ if @api_client.config.client_side_validation && item_access_token_invalidate_request.nil?
2513
+ fail ArgumentError, "Missing the required parameter 'item_access_token_invalidate_request' when calling PlaidApi.item_access_token_invalidate"
2514
+ end
2515
+ # resource path
2516
+ local_var_path = '/item/access_token/invalidate'
2517
+
2518
+ # query parameters
2519
+ query_params = opts[:query_params] || {}
2520
+
2521
+ # header parameters
2522
+ header_params = opts[:header_params] || {}
2523
+ # HTTP header 'Accept' (if needed)
2524
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2525
+ # HTTP header 'Content-Type'
2526
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2527
+
2528
+ # form parameters
2529
+ form_params = opts[:form_params] || {}
2530
+
2531
+ # http body (model)
2532
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_access_token_invalidate_request)
2533
+
2534
+ # return_type
2535
+ return_type = opts[:debug_return_type] || 'ItemAccessTokenInvalidateResponse'
2536
+
2537
+ # auth_names
2538
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2539
+
2540
+ new_options = opts.merge(
2541
+ :operation => :"PlaidApi.item_access_token_invalidate",
2542
+ :header_params => header_params,
2543
+ :query_params => query_params,
2544
+ :form_params => form_params,
2545
+ :body => post_body,
2546
+ :auth_names => auth_names,
2547
+ :return_type => return_type
2548
+ )
2549
+
2550
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2551
+ if @api_client.config.debugging
2552
+ @api_client.config.logger.debug "API called: PlaidApi#item_access_token_invalidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2553
+ end
2554
+ return data, status_code, headers
2555
+ end
2556
+
2557
+ # Create public token
2558
+ # 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.
2559
+ # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2560
+ # @param [Hash] opts the optional parameters
2561
+ # @return [ItemPublicTokenCreateResponse]
2562
+ def item_create_public_token(item_public_token_create_request, opts = {})
2563
+ data, _status_code, _headers = item_create_public_token_with_http_info(item_public_token_create_request, opts)
2564
+ data
2565
+ end
2566
+
2567
+ # Create public token
2568
+ # 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.
2569
+ # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2570
+ # @param [Hash] opts the optional parameters
2571
+ # @return [Array<(ItemPublicTokenCreateResponse, Integer, Hash)>] ItemPublicTokenCreateResponse data, response status code and response headers
2572
+ def item_create_public_token_with_http_info(item_public_token_create_request, opts = {})
2573
+ if @api_client.config.debugging
2574
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_create_public_token ...'
2575
+ end
2576
+ # verify the required parameter 'item_public_token_create_request' is set
2577
+ if @api_client.config.client_side_validation && item_public_token_create_request.nil?
2578
+ fail ArgumentError, "Missing the required parameter 'item_public_token_create_request' when calling PlaidApi.item_create_public_token"
2579
+ end
2580
+ # resource path
2581
+ local_var_path = '/item/public_token/create'
2582
+
2583
+ # query parameters
2584
+ query_params = opts[:query_params] || {}
2585
+
2586
+ # header parameters
2587
+ header_params = opts[:header_params] || {}
2588
+ # HTTP header 'Accept' (if needed)
2589
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2590
+ # HTTP header 'Content-Type'
2591
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2592
+
2593
+ # form parameters
2594
+ form_params = opts[:form_params] || {}
2595
+
2596
+ # http body (model)
2597
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_create_request)
2598
+
2599
+ # return_type
2600
+ return_type = opts[:debug_return_type] || 'ItemPublicTokenCreateResponse'
2601
+
2602
+ # auth_names
2603
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2604
+
2605
+ new_options = opts.merge(
2606
+ :operation => :"PlaidApi.item_create_public_token",
2607
+ :header_params => header_params,
2608
+ :query_params => query_params,
2609
+ :form_params => form_params,
2610
+ :body => post_body,
2611
+ :auth_names => auth_names,
2612
+ :return_type => return_type
2613
+ )
2614
+
2615
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2616
+ if @api_client.config.debugging
2617
+ @api_client.config.logger.debug "API called: PlaidApi#item_create_public_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2618
+ end
2619
+ return data, status_code, headers
2620
+ end
2621
+
2622
+ # Retrieve an Item
2623
+ # Returns information about the status of an Item.
2624
+ # @param item_get_request [ItemGetRequest]
2625
+ # @param [Hash] opts the optional parameters
2626
+ # @return [ItemGetResponse]
2627
+ def item_get(item_get_request, opts = {})
2628
+ data, _status_code, _headers = item_get_with_http_info(item_get_request, opts)
2629
+ data
2630
+ end
2631
+
2632
+ # Retrieve an Item
2633
+ # Returns information about the status of an Item.
2634
+ # @param item_get_request [ItemGetRequest]
2635
+ # @param [Hash] opts the optional parameters
2636
+ # @return [Array<(ItemGetResponse, Integer, Hash)>] ItemGetResponse data, response status code and response headers
2637
+ def item_get_with_http_info(item_get_request, opts = {})
2638
+ if @api_client.config.debugging
2639
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_get ...'
2640
+ end
2641
+ # verify the required parameter 'item_get_request' is set
2642
+ if @api_client.config.client_side_validation && item_get_request.nil?
2643
+ fail ArgumentError, "Missing the required parameter 'item_get_request' when calling PlaidApi.item_get"
2644
+ end
2645
+ # resource path
2646
+ local_var_path = '/item/get'
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_get_request)
2663
+
2664
+ # return_type
2665
+ return_type = opts[:debug_return_type] || 'ItemGetResponse'
2666
+
2667
+ # auth_names
2668
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2669
+
2670
+ new_options = opts.merge(
2671
+ :operation => :"PlaidApi.item_get",
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_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2683
+ end
2684
+ return data, status_code, headers
2685
+ end
2686
+
2687
+ # Import Item
2688
+ # `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
2689
+ # @param item_import_request [ItemImportRequest]
2690
+ # @param [Hash] opts the optional parameters
2691
+ # @return [ItemImportResponse]
2692
+ def item_import(item_import_request, opts = {})
2693
+ data, _status_code, _headers = item_import_with_http_info(item_import_request, opts)
2694
+ data
2695
+ end
2696
+
2697
+ # Import Item
2698
+ # &#x60;/item/import&#x60; creates an Item via your Plaid Exchange Integration and returns an &#x60;access_token&#x60;. As part of an &#x60;/item/import&#x60; request, you will include a User ID (&#x60;user_auth.user_id&#x60;) and Authentication Token (&#x60;user_auth.auth_token&#x60;) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via &#x60;/item/import&#x60;, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (&#x60;target_account_id&#x60;).
2699
+ # @param item_import_request [ItemImportRequest]
2700
+ # @param [Hash] opts the optional parameters
2701
+ # @return [Array<(ItemImportResponse, Integer, Hash)>] ItemImportResponse data, response status code and response headers
2702
+ def item_import_with_http_info(item_import_request, opts = {})
2703
+ if @api_client.config.debugging
2704
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_import ...'
2705
+ end
2706
+ # verify the required parameter 'item_import_request' is set
2707
+ if @api_client.config.client_side_validation && item_import_request.nil?
2708
+ fail ArgumentError, "Missing the required parameter 'item_import_request' when calling PlaidApi.item_import"
2709
+ end
2710
+ # resource path
2711
+ local_var_path = '/item/import'
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_import_request)
2728
+
2729
+ # return_type
2730
+ return_type = opts[:debug_return_type] || 'ItemImportResponse'
2731
+
2732
+ # auth_names
2733
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2734
+
2735
+ new_options = opts.merge(
2736
+ :operation => :"PlaidApi.item_import",
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_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2748
+ end
2749
+ return data, status_code, headers
2750
+ end
2751
+
2752
+ # Exchange public token for an access token
2753
+ # Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
2754
+ # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
2755
+ # @param [Hash] opts the optional parameters
2756
+ # @return [ItemPublicTokenExchangeResponse]
2757
+ def item_public_token_exchange(item_public_token_exchange_request, opts = {})
2758
+ data, _status_code, _headers = item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts)
2759
+ data
2760
+ end
2761
+
2762
+ # Exchange public token for an access token
2763
+ # Exchange a Link &#x60;public_token&#x60; for an API &#x60;access_token&#x60;. Link hands off the &#x60;public_token&#x60; client-side via the &#x60;onSuccess&#x60; callback once a user has successfully created an Item. The &#x60;public_token&#x60; is ephemeral and expires after 30 minutes. The response also includes an &#x60;item_id&#x60; that should be stored with the &#x60;access_token&#x60;. The &#x60;item_id&#x60; is used to identify an Item in a webhook. The &#x60;item_id&#x60; can also be retrieved by making an &#x60;/item/get&#x60; request.
2764
+ # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
2765
+ # @param [Hash] opts the optional parameters
2766
+ # @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
2767
+ def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
2768
+ if @api_client.config.debugging
2769
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
2770
+ end
2771
+ # verify the required parameter 'item_public_token_exchange_request' is set
2772
+ if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
2773
+ fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
2774
+ end
2775
+ # resource path
2776
+ local_var_path = '/item/public_token/exchange'
2777
+
2778
+ # query parameters
2779
+ query_params = opts[:query_params] || {}
2780
+
2781
+ # header parameters
2782
+ header_params = opts[:header_params] || {}
2783
+ # HTTP header 'Accept' (if needed)
2784
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2785
+ # HTTP header 'Content-Type'
2786
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2787
+
2788
+ # form parameters
2789
+ form_params = opts[:form_params] || {}
2790
+
2791
+ # http body (model)
2792
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)
2793
+
2794
+ # return_type
2795
+ return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
2796
+
2797
+ # auth_names
2798
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2799
+
2800
+ new_options = opts.merge(
2801
+ :operation => :"PlaidApi.item_public_token_exchange",
2802
+ :header_params => header_params,
2803
+ :query_params => query_params,
2804
+ :form_params => form_params,
2805
+ :body => post_body,
2806
+ :auth_names => auth_names,
2807
+ :return_type => return_type
2808
+ )
2809
+
2810
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2811
+ if @api_client.config.debugging
2812
+ @api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2813
+ end
2814
+ return data, status_code, headers
2815
+ end
2816
+
2817
+ # Remove an Item
2818
+ # 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.
2819
+ # @param item_remove_request [ItemRemoveRequest]
2820
+ # @param [Hash] opts the optional parameters
2821
+ # @return [ItemRemoveResponse]
2822
+ def item_remove(item_remove_request, opts = {})
2823
+ data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
2824
+ data
2825
+ end
2826
+
2827
+ # Remove an Item
2828
+ # 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.
2829
+ # @param item_remove_request [ItemRemoveRequest]
2830
+ # @param [Hash] opts the optional parameters
2831
+ # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
2832
+ def item_remove_with_http_info(item_remove_request, opts = {})
2833
+ if @api_client.config.debugging
2834
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
2835
+ end
2836
+ # verify the required parameter 'item_remove_request' is set
2837
+ if @api_client.config.client_side_validation && item_remove_request.nil?
2838
+ fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
2839
+ end
2840
+ # resource path
2841
+ local_var_path = '/item/remove'
2842
+
2843
+ # query parameters
2844
+ query_params = opts[:query_params] || {}
2845
+
2846
+ # header parameters
2847
+ header_params = opts[:header_params] || {}
2848
+ # HTTP header 'Accept' (if needed)
2849
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2850
+ # HTTP header 'Content-Type'
2851
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2852
+
2853
+ # form parameters
2854
+ form_params = opts[:form_params] || {}
2855
+
2856
+ # http body (model)
2857
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)
2858
+
2859
+ # return_type
2860
+ return_type = opts[:debug_return_type] || 'ItemRemoveResponse'
2861
+
2862
+ # auth_names
2863
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2864
+
2865
+ new_options = opts.merge(
2866
+ :operation => :"PlaidApi.item_remove",
2867
+ :header_params => header_params,
2868
+ :query_params => query_params,
2869
+ :form_params => form_params,
2870
+ :body => post_body,
2871
+ :auth_names => auth_names,
2872
+ :return_type => return_type
2873
+ )
2874
+
2875
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2876
+ if @api_client.config.debugging
2877
+ @api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2878
+ end
2879
+ return data, status_code, headers
2880
+ end
2881
+
2882
+ # Update Webhook URL
2883
+ # 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.
2884
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2885
+ # @param [Hash] opts the optional parameters
2886
+ # @return [ItemWebhookUpdateResponse]
2887
+ def item_webhook_update(item_webhook_update_request, opts = {})
2888
+ data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
2889
+ data
2890
+ end
2891
+
2892
+ # Update Webhook URL
2893
+ # 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.
2894
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2895
+ # @param [Hash] opts the optional parameters
2896
+ # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
2897
+ def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
2898
+ if @api_client.config.debugging
2899
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
2900
+ end
2901
+ # verify the required parameter 'item_webhook_update_request' is set
2902
+ if @api_client.config.client_side_validation && item_webhook_update_request.nil?
2903
+ fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
2904
+ end
2905
+ # resource path
2906
+ local_var_path = '/item/webhook/update'
2907
+
2908
+ # query parameters
2909
+ query_params = opts[:query_params] || {}
2910
+
2911
+ # header parameters
2912
+ header_params = opts[:header_params] || {}
2913
+ # HTTP header 'Accept' (if needed)
2914
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2915
+ # HTTP header 'Content-Type'
2916
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2917
+
2918
+ # form parameters
2919
+ form_params = opts[:form_params] || {}
2920
+
2921
+ # http body (model)
2922
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)
2923
+
2924
+ # return_type
2925
+ return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'
2926
+
2927
+ # auth_names
2928
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2929
+
2930
+ new_options = opts.merge(
2931
+ :operation => :"PlaidApi.item_webhook_update",
2932
+ :header_params => header_params,
2933
+ :query_params => query_params,
2934
+ :form_params => form_params,
2935
+ :body => post_body,
2936
+ :auth_names => auth_names,
2937
+ :return_type => return_type
2938
+ )
2939
+
2940
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2941
+ if @api_client.config.debugging
2942
+ @api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2943
+ end
2944
+ return data, status_code, headers
2945
+ end
2946
+
2947
+ # Retrieve Liabilities data
2948
+ # 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.
2949
+ # @param liabilities_get_request [LiabilitiesGetRequest]
2950
+ # @param [Hash] opts the optional parameters
2951
+ # @return [LiabilitiesGetResponse]
2952
+ def liabilities_get(liabilities_get_request, opts = {})
2953
+ data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
2954
+ data
2955
+ end
2956
+
2957
+ # Retrieve Liabilities data
2958
+ # 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.
2959
+ # @param liabilities_get_request [LiabilitiesGetRequest]
2960
+ # @param [Hash] opts the optional parameters
2961
+ # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
2962
+ def liabilities_get_with_http_info(liabilities_get_request, opts = {})
2963
+ if @api_client.config.debugging
2964
+ @api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
2965
+ end
2966
+ # verify the required parameter 'liabilities_get_request' is set
2967
+ if @api_client.config.client_side_validation && liabilities_get_request.nil?
2968
+ fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
2969
+ end
2970
+ # resource path
2971
+ local_var_path = '/liabilities/get'
2972
+
2973
+ # query parameters
2974
+ query_params = opts[:query_params] || {}
2975
+
2976
+ # header parameters
2977
+ header_params = opts[:header_params] || {}
2978
+ # HTTP header 'Accept' (if needed)
2979
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2980
+ # HTTP header 'Content-Type'
2981
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2982
+
2983
+ # form parameters
2984
+ form_params = opts[:form_params] || {}
2985
+
2986
+ # http body (model)
2987
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)
2988
+
2989
+ # return_type
2990
+ return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'
2991
+
2992
+ # auth_names
2993
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2994
+
2995
+ new_options = opts.merge(
2996
+ :operation => :"PlaidApi.liabilities_get",
2997
+ :header_params => header_params,
2998
+ :query_params => query_params,
2999
+ :form_params => form_params,
3000
+ :body => post_body,
3001
+ :auth_names => auth_names,
3002
+ :return_type => return_type
3003
+ )
3004
+
3005
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3006
+ if @api_client.config.debugging
3007
+ @api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3008
+ end
3009
+ return data, status_code, headers
3010
+ end
3011
+
3012
+ # Create Link Token
3013
+ # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3014
+ # @param link_token_create_request [LinkTokenCreateRequest]
3015
+ # @param [Hash] opts the optional parameters
3016
+ # @return [LinkTokenCreateResponse]
3017
+ def link_token_create(link_token_create_request, opts = {})
3018
+ data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
3019
+ data
3020
+ end
3021
+
3022
+ # Create Link Token
3023
+ # The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;, which can then be exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3024
+ # @param link_token_create_request [LinkTokenCreateRequest]
3025
+ # @param [Hash] opts the optional parameters
3026
+ # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
3027
+ def link_token_create_with_http_info(link_token_create_request, opts = {})
3028
+ if @api_client.config.debugging
3029
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
3030
+ end
3031
+ # verify the required parameter 'link_token_create_request' is set
3032
+ if @api_client.config.client_side_validation && link_token_create_request.nil?
3033
+ fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
3034
+ end
3035
+ # resource path
3036
+ local_var_path = '/link/token/create'
3037
+
3038
+ # query parameters
3039
+ query_params = opts[:query_params] || {}
3040
+
3041
+ # header parameters
3042
+ header_params = opts[:header_params] || {}
3043
+ # HTTP header 'Accept' (if needed)
3044
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3045
+ # HTTP header 'Content-Type'
3046
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3047
+
3048
+ # form parameters
3049
+ form_params = opts[:form_params] || {}
3050
+
3051
+ # http body (model)
3052
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)
3053
+
3054
+ # return_type
3055
+ return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
3056
+
3057
+ # auth_names
3058
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3059
+
3060
+ new_options = opts.merge(
3061
+ :operation => :"PlaidApi.link_token_create",
3062
+ :header_params => header_params,
3063
+ :query_params => query_params,
3064
+ :form_params => form_params,
3065
+ :body => post_body,
3066
+ :auth_names => auth_names,
3067
+ :return_type => return_type
3068
+ )
3069
+
3070
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3071
+ if @api_client.config.debugging
3072
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3073
+ end
3074
+ return data, status_code, headers
3075
+ end
3076
+
3077
+ # Get Link Token
3078
+ # The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
3079
+ # @param link_token_get_request [LinkTokenGetRequest]
3080
+ # @param [Hash] opts the optional parameters
3081
+ # @return [LinkTokenGetResponse]
3082
+ def link_token_get(link_token_get_request, opts = {})
3083
+ data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
3084
+ data
3085
+ end
3086
+
3087
+ # Get Link Token
3088
+ # The &#x60;/link/token/get&#x60; endpoint gets information about a previously-created &#x60;link_token&#x60; using the &#x60;/link/token/create&#x60; endpoint. It can be useful for debugging purposes.
3089
+ # @param link_token_get_request [LinkTokenGetRequest]
3090
+ # @param [Hash] opts the optional parameters
3091
+ # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
3092
+ def link_token_get_with_http_info(link_token_get_request, opts = {})
3093
+ if @api_client.config.debugging
3094
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
3095
+ end
3096
+ # verify the required parameter 'link_token_get_request' is set
3097
+ if @api_client.config.client_side_validation && link_token_get_request.nil?
3098
+ fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
3099
+ end
3100
+ # resource path
3101
+ local_var_path = '/link/token/get'
3102
+
3103
+ # query parameters
3104
+ query_params = opts[:query_params] || {}
3105
+
3106
+ # header parameters
3107
+ header_params = opts[:header_params] || {}
3108
+ # HTTP header 'Accept' (if needed)
3109
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3110
+ # HTTP header 'Content-Type'
3111
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3112
+
3113
+ # form parameters
3114
+ form_params = opts[:form_params] || {}
3115
+
3116
+ # http body (model)
3117
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)
3118
+
3119
+ # return_type
3120
+ return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'
3121
+
3122
+ # auth_names
3123
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3124
+
3125
+ new_options = opts.merge(
3126
+ :operation => :"PlaidApi.link_token_get",
3127
+ :header_params => header_params,
3128
+ :query_params => query_params,
3129
+ :form_params => form_params,
3130
+ :body => post_body,
3131
+ :auth_names => auth_names,
3132
+ :return_type => return_type
3133
+ )
3134
+
3135
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3136
+ if @api_client.config.debugging
3137
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3138
+ end
3139
+ return data, status_code, headers
3140
+ end
3141
+
3142
+ # Create a payment
3143
+ # 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. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3144
+ # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3145
+ # @param [Hash] opts the optional parameters
3146
+ # @return [PaymentInitiationPaymentCreateResponse]
3147
+ def payment_initiation_payment_create(payment_initiation_payment_create_request, opts = {})
3148
+ data, _status_code, _headers = payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts)
3149
+ data
3150
+ end
3151
+
3152
+ # Create a payment
3153
+ # 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. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3154
+ # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3155
+ # @param [Hash] opts the optional parameters
3156
+ # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
3157
+ def payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts = {})
3158
+ if @api_client.config.debugging
3159
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_create ...'
3160
+ end
3161
+ # verify the required parameter 'payment_initiation_payment_create_request' is set
3162
+ if @api_client.config.client_side_validation && payment_initiation_payment_create_request.nil?
3163
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_create_request' when calling PlaidApi.payment_initiation_payment_create"
3164
+ end
3165
+ # resource path
3166
+ local_var_path = '/payment_initiation/payment/create'
3167
+
3168
+ # query parameters
3169
+ query_params = opts[:query_params] || {}
3170
+
3171
+ # header parameters
3172
+ header_params = opts[:header_params] || {}
3173
+ # HTTP header 'Accept' (if needed)
3174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3175
+ # HTTP header 'Content-Type'
3176
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3177
+
3178
+ # form parameters
3179
+ form_params = opts[:form_params] || {}
3180
+
3181
+ # http body (model)
3182
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_create_request)
3183
+
3184
+ # return_type
3185
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentCreateResponse'
3186
+
3187
+ # auth_names
3188
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3189
+
3190
+ new_options = opts.merge(
3191
+ :operation => :"PlaidApi.payment_initiation_payment_create",
3192
+ :header_params => header_params,
3193
+ :query_params => query_params,
3194
+ :form_params => form_params,
3195
+ :body => post_body,
3196
+ :auth_names => auth_names,
3197
+ :return_type => return_type
3198
+ )
3199
+
3200
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3201
+ if @api_client.config.debugging
3202
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3203
+ end
3204
+ return data, status_code, headers
3205
+ end
3206
+
3207
+ # Get payment details
3208
+ # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
3209
+ # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
3210
+ # @param [Hash] opts the optional parameters
3211
+ # @return [PaymentInitiationPaymentGetResponse]
3212
+ def payment_initiation_payment_get(payment_initiation_payment_get_request, opts = {})
3213
+ data, _status_code, _headers = payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts)
3214
+ data
3215
+ end
3216
+
3217
+ # Get payment details
3218
+ # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
3219
+ # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
3220
+ # @param [Hash] opts the optional parameters
3221
+ # @return [Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>] PaymentInitiationPaymentGetResponse data, response status code and response headers
3222
+ def payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts = {})
3223
+ if @api_client.config.debugging
3224
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_get ...'
3225
+ end
3226
+ # verify the required parameter 'payment_initiation_payment_get_request' is set
3227
+ if @api_client.config.client_side_validation && payment_initiation_payment_get_request.nil?
3228
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_get_request' when calling PlaidApi.payment_initiation_payment_get"
3229
+ end
3230
+ # resource path
3231
+ local_var_path = '/payment_initiation/payment/get'
3232
+
3233
+ # query parameters
3234
+ query_params = opts[:query_params] || {}
3235
+
3236
+ # header parameters
3237
+ header_params = opts[:header_params] || {}
3238
+ # HTTP header 'Accept' (if needed)
3239
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3240
+ # HTTP header 'Content-Type'
3241
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3242
+
3243
+ # form parameters
3244
+ form_params = opts[:form_params] || {}
3245
+
3246
+ # http body (model)
3247
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_get_request)
3248
+
3249
+ # return_type
3250
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentGetResponse'
3251
+
3252
+ # auth_names
3253
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3254
+
3255
+ new_options = opts.merge(
3256
+ :operation => :"PlaidApi.payment_initiation_payment_get",
3257
+ :header_params => header_params,
3258
+ :query_params => query_params,
3259
+ :form_params => form_params,
3260
+ :body => post_body,
3261
+ :auth_names => auth_names,
3262
+ :return_type => return_type
3263
+ )
3264
+
3265
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3266
+ if @api_client.config.debugging
3267
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3268
+ end
3269
+ return data, status_code, headers
3270
+ end
3271
+
3272
+ # List payments
3273
+ # The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.
3274
+ # @param payment_initiation_payment_list_request [PaymentInitiationPaymentListRequest]
3275
+ # @param [Hash] opts the optional parameters
3276
+ # @return [PaymentInitiationPaymentListResponse]
3277
+ def payment_initiation_payment_list(payment_initiation_payment_list_request, opts = {})
3278
+ data, _status_code, _headers = payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts)
3279
+ data
3280
+ end
3281
+
3282
+ # List payments
3283
+ # The &#x60;/payment_initiation/payment/list&#x60; endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional &#x60;count&#x60; and &#x60;cursor&#x60; parameters.
3284
+ # @param payment_initiation_payment_list_request [PaymentInitiationPaymentListRequest]
3285
+ # @param [Hash] opts the optional parameters
3286
+ # @return [Array<(PaymentInitiationPaymentListResponse, Integer, Hash)>] PaymentInitiationPaymentListResponse data, response status code and response headers
3287
+ def payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts = {})
3288
+ if @api_client.config.debugging
3289
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_list ...'
3290
+ end
3291
+ # verify the required parameter 'payment_initiation_payment_list_request' is set
3292
+ if @api_client.config.client_side_validation && payment_initiation_payment_list_request.nil?
3293
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_list_request' when calling PlaidApi.payment_initiation_payment_list"
3294
+ end
3295
+ # resource path
3296
+ local_var_path = '/payment_initiation/payment/list'
3297
+
3298
+ # query parameters
3299
+ query_params = opts[:query_params] || {}
3300
+
3301
+ # header parameters
3302
+ header_params = opts[:header_params] || {}
3303
+ # HTTP header 'Accept' (if needed)
3304
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3305
+ # HTTP header 'Content-Type'
3306
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3307
+
3308
+ # form parameters
3309
+ form_params = opts[:form_params] || {}
3310
+
3311
+ # http body (model)
3312
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_list_request)
3313
+
3314
+ # return_type
3315
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentListResponse'
3316
+
3317
+ # auth_names
3318
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3319
+
3320
+ new_options = opts.merge(
3321
+ :operation => :"PlaidApi.payment_initiation_payment_list",
3322
+ :header_params => header_params,
3323
+ :query_params => query_params,
3324
+ :form_params => form_params,
3325
+ :body => post_body,
3326
+ :auth_names => auth_names,
3327
+ :return_type => return_type
3328
+ )
3329
+
3330
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3331
+ if @api_client.config.debugging
3332
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3333
+ end
3334
+ return data, status_code, headers
3335
+ end
3336
+
3337
+ # Create payment recipient
3338
+ # 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`.
3339
+ # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3340
+ # @param [Hash] opts the optional parameters
3341
+ # @return [PaymentInitiationRecipientCreateResponse]
3342
+ def payment_initiation_recipient_create(payment_initiation_recipient_create_request, opts = {})
3343
+ data, _status_code, _headers = payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts)
3344
+ data
3345
+ end
3346
+
3347
+ # Create payment recipient
3348
+ # 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;.
3349
+ # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3350
+ # @param [Hash] opts the optional parameters
3351
+ # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
3352
+ def payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts = {})
3353
+ if @api_client.config.debugging
3354
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_create ...'
3355
+ end
3356
+ # verify the required parameter 'payment_initiation_recipient_create_request' is set
3357
+ if @api_client.config.client_side_validation && payment_initiation_recipient_create_request.nil?
3358
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_create_request' when calling PlaidApi.payment_initiation_recipient_create"
3359
+ end
3360
+ # resource path
3361
+ local_var_path = '/payment_initiation/recipient/create'
3362
+
3363
+ # query parameters
3364
+ query_params = opts[:query_params] || {}
3365
+
3366
+ # header parameters
3367
+ header_params = opts[:header_params] || {}
3368
+ # HTTP header 'Accept' (if needed)
3369
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3370
+ # HTTP header 'Content-Type'
3371
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3372
+
3373
+ # form parameters
3374
+ form_params = opts[:form_params] || {}
3375
+
3376
+ # http body (model)
3377
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_create_request)
3378
+
3379
+ # return_type
3380
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientCreateResponse'
3381
+
3382
+ # auth_names
3383
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3384
+
3385
+ new_options = opts.merge(
3386
+ :operation => :"PlaidApi.payment_initiation_recipient_create",
3387
+ :header_params => header_params,
3388
+ :query_params => query_params,
3389
+ :form_params => form_params,
3390
+ :body => post_body,
3391
+ :auth_names => auth_names,
3392
+ :return_type => return_type
3393
+ )
3394
+
3395
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3396
+ if @api_client.config.debugging
3397
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3398
+ end
3399
+ return data, status_code, headers
3400
+ end
3401
+
3402
+ # Get payment recipient
3403
+ # Get details about a payment recipient you have previously created.
3404
+ # @param payment_initiation_recipient_get_request [PaymentInitiationRecipientGetRequest]
3405
+ # @param [Hash] opts the optional parameters
3406
+ # @return [PaymentInitiationRecipientGetResponse]
3407
+ def payment_initiation_recipient_get(payment_initiation_recipient_get_request, opts = {})
3408
+ data, _status_code, _headers = payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts)
3409
+ data
3410
+ end
3411
+
3412
+ # Get payment recipient
3413
+ # Get details about a payment recipient you have previously created.
3414
+ # @param payment_initiation_recipient_get_request [PaymentInitiationRecipientGetRequest]
3415
+ # @param [Hash] opts the optional parameters
3416
+ # @return [Array<(PaymentInitiationRecipientGetResponse, Integer, Hash)>] PaymentInitiationRecipientGetResponse data, response status code and response headers
3417
+ def payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts = {})
3418
+ if @api_client.config.debugging
3419
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_get ...'
3420
+ end
3421
+ # verify the required parameter 'payment_initiation_recipient_get_request' is set
3422
+ if @api_client.config.client_side_validation && payment_initiation_recipient_get_request.nil?
3423
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_get_request' when calling PlaidApi.payment_initiation_recipient_get"
3424
+ end
3425
+ # resource path
3426
+ local_var_path = '/payment_initiation/recipient/get'
3427
+
3428
+ # query parameters
3429
+ query_params = opts[:query_params] || {}
3430
+
3431
+ # header parameters
3432
+ header_params = opts[:header_params] || {}
3433
+ # HTTP header 'Accept' (if needed)
3434
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3435
+ # HTTP header 'Content-Type'
3436
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3437
+
3438
+ # form parameters
3439
+ form_params = opts[:form_params] || {}
3440
+
3441
+ # http body (model)
3442
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_get_request)
3443
+
3444
+ # return_type
3445
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientGetResponse'
3446
+
3447
+ # auth_names
3448
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3449
+
3450
+ new_options = opts.merge(
3451
+ :operation => :"PlaidApi.payment_initiation_recipient_get",
3452
+ :header_params => header_params,
3453
+ :query_params => query_params,
3454
+ :form_params => form_params,
3455
+ :body => post_body,
3456
+ :auth_names => auth_names,
3457
+ :return_type => return_type
3458
+ )
3459
+
3460
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3461
+ if @api_client.config.debugging
3462
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3463
+ end
3464
+ return data, status_code, headers
3465
+ end
3466
+
3467
+ # List payment recipients
3468
+ # The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
3469
+ # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
3470
+ # @param [Hash] opts the optional parameters
3471
+ # @return [PaymentInitiationRecipientListResponse]
3472
+ def payment_initiation_recipient_list(payment_initiation_recipient_list_request, opts = {})
3473
+ data, _status_code, _headers = payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts)
3474
+ data
3475
+ end
3476
+
3477
+ # List payment recipients
3478
+ # The &#x60;/payment_initiation/recipient/list&#x60; endpoint list the payment recipients that you have previously created.
3479
+ # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
3480
+ # @param [Hash] opts the optional parameters
3481
+ # @return [Array<(PaymentInitiationRecipientListResponse, Integer, Hash)>] PaymentInitiationRecipientListResponse data, response status code and response headers
3482
+ def payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts = {})
3483
+ if @api_client.config.debugging
3484
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_list ...'
3485
+ end
3486
+ # verify the required parameter 'payment_initiation_recipient_list_request' is set
3487
+ if @api_client.config.client_side_validation && payment_initiation_recipient_list_request.nil?
3488
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_list_request' when calling PlaidApi.payment_initiation_recipient_list"
3489
+ end
3490
+ # resource path
3491
+ local_var_path = '/payment_initiation/recipient/list'
3492
+
3493
+ # query parameters
3494
+ query_params = opts[:query_params] || {}
3495
+
3496
+ # header parameters
3497
+ header_params = opts[:header_params] || {}
3498
+ # HTTP header 'Accept' (if needed)
3499
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3500
+ # HTTP header 'Content-Type'
3501
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3502
+
3503
+ # form parameters
3504
+ form_params = opts[:form_params] || {}
3505
+
3506
+ # http body (model)
3507
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_list_request)
3508
+
3509
+ # return_type
3510
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientListResponse'
3511
+
3512
+ # auth_names
3513
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3514
+
3515
+ new_options = opts.merge(
3516
+ :operation => :"PlaidApi.payment_initiation_recipient_list",
3517
+ :header_params => header_params,
3518
+ :query_params => query_params,
3519
+ :form_params => form_params,
3520
+ :body => post_body,
3521
+ :auth_names => auth_names,
3522
+ :return_type => return_type
3523
+ )
3524
+
3525
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3526
+ if @api_client.config.debugging
3527
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3528
+ end
3529
+ return data, status_code, headers
3530
+ end
3531
+
3532
+ # Create Apex bank account token
3533
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3534
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3535
+ # @param [Hash] opts the optional parameters
3536
+ # @return [ProcessorTokenCreateResponse]
3537
+ def processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {})
3538
+ data, _status_code, _headers = processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts)
3539
+ data
3540
+ end
3541
+
3542
+ # Create Apex bank account token
3543
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3544
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3545
+ # @param [Hash] opts the optional parameters
3546
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3547
+ def processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {})
3548
+ if @api_client.config.debugging
3549
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_apex_processor_token_create ...'
3550
+ end
3551
+ # verify the required parameter 'processor_apex_processor_token_create_request' is set
3552
+ if @api_client.config.client_side_validation && processor_apex_processor_token_create_request.nil?
3553
+ fail ArgumentError, "Missing the required parameter 'processor_apex_processor_token_create_request' when calling PlaidApi.processor_apex_processor_token_create"
3554
+ end
3555
+ # resource path
3556
+ local_var_path = '/processor/apex/processor_token/create'
3557
+
3558
+ # query parameters
3559
+ query_params = opts[:query_params] || {}
3560
+
3561
+ # header parameters
3562
+ header_params = opts[:header_params] || {}
3563
+ # HTTP header 'Accept' (if needed)
3564
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3565
+ # HTTP header 'Content-Type'
3566
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3567
+
3568
+ # form parameters
3569
+ form_params = opts[:form_params] || {}
3570
+
3571
+ # http body (model)
3572
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_apex_processor_token_create_request)
3573
+
3574
+ # return_type
3575
+ return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
3576
+
3577
+ # auth_names
3578
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3579
+
3580
+ new_options = opts.merge(
3581
+ :operation => :"PlaidApi.processor_apex_processor_token_create",
3582
+ :header_params => header_params,
3583
+ :query_params => query_params,
3584
+ :form_params => form_params,
3585
+ :body => post_body,
3586
+ :auth_names => auth_names,
3587
+ :return_type => return_type
3588
+ )
3589
+
3590
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3591
+ if @api_client.config.debugging
3592
+ @api_client.config.logger.debug "API called: PlaidApi#processor_apex_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3593
+ end
3594
+ return data, status_code, headers
3595
+ end
3596
+
3597
+ # Retrieve Auth data
3598
+ # The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.
3599
+ # @param processor_auth_get_request [ProcessorAuthGetRequest]
3600
+ # @param [Hash] opts the optional parameters
3601
+ # @return [ProcessorAuthGetResponse]
3602
+ def processor_auth_get(processor_auth_get_request, opts = {})
3603
+ data, _status_code, _headers = processor_auth_get_with_http_info(processor_auth_get_request, opts)
3604
+ data
3605
+ end
3606
+
3607
+ # Retrieve Auth data
3608
+ # The &#x60;/processor/auth/get&#x60; endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that&#39;s associated with a given &#x60;processor_token&#x60;. The endpoint also returns high-level account data and balances when available.
3609
+ # @param processor_auth_get_request [ProcessorAuthGetRequest]
3610
+ # @param [Hash] opts the optional parameters
3611
+ # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
3612
+ def processor_auth_get_with_http_info(processor_auth_get_request, opts = {})
3613
+ if @api_client.config.debugging
3614
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_auth_get ...'
3615
+ end
3616
+ # verify the required parameter 'processor_auth_get_request' is set
3617
+ if @api_client.config.client_side_validation && processor_auth_get_request.nil?
3618
+ fail ArgumentError, "Missing the required parameter 'processor_auth_get_request' when calling PlaidApi.processor_auth_get"
3619
+ end
3620
+ # resource path
3621
+ local_var_path = '/processor/auth/get'
3622
+
3623
+ # query parameters
3624
+ query_params = opts[:query_params] || {}
3625
+
3626
+ # header parameters
3627
+ header_params = opts[:header_params] || {}
3628
+ # HTTP header 'Accept' (if needed)
3629
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3630
+ # HTTP header 'Content-Type'
3631
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3632
+
3633
+ # form parameters
3634
+ form_params = opts[:form_params] || {}
3635
+
3636
+ # http body (model)
3637
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_auth_get_request)
3638
+
3639
+ # return_type
3640
+ return_type = opts[:debug_return_type] || 'ProcessorAuthGetResponse'
3641
+
3642
+ # auth_names
3643
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3644
+
3645
+ new_options = opts.merge(
3646
+ :operation => :"PlaidApi.processor_auth_get",
3647
+ :header_params => header_params,
3648
+ :query_params => query_params,
3649
+ :form_params => form_params,
3650
+ :body => post_body,
3651
+ :auth_names => auth_names,
3652
+ :return_type => return_type
3653
+ )
3654
+
3655
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3656
+ if @api_client.config.debugging
3657
+ @api_client.config.logger.debug "API called: PlaidApi#processor_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3658
+ end
3659
+ return data, status_code, headers
3660
+ end
3661
+
3662
+ # Retrieve Balance data
3663
+ # The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
3664
+ # @param processor_balance_get_request [ProcessorBalanceGetRequest] The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of &#x60;null&#x60;.
3665
+ # @param [Hash] opts the optional parameters
3666
+ # @return [ProcessorBalanceGetResponse]
3667
+ def processor_balance_get(processor_balance_get_request, opts = {})
3668
+ data, _status_code, _headers = processor_balance_get_with_http_info(processor_balance_get_request, opts)
3669
+ data
3670
+ end
3671
+
3672
+ # Retrieve Balance data
3673
+ # The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts. While other endpoints may return a balance object, only &#x60;/processor/balance/get&#x60; forces the available and current balance fields to be refreshed rather than cached.
3674
+ # @param processor_balance_get_request [ProcessorBalanceGetRequest] The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of &#x60;null&#x60;.
3675
+ # @param [Hash] opts the optional parameters
3676
+ # @return [Array<(ProcessorBalanceGetResponse, Integer, Hash)>] ProcessorBalanceGetResponse data, response status code and response headers
3677
+ def processor_balance_get_with_http_info(processor_balance_get_request, opts = {})
3678
+ if @api_client.config.debugging
3679
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_balance_get ...'
3680
+ end
3681
+ # verify the required parameter 'processor_balance_get_request' is set
3682
+ if @api_client.config.client_side_validation && processor_balance_get_request.nil?
3683
+ fail ArgumentError, "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get"
3684
+ end
3685
+ # resource path
3686
+ local_var_path = '/processor/balance/get'
3687
+
3688
+ # query parameters
3689
+ query_params = opts[:query_params] || {}
3690
+
3691
+ # header parameters
3692
+ header_params = opts[:header_params] || {}
3693
+ # HTTP header 'Accept' (if needed)
3694
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3695
+ # HTTP header 'Content-Type'
3696
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3697
+
3698
+ # form parameters
3699
+ form_params = opts[:form_params] || {}
3700
+
3701
+ # http body (model)
3702
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_balance_get_request)
3703
+
3704
+ # return_type
3705
+ return_type = opts[:debug_return_type] || 'ProcessorBalanceGetResponse'
3706
+
3707
+ # auth_names
3708
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3709
+
3710
+ new_options = opts.merge(
3711
+ :operation => :"PlaidApi.processor_balance_get",
3712
+ :header_params => header_params,
3713
+ :query_params => query_params,
3714
+ :form_params => form_params,
3715
+ :body => post_body,
3716
+ :auth_names => auth_names,
3717
+ :return_type => return_type
3718
+ )
3719
+
3720
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3721
+ if @api_client.config.debugging
3722
+ @api_client.config.logger.debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3723
+ end
3724
+ return data, status_code, headers
3725
+ end
3726
+
3727
+ # Retrieve Identity data
3728
+ # 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.
3729
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
3730
+ # @param [Hash] opts the optional parameters
3731
+ # @return [ProcessorIdentityGetResponse]
3732
+ def processor_identity_get(processor_identity_get_request, opts = {})
3733
+ data, _status_code, _headers = processor_identity_get_with_http_info(processor_identity_get_request, opts)
3734
+ data
3735
+ end
3736
+
3737
+ # Retrieve Identity data
3738
+ # The &#x60;/processor/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
3739
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
3740
+ # @param [Hash] opts the optional parameters
3741
+ # @return [Array<(ProcessorIdentityGetResponse, Integer, Hash)>] ProcessorIdentityGetResponse data, response status code and response headers
3742
+ def processor_identity_get_with_http_info(processor_identity_get_request, opts = {})
3743
+ if @api_client.config.debugging
3744
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_get ...'
3745
+ end
3746
+ # verify the required parameter 'processor_identity_get_request' is set
3747
+ if @api_client.config.client_side_validation && processor_identity_get_request.nil?
3748
+ fail ArgumentError, "Missing the required parameter 'processor_identity_get_request' when calling PlaidApi.processor_identity_get"
3749
+ end
3750
+ # resource path
3751
+ local_var_path = '/processor/identity/get'
3752
+
3753
+ # query parameters
3754
+ query_params = opts[:query_params] || {}
3755
+
3756
+ # header parameters
3757
+ header_params = opts[:header_params] || {}
3758
+ # HTTP header 'Accept' (if needed)
3759
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3760
+ # HTTP header 'Content-Type'
3761
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3762
+
3763
+ # form parameters
3764
+ form_params = opts[:form_params] || {}
3765
+
3766
+ # http body (model)
3767
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_get_request)
3768
+
3769
+ # return_type
3770
+ return_type = opts[:debug_return_type] || 'ProcessorIdentityGetResponse'
3771
+
3772
+ # auth_names
3773
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3774
+
3775
+ new_options = opts.merge(
3776
+ :operation => :"PlaidApi.processor_identity_get",
3777
+ :header_params => header_params,
3778
+ :query_params => query_params,
3779
+ :form_params => form_params,
3780
+ :body => post_body,
3781
+ :auth_names => auth_names,
3782
+ :return_type => return_type
3783
+ )
3784
+
3785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3786
+ if @api_client.config.debugging
3787
+ @api_client.config.logger.debug "API called: PlaidApi#processor_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3788
+ end
3789
+ return data, status_code, headers
3790
+ end
3791
+
3792
+ # Create Stripe bank account token
3793
+ # 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/).
3794
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3795
+ # @param [Hash] opts the optional parameters
3796
+ # @return [ProcessorStripeBankAccountTokenCreateResponse]
3797
+ def processor_stripe_bank_account_token_create(processor_stripe_bank_account_token_create_request, opts = {})
3798
+ data, _status_code, _headers = processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts)
3799
+ data
3800
+ end
3801
+
3802
+ # Create Stripe bank account token
3803
+ # 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/).
3804
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3805
+ # @param [Hash] opts the optional parameters
3806
+ # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
3807
+ def processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts = {})
3808
+ if @api_client.config.debugging
3809
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_stripe_bank_account_token_create ...'
3810
+ end
3811
+ # verify the required parameter 'processor_stripe_bank_account_token_create_request' is set
3812
+ if @api_client.config.client_side_validation && processor_stripe_bank_account_token_create_request.nil?
3813
+ fail ArgumentError, "Missing the required parameter 'processor_stripe_bank_account_token_create_request' when calling PlaidApi.processor_stripe_bank_account_token_create"
3814
+ end
3815
+ # resource path
3816
+ local_var_path = '/processor/stripe/bank_account_token/create'
3817
+
3818
+ # query parameters
3819
+ query_params = opts[:query_params] || {}
3820
+
3821
+ # header parameters
3822
+ header_params = opts[:header_params] || {}
3823
+ # HTTP header 'Accept' (if needed)
3824
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3825
+ # HTTP header 'Content-Type'
3826
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3827
+
3828
+ # form parameters
3829
+ form_params = opts[:form_params] || {}
3830
+
3831
+ # http body (model)
3832
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_stripe_bank_account_token_create_request)
3833
+
3834
+ # return_type
3835
+ return_type = opts[:debug_return_type] || 'ProcessorStripeBankAccountTokenCreateResponse'
3836
+
3837
+ # auth_names
3838
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3839
+
3840
+ new_options = opts.merge(
3841
+ :operation => :"PlaidApi.processor_stripe_bank_account_token_create",
3842
+ :header_params => header_params,
3843
+ :query_params => query_params,
3844
+ :form_params => form_params,
3845
+ :body => post_body,
3846
+ :auth_names => auth_names,
3847
+ :return_type => return_type
3848
+ )
3849
+
3850
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3851
+ if @api_client.config.debugging
3852
+ @api_client.config.logger.debug "API called: PlaidApi#processor_stripe_bank_account_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3853
+ end
3854
+ return data, status_code, headers
3855
+ end
3856
+
3857
+ # Create processor token
3858
+ # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations.
3859
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
3860
+ # @param [Hash] opts the optional parameters
3861
+ # @return [ProcessorTokenCreateResponse]
3862
+ def processor_token_create(processor_token_create_request, opts = {})
3863
+ data, _status_code, _headers = processor_token_create_with_http_info(processor_token_create_request, opts)
3864
+ data
3865
+ end
3866
+
3867
+ # Create processor token
3868
+ # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations.
3869
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
3870
+ # @param [Hash] opts the optional parameters
3871
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3872
+ def processor_token_create_with_http_info(processor_token_create_request, opts = {})
3873
+ if @api_client.config.debugging
3874
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_create ...'
3875
+ end
3876
+ # verify the required parameter 'processor_token_create_request' is set
3877
+ if @api_client.config.client_side_validation && processor_token_create_request.nil?
3878
+ fail ArgumentError, "Missing the required parameter 'processor_token_create_request' when calling PlaidApi.processor_token_create"
3879
+ end
3880
+ # resource path
3881
+ local_var_path = '/processor/token/create'
3882
+
3883
+ # query parameters
3884
+ query_params = opts[:query_params] || {}
3885
+
3886
+ # header parameters
3887
+ header_params = opts[:header_params] || {}
3888
+ # HTTP header 'Accept' (if needed)
3889
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3890
+ # HTTP header 'Content-Type'
3891
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3892
+
3893
+ # form parameters
3894
+ form_params = opts[:form_params] || {}
3895
+
3896
+ # http body (model)
3897
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_create_request)
3898
+
3899
+ # return_type
3900
+ return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
3901
+
3902
+ # auth_names
3903
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3904
+
3905
+ new_options = opts.merge(
3906
+ :operation => :"PlaidApi.processor_token_create",
3907
+ :header_params => header_params,
3908
+ :query_params => query_params,
3909
+ :form_params => form_params,
3910
+ :body => post_body,
3911
+ :auth_names => auth_names,
3912
+ :return_type => return_type
3913
+ )
3914
+
3915
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3916
+ if @api_client.config.debugging
3917
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3918
+ end
3919
+ return data, status_code, headers
3920
+ end
3921
+
3922
+ # Manually fire a Bank Transfer webhook
3923
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3924
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3925
+ # @param [Hash] opts the optional parameters
3926
+ # @return [SandboxBankTransferFireWebhookResponse]
3927
+ def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
3928
+ data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
3929
+ data
3930
+ end
3931
+
3932
+ # Manually fire a Bank Transfer webhook
3933
+ # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3934
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3935
+ # @param [Hash] opts the optional parameters
3936
+ # @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
3937
+ def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
3938
+ if @api_client.config.debugging
3939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
3940
+ end
3941
+ # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
3942
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
3943
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
3944
+ end
3945
+ # resource path
3946
+ local_var_path = '/sandbox/bank_transfer/fire_webhook'
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(sandbox_bank_transfer_fire_webhook_request)
3963
+
3964
+ # return_type
3965
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
3966
+
3967
+ # auth_names
3968
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3969
+
3970
+ new_options = opts.merge(
3971
+ :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
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#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3983
+ end
3984
+ return data, status_code, headers
3985
+ end
3986
+
3987
+ # Simulate a bank transfer event in Sandbox
3988
+ # 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.
3989
+ # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
3990
+ # @param [Hash] opts the optional parameters
3991
+ # @return [SandboxBankTransferSimulateResponse]
3992
+ def sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request, opts = {})
3993
+ data, _status_code, _headers = sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts)
3994
+ data
3995
+ end
3996
+
3997
+ # Simulate a bank transfer event in Sandbox
3998
+ # Use the &#x60;/sandbox/bank_transfer/simulate&#x60; 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 &#x60;/bank_transfer/event/sync&#x60; or &#x60;/bank_transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
3999
+ # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
4000
+ # @param [Hash] opts the optional parameters
4001
+ # @return [Array<(SandboxBankTransferSimulateResponse, Integer, Hash)>] SandboxBankTransferSimulateResponse data, response status code and response headers
4002
+ def sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts = {})
4003
+ if @api_client.config.debugging
4004
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_simulate ...'
4005
+ end
4006
+ # verify the required parameter 'sandbox_bank_transfer_simulate_request' is set
4007
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_simulate_request.nil?
4008
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_simulate_request' when calling PlaidApi.sandbox_bank_transfer_simulate"
4009
+ end
4010
+ # resource path
4011
+ local_var_path = '/sandbox/bank_transfer/simulate'
4012
+
4013
+ # query parameters
4014
+ query_params = opts[:query_params] || {}
4015
+
4016
+ # header parameters
4017
+ header_params = opts[:header_params] || {}
4018
+ # HTTP header 'Accept' (if needed)
4019
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4020
+ # HTTP header 'Content-Type'
4021
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4022
+
4023
+ # form parameters
4024
+ form_params = opts[:form_params] || {}
4025
+
4026
+ # http body (model)
4027
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_simulate_request)
4028
+
4029
+ # return_type
4030
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferSimulateResponse'
4031
+
4032
+ # auth_names
4033
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4034
+
4035
+ new_options = opts.merge(
4036
+ :operation => :"PlaidApi.sandbox_bank_transfer_simulate",
4037
+ :header_params => header_params,
4038
+ :query_params => query_params,
4039
+ :form_params => form_params,
4040
+ :body => post_body,
4041
+ :auth_names => auth_names,
4042
+ :return_type => return_type
4043
+ )
4044
+
4045
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4046
+ if @api_client.config.debugging
4047
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4048
+ end
4049
+ return data, status_code, headers
4050
+ end
4051
+
4052
+ # Fire a test webhook
4053
+ # 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.
4054
+ # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4055
+ # @param [Hash] opts the optional parameters
4056
+ # @return [SandboxItemFireWebhookResponse]
4057
+ def sandbox_item_fire_webhook(sandbox_item_fire_webhook_request, opts = {})
4058
+ data, _status_code, _headers = sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts)
4059
+ data
4060
+ end
4061
+
4062
+ # Fire a test webhook
4063
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions &#x60;DEFAULT_UPDATE&#x60; webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result.
4064
+ # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4065
+ # @param [Hash] opts the optional parameters
4066
+ # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
4067
+ def sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts = {})
4068
+ if @api_client.config.debugging
4069
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_fire_webhook ...'
4070
+ end
4071
+ # verify the required parameter 'sandbox_item_fire_webhook_request' is set
4072
+ if @api_client.config.client_side_validation && sandbox_item_fire_webhook_request.nil?
4073
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_fire_webhook_request' when calling PlaidApi.sandbox_item_fire_webhook"
4074
+ end
4075
+ # resource path
4076
+ local_var_path = '/sandbox/item/fire_webhook'
4077
+
4078
+ # query parameters
4079
+ query_params = opts[:query_params] || {}
4080
+
4081
+ # header parameters
4082
+ header_params = opts[:header_params] || {}
4083
+ # HTTP header 'Accept' (if needed)
4084
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4085
+ # HTTP header 'Content-Type'
4086
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4087
+
4088
+ # form parameters
4089
+ form_params = opts[:form_params] || {}
4090
+
4091
+ # http body (model)
4092
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_fire_webhook_request)
4093
+
4094
+ # return_type
4095
+ return_type = opts[:debug_return_type] || 'SandboxItemFireWebhookResponse'
4096
+
4097
+ # auth_names
4098
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4099
+
4100
+ new_options = opts.merge(
4101
+ :operation => :"PlaidApi.sandbox_item_fire_webhook",
4102
+ :header_params => header_params,
4103
+ :query_params => query_params,
4104
+ :form_params => form_params,
4105
+ :body => post_body,
4106
+ :auth_names => auth_names,
4107
+ :return_type => return_type
4108
+ )
4109
+
4110
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4111
+ if @api_client.config.debugging
4112
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4113
+ end
4114
+ return data, status_code, headers
4115
+ end
4116
+
4117
+ # Force a Sandbox Item into an error state
4118
+ # `/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.
4119
+ # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
4120
+ # @param [Hash] opts the optional parameters
4121
+ # @return [SandboxItemResetLoginResponse]
4122
+ def sandbox_item_reset_login(sandbox_item_reset_login_request, opts = {})
4123
+ data, _status_code, _headers = sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts)
4124
+ data
4125
+ end
4126
+
4127
+ # Force a Sandbox Item into an error state
4128
+ # &#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.
4129
+ # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
4130
+ # @param [Hash] opts the optional parameters
4131
+ # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
4132
+ def sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts = {})
4133
+ if @api_client.config.debugging
4134
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_reset_login ...'
4135
+ end
4136
+ # verify the required parameter 'sandbox_item_reset_login_request' is set
4137
+ if @api_client.config.client_side_validation && sandbox_item_reset_login_request.nil?
4138
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login"
4139
+ end
4140
+ # resource path
4141
+ local_var_path = '/sandbox/item/reset_login'
4142
+
4143
+ # query parameters
4144
+ query_params = opts[:query_params] || {}
4145
+
4146
+ # header parameters
4147
+ header_params = opts[:header_params] || {}
4148
+ # HTTP header 'Accept' (if needed)
4149
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4150
+ # HTTP header 'Content-Type'
4151
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4152
+
4153
+ # form parameters
4154
+ form_params = opts[:form_params] || {}
4155
+
4156
+ # http body (model)
4157
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_reset_login_request)
4158
+
4159
+ # return_type
4160
+ return_type = opts[:debug_return_type] || 'SandboxItemResetLoginResponse'
4161
+
4162
+ # auth_names
4163
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4164
+
4165
+ new_options = opts.merge(
4166
+ :operation => :"PlaidApi.sandbox_item_reset_login",
4167
+ :header_params => header_params,
4168
+ :query_params => query_params,
4169
+ :form_params => form_params,
4170
+ :body => post_body,
4171
+ :auth_names => auth_names,
4172
+ :return_type => return_type
4173
+ )
4174
+
4175
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4176
+ if @api_client.config.debugging
4177
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4178
+ end
4179
+ return data, status_code, headers
4180
+ end
4181
+
4182
+ # Set verification status for Sandbox account
4183
+ # 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#).
4184
+ # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4185
+ # @param [Hash] opts the optional parameters
4186
+ # @return [SandboxItemSetVerificationStatusResponse]
4187
+ def sandbox_item_set_verification_status(sandbox_item_set_verification_status_request, opts = {})
4188
+ data, _status_code, _headers = sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts)
4189
+ data
4190
+ end
4191
+
4192
+ # Set verification status for Sandbox account
4193
+ # 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#).
4194
+ # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4195
+ # @param [Hash] opts the optional parameters
4196
+ # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
4197
+ def sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts = {})
4198
+ if @api_client.config.debugging
4199
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_set_verification_status ...'
4200
+ end
4201
+ # verify the required parameter 'sandbox_item_set_verification_status_request' is set
4202
+ if @api_client.config.client_side_validation && sandbox_item_set_verification_status_request.nil?
4203
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_set_verification_status_request' when calling PlaidApi.sandbox_item_set_verification_status"
4204
+ end
4205
+ # resource path
4206
+ local_var_path = '/sandbox/item/set_verification_status'
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_item_set_verification_status_request)
4223
+
4224
+ # return_type
4225
+ return_type = opts[:debug_return_type] || 'SandboxItemSetVerificationStatusResponse'
4226
+
4227
+ # auth_names
4228
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4229
+
4230
+ new_options = opts.merge(
4231
+ :operation => :"PlaidApi.sandbox_item_set_verification_status",
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_item_set_verification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4243
+ end
4244
+ return data, status_code, headers
4245
+ end
4246
+
4247
+ # Create a test Item and processor token
4248
+ # 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.
4249
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4250
+ # @param [Hash] opts the optional parameters
4251
+ # @return [SandboxProcessorTokenCreateResponse]
4252
+ def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
4253
+ data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
4254
+ data
4255
+ end
4256
+
4257
+ # Create a test Item and processor token
4258
+ # 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.
4259
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
4260
+ # @param [Hash] opts the optional parameters
4261
+ # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
4262
+ def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
4263
+ if @api_client.config.debugging
4264
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
4265
+ end
4266
+ # verify the required parameter 'sandbox_processor_token_create_request' is set
4267
+ if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
4268
+ fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
4269
+ end
4270
+ # resource path
4271
+ local_var_path = '/sandbox/processor_token/create'
4272
+
4273
+ # query parameters
4274
+ query_params = opts[:query_params] || {}
4275
+
4276
+ # header parameters
4277
+ header_params = opts[:header_params] || {}
4278
+ # HTTP header 'Accept' (if needed)
4279
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4280
+ # HTTP header 'Content-Type'
4281
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4282
+
4283
+ # form parameters
4284
+ form_params = opts[:form_params] || {}
4285
+
4286
+ # http body (model)
4287
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)
4288
+
4289
+ # return_type
4290
+ return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
4291
+
4292
+ # auth_names
4293
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4294
+
4295
+ new_options = opts.merge(
4296
+ :operation => :"PlaidApi.sandbox_processor_token_create",
4297
+ :header_params => header_params,
4298
+ :query_params => query_params,
4299
+ :form_params => form_params,
4300
+ :body => post_body,
4301
+ :auth_names => auth_names,
4302
+ :return_type => return_type
4303
+ )
4304
+
4305
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4306
+ if @api_client.config.debugging
4307
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4308
+ end
4309
+ return data, status_code, headers
4310
+ end
4311
+
4312
+ # Create a test Item
4313
+ # 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.
4314
+ # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4315
+ # @param [Hash] opts the optional parameters
4316
+ # @return [SandboxPublicTokenCreateResponse]
4317
+ def sandbox_public_token_create(sandbox_public_token_create_request, opts = {})
4318
+ data, _status_code, _headers = sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts)
4319
+ data
4320
+ end
4321
+
4322
+ # Create a test Item
4323
+ # 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.
4324
+ # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4325
+ # @param [Hash] opts the optional parameters
4326
+ # @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
4327
+ def sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts = {})
4328
+ if @api_client.config.debugging
4329
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_public_token_create ...'
4330
+ end
4331
+ # verify the required parameter 'sandbox_public_token_create_request' is set
4332
+ if @api_client.config.client_side_validation && sandbox_public_token_create_request.nil?
4333
+ fail ArgumentError, "Missing the required parameter 'sandbox_public_token_create_request' when calling PlaidApi.sandbox_public_token_create"
4334
+ end
4335
+ # resource path
4336
+ local_var_path = '/sandbox/public_token/create'
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_public_token_create_request)
4353
+
4354
+ # return_type
4355
+ return_type = opts[:debug_return_type] || 'SandboxPublicTokenCreateResponse'
4356
+
4357
+ # auth_names
4358
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4359
+
4360
+ new_options = opts.merge(
4361
+ :operation => :"PlaidApi.sandbox_public_token_create",
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_public_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4373
+ end
4374
+ return data, status_code, headers
4375
+ end
4376
+
4377
+ # Get transaction data
4378
+ # 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. 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`](/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.
4379
+ # @param transactions_get_request [TransactionsGetRequest]
4380
+ # @param [Hash] opts the optional parameters
4381
+ # @return [TransactionsGetResponse]
4382
+ def transactions_get(transactions_get_request, opts = {})
4383
+ data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
4384
+ data
4385
+ end
4386
+
4387
+ # Get transaction data
4388
+ # 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. 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;](/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.
4389
+ # @param transactions_get_request [TransactionsGetRequest]
4390
+ # @param [Hash] opts the optional parameters
4391
+ # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
4392
+ def transactions_get_with_http_info(transactions_get_request, opts = {})
4393
+ if @api_client.config.debugging
4394
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
4395
+ end
4396
+ # verify the required parameter 'transactions_get_request' is set
4397
+ if @api_client.config.client_side_validation && transactions_get_request.nil?
4398
+ fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
4399
+ end
4400
+ # resource path
4401
+ local_var_path = '/transactions/get'
4402
+
4403
+ # query parameters
4404
+ query_params = opts[:query_params] || {}
4405
+
4406
+ # header parameters
4407
+ header_params = opts[:header_params] || {}
4408
+ # HTTP header 'Accept' (if needed)
4409
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4410
+ # HTTP header 'Content-Type'
4411
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4412
+
4413
+ # form parameters
4414
+ form_params = opts[:form_params] || {}
4415
+
4416
+ # http body (model)
4417
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
4418
+
4419
+ # return_type
4420
+ return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
4421
+
4422
+ # auth_names
4423
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4424
+
4425
+ new_options = opts.merge(
4426
+ :operation => :"PlaidApi.transactions_get",
4427
+ :header_params => header_params,
4428
+ :query_params => query_params,
4429
+ :form_params => form_params,
4430
+ :body => post_body,
4431
+ :auth_names => auth_names,
4432
+ :return_type => return_type
4433
+ )
4434
+
4435
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4436
+ if @api_client.config.debugging
4437
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4438
+ end
4439
+ return data, status_code, headers
4440
+ end
4441
+
4442
+ # Refresh transaction data
4443
+ # `/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.
4444
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
4445
+ # @param [Hash] opts the optional parameters
4446
+ # @return [TransactionsRefreshResponse]
4447
+ def transactions_refresh(transactions_refresh_request, opts = {})
4448
+ data, _status_code, _headers = transactions_refresh_with_http_info(transactions_refresh_request, opts)
4449
+ data
4450
+ end
4451
+
4452
+ # Refresh transaction data
4453
+ # &#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.
4454
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
4455
+ # @param [Hash] opts the optional parameters
4456
+ # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
4457
+ def transactions_refresh_with_http_info(transactions_refresh_request, opts = {})
4458
+ if @api_client.config.debugging
4459
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_refresh ...'
4460
+ end
4461
+ # verify the required parameter 'transactions_refresh_request' is set
4462
+ if @api_client.config.client_side_validation && transactions_refresh_request.nil?
4463
+ fail ArgumentError, "Missing the required parameter 'transactions_refresh_request' when calling PlaidApi.transactions_refresh"
4464
+ end
4465
+ # resource path
4466
+ local_var_path = '/transactions/refresh'
4467
+
4468
+ # query parameters
4469
+ query_params = opts[:query_params] || {}
4470
+
4471
+ # header parameters
4472
+ header_params = opts[:header_params] || {}
4473
+ # HTTP header 'Accept' (if needed)
4474
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4475
+ # HTTP header 'Content-Type'
4476
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4477
+
4478
+ # form parameters
4479
+ form_params = opts[:form_params] || {}
4480
+
4481
+ # http body (model)
4482
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_refresh_request)
4483
+
4484
+ # return_type
4485
+ return_type = opts[:debug_return_type] || 'TransactionsRefreshResponse'
4486
+
4487
+ # auth_names
4488
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4489
+
4490
+ new_options = opts.merge(
4491
+ :operation => :"PlaidApi.transactions_refresh",
4492
+ :header_params => header_params,
4493
+ :query_params => query_params,
4494
+ :form_params => form_params,
4495
+ :body => post_body,
4496
+ :auth_names => auth_names,
4497
+ :return_type => return_type
4498
+ )
4499
+
4500
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4501
+ if @api_client.config.debugging
4502
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4503
+ end
4504
+ return data, status_code, headers
4505
+ end
4506
+
4507
+ # Get webhook verification key
4508
+ # Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
4509
+ # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
4510
+ # @param [Hash] opts the optional parameters
4511
+ # @return [WebhookVerificationKeyGetResponse]
4512
+ def webhook_verification_key_get(webhook_verification_key_get_request, opts = {})
4513
+ data, _status_code, _headers = webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts)
4514
+ data
4515
+ end
4516
+
4517
+ # Get webhook verification key
4518
+ # Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the &#x60;Plaid-Verification&#x60; header. The &#x60;/webhook_verification_key/get&#x60; endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
4519
+ # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
4520
+ # @param [Hash] opts the optional parameters
4521
+ # @return [Array<(WebhookVerificationKeyGetResponse, Integer, Hash)>] WebhookVerificationKeyGetResponse data, response status code and response headers
4522
+ def webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts = {})
4523
+ if @api_client.config.debugging
4524
+ @api_client.config.logger.debug 'Calling API: PlaidApi.webhook_verification_key_get ...'
4525
+ end
4526
+ # verify the required parameter 'webhook_verification_key_get_request' is set
4527
+ if @api_client.config.client_side_validation && webhook_verification_key_get_request.nil?
4528
+ fail ArgumentError, "Missing the required parameter 'webhook_verification_key_get_request' when calling PlaidApi.webhook_verification_key_get"
4529
+ end
4530
+ # resource path
4531
+ local_var_path = '/webhook_verification_key/get'
4532
+
4533
+ # query parameters
4534
+ query_params = opts[:query_params] || {}
4535
+
4536
+ # header parameters
4537
+ header_params = opts[:header_params] || {}
4538
+ # HTTP header 'Accept' (if needed)
4539
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4540
+ # HTTP header 'Content-Type'
4541
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4542
+
4543
+ # form parameters
4544
+ form_params = opts[:form_params] || {}
4545
+
4546
+ # http body (model)
4547
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_verification_key_get_request)
4548
+
4549
+ # return_type
4550
+ return_type = opts[:debug_return_type] || 'WebhookVerificationKeyGetResponse'
4551
+
4552
+ # auth_names
4553
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4554
+
4555
+ new_options = opts.merge(
4556
+ :operation => :"PlaidApi.webhook_verification_key_get",
4557
+ :header_params => header_params,
4558
+ :query_params => query_params,
4559
+ :form_params => form_params,
4560
+ :body => post_body,
4561
+ :auth_names => auth_names,
4562
+ :return_type => return_type
4563
+ )
4564
+
4565
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4566
+ if @api_client.config.debugging
4567
+ @api_client.config.logger.debug "API called: PlaidApi#webhook_verification_key_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4568
+ end
4569
+ return data, status_code, headers
4570
+ end
4571
+ end
4572
+ end