plaid 13.0.0 → 14.0.0.beta.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (687) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +81 -1
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +45 -36
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +2 -0
  8. data/PUBLISH.md +6 -7
  9. data/README.md +100 -92
  10. data/Rakefile +8 -79
  11. data/UPGRADING.md +4 -0
  12. data/docs/ACHClass.md +15 -0
  13. data/docs/APR.md +24 -0
  14. data/docs/AccountAssets.md +40 -0
  15. data/docs/AccountAssetsAllOf.md +24 -0
  16. data/docs/AccountBalance.md +26 -0
  17. data/docs/AccountBase.md +32 -0
  18. data/docs/AccountFiltersResponse.md +24 -0
  19. data/docs/AccountIdentity.md +34 -0
  20. data/docs/AccountIdentityAllOf.md +18 -0
  21. data/docs/AccountSubtype.md +15 -0
  22. data/docs/AccountType.md +15 -0
  23. data/docs/AccountsBalanceGetRequest.md +24 -0
  24. data/docs/AccountsBalanceGetRequestOptions.md +18 -0
  25. data/docs/AccountsGetRequest.md +24 -0
  26. data/docs/AccountsGetRequestOptions.md +18 -0
  27. data/docs/AccountsGetResponse.md +22 -0
  28. data/docs/Address.md +20 -0
  29. data/docs/AddressData.md +26 -0
  30. data/docs/Amount.md +20 -0
  31. data/docs/AssetReport.md +28 -0
  32. data/docs/AssetReportAuditCopyCreateRequest.md +24 -0
  33. data/docs/AssetReportAuditCopyCreateResponse.md +20 -0
  34. data/docs/AssetReportAuditCopyGetRequest.md +22 -0
  35. data/docs/AssetReportAuditCopyRemoveRequest.md +22 -0
  36. data/docs/AssetReportAuditCopyRemoveResponse.md +20 -0
  37. data/docs/AssetReportCreateRequest.md +26 -0
  38. data/docs/AssetReportCreateRequestOptions.md +22 -0
  39. data/docs/AssetReportCreateResponse.md +22 -0
  40. data/docs/AssetReportFilterRequest.md +24 -0
  41. data/docs/AssetReportFilterResponse.md +22 -0
  42. data/docs/AssetReportGetRequest.md +24 -0
  43. data/docs/AssetReportGetResponse.md +22 -0
  44. data/docs/AssetReportItem.md +26 -0
  45. data/docs/AssetReportPDFGetRequest.md +22 -0
  46. data/docs/AssetReportRefreshRequest.md +26 -0
  47. data/docs/AssetReportRefreshRequestOptions.md +22 -0
  48. data/docs/AssetReportRefreshResponse.md +22 -0
  49. data/docs/AssetReportRemoveRequest.md +22 -0
  50. data/docs/AssetReportRemoveResponse.md +20 -0
  51. data/docs/AssetReportTransaction.md +62 -0
  52. data/docs/AssetReportTransactionAllOf.md +20 -0
  53. data/docs/AssetReportUser.md +30 -0
  54. data/docs/AssetsErrorWebhook.md +24 -0
  55. data/docs/AssetsProductReadyWebhook.md +22 -0
  56. data/docs/AuthGetNumbers.md +24 -0
  57. data/docs/AuthGetRequest.md +24 -0
  58. data/docs/AuthGetRequestOptions.md +18 -0
  59. data/docs/AuthGetResponse.md +24 -0
  60. data/docs/AutomaticallyVerifiedWebhook.md +24 -0
  61. data/docs/BankTransfer.md +50 -0
  62. data/docs/BankTransferBalance.md +20 -0
  63. data/docs/BankTransferBalanceGetRequest.md +22 -0
  64. data/docs/BankTransferBalanceGetResponse.md +22 -0
  65. data/docs/BankTransferCancelRequest.md +22 -0
  66. data/docs/BankTransferCancelResponse.md +18 -0
  67. data/docs/BankTransferCreateRequest.md +46 -0
  68. data/docs/BankTransferCreateResponse.md +20 -0
  69. data/docs/BankTransferDirection.md +15 -0
  70. data/docs/BankTransferEvent.md +40 -0
  71. data/docs/BankTransferEventListRequest.md +40 -0
  72. data/docs/BankTransferEventListResponse.md +20 -0
  73. data/docs/BankTransferEventSyncRequest.md +24 -0
  74. data/docs/BankTransferEventSyncResponse.md +20 -0
  75. data/docs/BankTransferEventType.md +15 -0
  76. data/docs/BankTransferFailure.md +20 -0
  77. data/docs/BankTransferGetRequest.md +22 -0
  78. data/docs/BankTransferGetResponse.md +20 -0
  79. data/docs/BankTransferListRequest.md +32 -0
  80. data/docs/BankTransferListResponse.md +20 -0
  81. data/docs/BankTransferMigrateAccountRequest.md +26 -0
  82. data/docs/BankTransferMigrateAccountResponse.md +22 -0
  83. data/docs/BankTransferNetwork.md +15 -0
  84. data/docs/BankTransferReceiverDetails.md +18 -0
  85. data/docs/BankTransferStatus.md +15 -0
  86. data/docs/BankTransferType.md +15 -0
  87. data/docs/BankTransferUser.md +22 -0
  88. data/docs/BankTransfersEventsUpdateWebhook.md +20 -0
  89. data/docs/CategoriesGetResponse.md +20 -0
  90. data/docs/Category.md +22 -0
  91. data/docs/Cause.md +20 -0
  92. data/docs/CountryCode.md +15 -0
  93. data/docs/CreditCardLiability.md +34 -0
  94. data/docs/CreditFilter.md +18 -0
  95. data/docs/DefaultUpdateWebhook.md +26 -0
  96. data/docs/DepositSwitchAddressData.md +26 -0
  97. data/docs/DepositSwitchAltCreateRequest.md +24 -0
  98. data/docs/DepositSwitchAltCreateResponse.md +20 -0
  99. data/docs/DepositSwitchCreateRequest.md +24 -0
  100. data/docs/DepositSwitchCreateResponse.md +20 -0
  101. data/docs/DepositSwitchGetRequest.md +22 -0
  102. data/docs/DepositSwitchGetResponse.md +38 -0
  103. data/docs/DepositSwitchTargetAccount.md +24 -0
  104. data/docs/DepositSwitchTargetUser.md +28 -0
  105. data/docs/DepositSwitchTokenCreateRequest.md +22 -0
  106. data/docs/DepositSwitchTokenCreateResponse.md +22 -0
  107. data/docs/DepositoryFilter.md +18 -0
  108. data/docs/Email.md +22 -0
  109. data/docs/Employee.md +22 -0
  110. data/docs/EmployeeIncomeSummaryFieldString.md +20 -0
  111. data/docs/Employer.md +24 -0
  112. data/docs/EmployerIncomeSummaryFieldString.md +20 -0
  113. data/docs/EmployersSearchRequest.md +24 -0
  114. data/docs/EmployersSearchResponse.md +20 -0
  115. data/docs/Error.md +34 -0
  116. data/docs/ExternalPaymentSchedule.md +24 -0
  117. data/docs/ExternalPaymentScheduleGet.md +26 -0
  118. data/docs/HealthIncident.md +24 -0
  119. data/docs/HistoricalBalance.md +24 -0
  120. data/docs/HistoricalUpdateWebhook.md +26 -0
  121. data/docs/Holding.md +34 -0
  122. data/docs/HoldingsDefaultUpdateWebhook.md +28 -0
  123. data/docs/IdentityGetRequest.md +24 -0
  124. data/docs/IdentityGetRequestOptions.md +18 -0
  125. data/docs/IdentityGetResponse.md +22 -0
  126. data/docs/IncidentUpdate.md +22 -0
  127. data/docs/IncomeBreakdown.md +24 -0
  128. data/docs/IncomeSummary.md +30 -0
  129. data/docs/IncomeSummaryFieldNumber.md +20 -0
  130. data/docs/IncomeSummaryFieldString.md +20 -0
  131. data/docs/IncomeVerificationCreateRequest.md +22 -0
  132. data/docs/IncomeVerificationCreateResponse.md +20 -0
  133. data/docs/IncomeVerificationDocumentsDownloadRequest.md +22 -0
  134. data/docs/IncomeVerificationDocumentsDownloadResponse.md +18 -0
  135. data/docs/IncomeVerificationPaystubGetRequest.md +22 -0
  136. data/docs/IncomeVerificationPaystubGetResponse.md +20 -0
  137. data/docs/IncomeVerificationStatusWebhook.md +24 -0
  138. data/docs/IncomeVerificationSummaryGetRequest.md +22 -0
  139. data/docs/IncomeVerificationSummaryGetResponse.md +20 -0
  140. data/docs/IncomeVerificationWebhookStatus.md +18 -0
  141. data/docs/InflowModel.md +26 -0
  142. data/docs/InitialUpdateWebhook.md +26 -0
  143. data/docs/Institution.md +36 -0
  144. data/docs/InstitutionStatus.md +30 -0
  145. data/docs/InstitutionsGetByIdRequest.md +26 -0
  146. data/docs/InstitutionsGetByIdRequestOptions.md +20 -0
  147. data/docs/InstitutionsGetByIdResponse.md +20 -0
  148. data/docs/InstitutionsGetRequest.md +28 -0
  149. data/docs/InstitutionsGetRequestOptions.md +24 -0
  150. data/docs/InstitutionsGetResponse.md +22 -0
  151. data/docs/InstitutionsSearchAccountFilter.md +24 -0
  152. data/docs/InstitutionsSearchRequest.md +28 -0
  153. data/docs/InstitutionsSearchRequestOptions.md +20 -0
  154. data/docs/InstitutionsSearchResponse.md +20 -0
  155. data/docs/InvestmentFilter.md +18 -0
  156. data/docs/InvestmentHoldingsGetRequestOptions.md +18 -0
  157. data/docs/InvestmentTransaction.md +44 -0
  158. data/docs/InvestmentsDefaultUpdateWebhook.md +28 -0
  159. data/docs/InvestmentsHoldingsGetRequest.md +24 -0
  160. data/docs/InvestmentsHoldingsGetResponse.md +26 -0
  161. data/docs/InvestmentsTransactionsGetRequest.md +28 -0
  162. data/docs/InvestmentsTransactionsGetRequestOptions.md +22 -0
  163. data/docs/InvestmentsTransactionsGetResponse.md +28 -0
  164. data/docs/Item.md +32 -0
  165. data/docs/ItemAccessTokenInvalidateRequest.md +22 -0
  166. data/docs/ItemAccessTokenInvalidateResponse.md +20 -0
  167. data/docs/ItemErrorWebhook.md +24 -0
  168. data/docs/ItemGetRequest.md +22 -0
  169. data/docs/ItemGetResponse.md +24 -0
  170. data/docs/ItemImportRequest.md +26 -0
  171. data/docs/ItemImportRequestOptions.md +18 -0
  172. data/docs/ItemImportRequestUserAuth.md +20 -0
  173. data/docs/ItemImportResponse.md +20 -0
  174. data/docs/ItemProductReadyWebhook.md +24 -0
  175. data/docs/ItemPublicTokenCreateRequest.md +22 -0
  176. data/docs/ItemPublicTokenCreateResponse.md +22 -0
  177. data/docs/ItemPublicTokenExchangeRequest.md +22 -0
  178. data/docs/ItemPublicTokenExchangeResponse.md +22 -0
  179. data/docs/ItemRemoveRequest.md +22 -0
  180. data/docs/ItemRemoveResponse.md +18 -0
  181. data/docs/ItemStatus.md +22 -0
  182. data/docs/ItemWebhookUpdateRequest.md +24 -0
  183. data/docs/ItemWebhookUpdateResponse.md +20 -0
  184. data/docs/JWKPublicKey.md +34 -0
  185. data/docs/JWTHeader.md +18 -0
  186. data/docs/LiabilitiesGetRequest.md +24 -0
  187. data/docs/LiabilitiesGetRequestOptions.md +18 -0
  188. data/docs/LiabilitiesGetResponse.md +24 -0
  189. data/docs/LiabilitiesObject.md +22 -0
  190. data/docs/LiabilityOverride.md +66 -0
  191. data/docs/LinkTokenAccountFilters.md +24 -0
  192. data/docs/LinkTokenCreateRequest.md +52 -0
  193. data/docs/LinkTokenCreateRequestAccountSubtypes.md +24 -0
  194. data/docs/LinkTokenCreateRequestAuth.md +18 -0
  195. data/docs/LinkTokenCreateRequestDepositSwitch.md +18 -0
  196. data/docs/LinkTokenCreateRequestIncomeVerification.md +20 -0
  197. data/docs/LinkTokenCreateRequestPaymentInitiation.md +18 -0
  198. data/docs/LinkTokenCreateRequestUser.md +32 -0
  199. data/docs/LinkTokenCreateResponse.md +22 -0
  200. data/docs/LinkTokenGetMetadataResponse.md +30 -0
  201. data/docs/LinkTokenGetRequest.md +22 -0
  202. data/docs/LinkTokenGetResponse.md +26 -0
  203. data/docs/LoanFilter.md +18 -0
  204. data/docs/Location.md +32 -0
  205. data/docs/MFA.md +26 -0
  206. data/docs/Meta.md +22 -0
  207. data/docs/MortgageInterestRate.md +20 -0
  208. data/docs/MortgageLiability.md +56 -0
  209. data/docs/MortgagePropertyAddress.md +26 -0
  210. data/docs/NullableAccessToken.md +15 -0
  211. data/docs/NullableAddress.md +20 -0
  212. data/docs/NullableAddressData.md +26 -0
  213. data/docs/NullableItemStatus.md +22 -0
  214. data/docs/NullableNumbersACH.md +24 -0
  215. data/docs/NullableNumbersBACS.md +22 -0
  216. data/docs/NullableNumbersEFT.md +24 -0
  217. data/docs/NullableNumbersInternational.md +22 -0
  218. data/docs/NullableRecipientBACS.md +20 -0
  219. data/docs/Numbers.md +32 -0
  220. data/docs/NumbersACH.md +24 -0
  221. data/docs/NumbersBACS.md +22 -0
  222. data/docs/NumbersEFT.md +24 -0
  223. data/docs/NumbersInternational.md +22 -0
  224. data/docs/OverrideAccounts.md +38 -0
  225. data/docs/Owner.md +24 -0
  226. data/docs/OwnerOverride.md +24 -0
  227. data/docs/PSLFStatus.md +22 -0
  228. data/docs/PayFrequency.md +20 -0
  229. data/docs/PayPeriodDetails.md +26 -0
  230. data/docs/PaymentAmount.md +20 -0
  231. data/docs/PaymentInitiationAddress.md +24 -0
  232. data/docs/PaymentInitiationPaymentCreateRequest.md +28 -0
  233. data/docs/PaymentInitiationPaymentCreateResponse.md +22 -0
  234. data/docs/PaymentInitiationPaymentGetRequest.md +22 -0
  235. data/docs/PaymentInitiationPaymentGetResponse.md +34 -0
  236. data/docs/PaymentInitiationPaymentListRequest.md +24 -0
  237. data/docs/PaymentInitiationPaymentListResponse.md +22 -0
  238. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +22 -0
  239. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +22 -0
  240. data/docs/PaymentInitiationRecipient.md +26 -0
  241. data/docs/PaymentInitiationRecipientCreateRequest.md +28 -0
  242. data/docs/PaymentInitiationRecipientCreateResponse.md +20 -0
  243. data/docs/PaymentInitiationRecipientGetRequest.md +22 -0
  244. data/docs/PaymentInitiationRecipientGetResponse.md +28 -0
  245. data/docs/PaymentInitiationRecipientListRequest.md +20 -0
  246. data/docs/PaymentInitiationRecipientListResponse.md +20 -0
  247. data/docs/PaymentMeta.md +32 -0
  248. data/docs/PaymentStatusUpdateWebhook.md +38 -0
  249. data/docs/Paystub.md +30 -0
  250. data/docs/PaystubDeduction.md +22 -0
  251. data/docs/PaystubYTDDetails.md +20 -0
  252. data/docs/PendingExpirationWebhook.md +24 -0
  253. data/docs/PhoneNumber.md +22 -0
  254. data/docs/PlaidApi.md +5660 -0
  255. data/docs/ProcessorApexProcessorTokenCreateRequest.md +24 -0
  256. data/docs/ProcessorAuthGetRequest.md +22 -0
  257. data/docs/ProcessorAuthGetResponse.md +22 -0
  258. data/docs/ProcessorBalanceGetRequest.md +22 -0
  259. data/docs/ProcessorBalanceGetResponse.md +20 -0
  260. data/docs/ProcessorIdentityGetRequest.md +22 -0
  261. data/docs/ProcessorIdentityGetResponse.md +20 -0
  262. data/docs/ProcessorNumber.md +24 -0
  263. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +24 -0
  264. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +20 -0
  265. data/docs/ProcessorTokenCreateRequest.md +26 -0
  266. data/docs/ProcessorTokenCreateResponse.md +20 -0
  267. data/docs/ProductStatus.md +22 -0
  268. data/docs/ProductStatusBreakdown.md +24 -0
  269. data/docs/Products.md +15 -0
  270. data/docs/ProjectedIncomeSummaryFieldNumber.md +20 -0
  271. data/docs/RecaptchaRequiredError.md +30 -0
  272. data/docs/RecipientBACS.md +20 -0
  273. data/docs/SandboxBankTransferFireWebhookRequest.md +22 -0
  274. data/docs/SandboxBankTransferFireWebhookResponse.md +18 -0
  275. data/docs/SandboxBankTransferSimulateRequest.md +26 -0
  276. data/docs/SandboxBankTransferSimulateResponse.md +18 -0
  277. data/docs/SandboxItemFireWebhookRequest.md +24 -0
  278. data/docs/SandboxItemFireWebhookResponse.md +20 -0
  279. data/docs/SandboxItemResetLoginRequest.md +22 -0
  280. data/docs/SandboxItemResetLoginResponse.md +20 -0
  281. data/docs/SandboxItemSetVerificationStatusRequest.md +26 -0
  282. data/docs/SandboxItemSetVerificationStatusResponse.md +18 -0
  283. data/docs/SandboxProcessorTokenCreateRequest.md +24 -0
  284. data/docs/SandboxProcessorTokenCreateRequestOptions.md +20 -0
  285. data/docs/SandboxProcessorTokenCreateResponse.md +20 -0
  286. data/docs/SandboxPublicTokenCreateRequest.md +26 -0
  287. data/docs/SandboxPublicTokenCreateRequestOptions.md +24 -0
  288. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +20 -0
  289. data/docs/SandboxPublicTokenCreateResponse.md +20 -0
  290. data/docs/Security.md +46 -0
  291. data/docs/ServicerAddressData.md +26 -0
  292. data/docs/StandaloneAccountType.md +26 -0
  293. data/docs/StandaloneCurrencyCodeList.md +20 -0
  294. data/docs/StandaloneInvestmentTransactionSubtype.md +104 -0
  295. data/docs/StandaloneInvestmentTransactionType.md +28 -0
  296. data/docs/StudentLoan.md +66 -0
  297. data/docs/StudentLoanRepaymentModel.md +22 -0
  298. data/docs/StudentLoanStatus.md +20 -0
  299. data/docs/StudentRepaymentPlan.md +20 -0
  300. data/docs/Transaction.md +58 -0
  301. data/docs/TransactionCode.md +15 -0
  302. data/docs/TransactionData.md +26 -0
  303. data/docs/TransactionOverride.md +26 -0
  304. data/docs/TransactionsGetRequest.md +28 -0
  305. data/docs/TransactionsGetRequestOptions.md +22 -0
  306. data/docs/TransactionsGetResponse.md +26 -0
  307. data/docs/TransactionsRefreshRequest.md +22 -0
  308. data/docs/TransactionsRefreshResponse.md +18 -0
  309. data/docs/TransactionsRemovedWebhook.md +26 -0
  310. data/docs/UserCustomPassword.md +28 -0
  311. data/docs/UserPermissionRevokedWebhook.md +24 -0
  312. data/docs/VerificationExpiredWebhook.md +24 -0
  313. data/docs/VerificationStatus.md +15 -0
  314. data/docs/Warning.md +22 -0
  315. data/docs/WebhookUpdateAcknowledgedWebhook.md +26 -0
  316. data/docs/WebhookVerificationKeyGetRequest.md +22 -0
  317. data/docs/WebhookVerificationKeyGetResponse.md +20 -0
  318. data/docs/YTDGrossIncomeSummaryFieldNumber.md +20 -0
  319. data/docs/YTDNetIncomeSummaryFieldNumber.md +20 -0
  320. data/lib/plaid.rb +340 -61
  321. data/lib/plaid/api/plaid_api.rb +4483 -0
  322. data/lib/plaid/api_client.rb +383 -0
  323. data/lib/plaid/api_error.rb +57 -0
  324. data/lib/plaid/configuration.rb +297 -0
  325. data/lib/plaid/models/account_assets.rb +406 -0
  326. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  327. data/lib/plaid/models/account_balance.rb +269 -0
  328. data/lib/plaid/models/account_base.rb +345 -0
  329. data/lib/plaid/models/account_filters_response.rb +246 -0
  330. data/lib/plaid/models/account_identity.rb +369 -0
  331. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  332. data/lib/plaid/models/account_subtype.rb +101 -0
  333. data/lib/plaid/models/account_type.rb +41 -0
  334. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  335. data/lib/plaid/models/accounts_balance_get_request_options.rb +222 -0
  336. data/lib/plaid/models/accounts_get_request.rb +254 -0
  337. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  338. data/lib/plaid/models/accounts_get_response.rb +256 -0
  339. data/lib/plaid/models/ach_class.rb +50 -0
  340. data/lib/plaid/models/address.rb +235 -0
  341. data/lib/plaid/models/address_data.rb +277 -0
  342. data/lib/plaid/models/amount.rb +274 -0
  343. data/lib/plaid/models/apr.rb +296 -0
  344. data/lib/plaid/models/asset_report.rb +301 -0
  345. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  346. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  347. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  348. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  349. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  350. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  351. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  352. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  353. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  354. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  355. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  356. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  357. data/lib/plaid/models/asset_report_item.rb +287 -0
  358. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  359. data/lib/plaid/models/asset_report_refresh_request.rb +290 -0
  360. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  361. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  362. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  363. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  364. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  365. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  366. data/lib/plaid/models/asset_report_user.rb +287 -0
  367. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  368. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  369. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  370. data/lib/plaid/models/auth_get_request.rb +254 -0
  371. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  372. data/lib/plaid/models/auth_get_response.rb +270 -0
  373. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  374. data/lib/plaid/models/bank_transfer.rb +453 -0
  375. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  376. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  377. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  378. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  379. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  380. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  381. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  382. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  383. data/lib/plaid/models/bank_transfer_event.rb +390 -0
  384. data/lib/plaid/models/bank_transfer_event_list_request.rb +422 -0
  385. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  386. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  387. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  388. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  389. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  390. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  391. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  392. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  393. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  394. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  395. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  396. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  397. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  398. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  399. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  400. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  401. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  402. data/lib/plaid/models/categories_get_response.rb +242 -0
  403. data/lib/plaid/models/category.rb +257 -0
  404. data/lib/plaid/models/cause.rb +235 -0
  405. data/lib/plaid/models/country_code.rb +42 -0
  406. data/lib/plaid/models/credit_card_liability.rb +339 -0
  407. data/lib/plaid/models/credit_filter.rb +227 -0
  408. data/lib/plaid/models/default_update_webhook.rb +280 -0
  409. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  410. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  411. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  412. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  413. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  414. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  415. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  416. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  417. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  418. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  419. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  420. data/lib/plaid/models/depository_filter.rb +227 -0
  421. data/lib/plaid/models/email.rb +289 -0
  422. data/lib/plaid/models/employee.rb +242 -0
  423. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  424. data/lib/plaid/models/employer.rb +261 -0
  425. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  426. data/lib/plaid/models/employers_search_request.rb +262 -0
  427. data/lib/plaid/models/employers_search_response.rb +242 -0
  428. data/lib/plaid/models/error.rb +360 -0
  429. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  430. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  431. data/lib/plaid/models/health_incident.rb +253 -0
  432. data/lib/plaid/models/historical_balance.rb +262 -0
  433. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  434. data/lib/plaid/models/holding.rb +329 -0
  435. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  436. data/lib/plaid/models/identity_get_request.rb +254 -0
  437. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  438. data/lib/plaid/models/identity_get_response.rb +256 -0
  439. data/lib/plaid/models/incident_update.rb +273 -0
  440. data/lib/plaid/models/income_breakdown.rb +253 -0
  441. data/lib/plaid/models/income_summary.rb +275 -0
  442. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  443. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  444. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  445. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  446. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  447. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  448. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  449. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  450. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  451. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  452. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  453. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  454. data/lib/plaid/models/inflow_model.rb +285 -0
  455. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  456. data/lib/plaid/models/institution.rb +344 -0
  457. data/lib/plaid/models/institution_status.rb +307 -0
  458. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  459. data/lib/plaid/models/institutions_get_by_id_request_options.rb +234 -0
  460. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  461. data/lib/plaid/models/institutions_get_request.rb +328 -0
  462. data/lib/plaid/models/institutions_get_request_options.rb +254 -0
  463. data/lib/plaid/models/institutions_get_response.rb +257 -0
  464. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  465. data/lib/plaid/models/institutions_search_request.rb +309 -0
  466. data/lib/plaid/models/institutions_search_request_options.rb +230 -0
  467. data/lib/plaid/models/institutions_search_response.rb +242 -0
  468. data/lib/plaid/models/investment_filter.rb +227 -0
  469. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  470. data/lib/plaid/models/investment_transaction.rb +446 -0
  471. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  472. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  473. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  474. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  475. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  476. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  477. data/lib/plaid/models/item.rb +351 -0
  478. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  479. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  480. data/lib/plaid/models/item_error_webhook.rb +265 -0
  481. data/lib/plaid/models/item_get_request.rb +245 -0
  482. data/lib/plaid/models/item_get_response.rb +259 -0
  483. data/lib/plaid/models/item_import_request.rb +291 -0
  484. data/lib/plaid/models/item_import_request_options.rb +220 -0
  485. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  486. data/lib/plaid/models/item_import_response.rb +240 -0
  487. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  488. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  489. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  490. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  491. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  492. data/lib/plaid/models/item_remove_request.rb +245 -0
  493. data/lib/plaid/models/item_remove_response.rb +225 -0
  494. data/lib/plaid/models/item_status.rb +249 -0
  495. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  496. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  497. data/lib/plaid/models/jwk_public_key.rb +299 -0
  498. data/lib/plaid/models/jwt_header.rb +224 -0
  499. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  500. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  501. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  502. data/lib/plaid/models/liabilities_object.rb +249 -0
  503. data/lib/plaid/models/liability_override.rb +581 -0
  504. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  505. data/lib/plaid/models/link_token_create_request.rb +429 -0
  506. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  507. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  508. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  509. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  510. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  511. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  512. data/lib/plaid/models/link_token_create_response.rb +255 -0
  513. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  514. data/lib/plaid/models/link_token_get_request.rb +245 -0
  515. data/lib/plaid/models/link_token_get_response.rb +266 -0
  516. data/lib/plaid/models/loan_filter.rb +227 -0
  517. data/lib/plaid/models/location.rb +298 -0
  518. data/lib/plaid/models/meta.rb +255 -0
  519. data/lib/plaid/models/mfa.rb +285 -0
  520. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  521. data/lib/plaid/models/mortgage_liability.rb +430 -0
  522. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  523. data/lib/plaid/models/nullable_access_token.rb +209 -0
  524. data/lib/plaid/models/nullable_address.rb +241 -0
  525. data/lib/plaid/models/nullable_address_data.rb +283 -0
  526. data/lib/plaid/models/nullable_item_status.rb +255 -0
  527. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  528. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  529. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  530. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  531. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  532. data/lib/plaid/models/numbers.rb +330 -0
  533. data/lib/plaid/models/numbers_ach.rb +266 -0
  534. data/lib/plaid/models/numbers_bacs.rb +255 -0
  535. data/lib/plaid/models/numbers_eft.rb +270 -0
  536. data/lib/plaid/models/numbers_international.rb +255 -0
  537. data/lib/plaid/models/override_accounts.rb +366 -0
  538. data/lib/plaid/models/owner.rb +278 -0
  539. data/lib/plaid/models/owner_override.rb +278 -0
  540. data/lib/plaid/models/pay_frequency.rb +272 -0
  541. data/lib/plaid/models/pay_period_details.rb +265 -0
  542. data/lib/plaid/models/payment_amount.rb +240 -0
  543. data/lib/plaid/models/payment_initiation_address.rb +269 -0
  544. data/lib/plaid/models/payment_initiation_payment_create_request.rb +284 -0
  545. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  546. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  547. data/lib/plaid/models/payment_initiation_payment_get_response.rb +364 -0
  548. data/lib/plaid/models/payment_initiation_payment_list_request.rb +269 -0
  549. data/lib/plaid/models/payment_initiation_payment_list_response.rb +257 -0
  550. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  551. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  552. data/lib/plaid/models/payment_initiation_recipient.rb +273 -0
  553. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +275 -0
  554. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  555. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  556. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +286 -0
  557. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  558. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  559. data/lib/plaid/models/payment_meta.rb +298 -0
  560. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  561. data/lib/plaid/models/paystub.rb +306 -0
  562. data/lib/plaid/models/paystub_deduction.rb +242 -0
  563. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  564. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  565. data/lib/plaid/models/phone_number.rb +281 -0
  566. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  567. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  568. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  569. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  570. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  571. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  572. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  573. data/lib/plaid/models/processor_number.rb +250 -0
  574. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  575. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  576. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  577. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  578. data/lib/plaid/models/product_status.rb +288 -0
  579. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  580. data/lib/plaid/models/products.rb +46 -0
  581. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  582. data/lib/plaid/models/pslf_status.rb +243 -0
  583. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  584. data/lib/plaid/models/recipient_bacs.rb +230 -0
  585. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  586. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  587. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  588. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  589. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +289 -0
  590. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  591. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  592. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  593. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  594. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  595. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  596. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  597. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  598. data/lib/plaid/models/sandbox_public_token_create_request.rb +292 -0
  599. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  600. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  601. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  602. data/lib/plaid/models/security.rb +382 -0
  603. data/lib/plaid/models/servicer_address_data.rb +265 -0
  604. data/lib/plaid/models/standalone_account_type.rb +285 -0
  605. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  606. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  607. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  608. data/lib/plaid/models/student_loan.rb +483 -0
  609. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  610. data/lib/plaid/models/student_loan_status.rb +266 -0
  611. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  612. data/lib/plaid/models/transaction.rb +500 -0
  613. data/lib/plaid/models/transaction_code.rb +48 -0
  614. data/lib/plaid/models/transaction_data.rb +285 -0
  615. data/lib/plaid/models/transaction_override.rb +280 -0
  616. data/lib/plaid/models/transactions_get_request.rb +284 -0
  617. data/lib/plaid/models/transactions_get_request_options.rb +289 -0
  618. data/lib/plaid/models/transactions_get_response.rb +288 -0
  619. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  620. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  621. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  622. data/lib/plaid/models/user_custom_password.rb +297 -0
  623. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  624. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  625. data/lib/plaid/models/verification_status.rb +40 -0
  626. data/lib/plaid/models/warning.rb +254 -0
  627. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  628. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  629. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  630. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  631. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  632. data/lib/plaid/version.rb +13 -2
  633. data/pkg/plaid-14.0.0.beta.4.gem +0 -0
  634. data/plaid.gemspec +44 -49
  635. data/templates/ruby/api_client.mustache +266 -0
  636. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  637. data/templates/ruby/configuration.mustache +353 -0
  638. data/templates/ruby/gemspec.mustache +41 -0
  639. data/templates/ruby/partial_model_generic.mustache +362 -0
  640. data/test/test_accounts.rb +103 -0
  641. data/test/test_asset_report.rb +147 -0
  642. data/test/test_auth.rb +61 -0
  643. data/test/test_bank_transfers.rb +220 -0
  644. data/test/test_categories.rb +10 -0
  645. data/test/test_configuration.rb +26 -0
  646. data/test/test_deposit_switch.rb +73 -0
  647. data/test/test_helper.rb +109 -0
  648. data/test/test_identity.rb +38 -0
  649. data/test/test_institutions.rb +159 -0
  650. data/test/test_investments.rb +208 -0
  651. data/test/test_item.rb +285 -0
  652. data/test/test_liabilities.rb +45 -0
  653. data/test/test_link_token.rb +97 -0
  654. data/test/test_payment_initiation.rb +95 -0
  655. data/test/test_processor.rb +67 -0
  656. data/test/test_transactions.rb +168 -0
  657. data/test/test_webhooks.rb +22 -0
  658. metadata +683 -98
  659. data/.circleci/config.yml +0 -21
  660. data/.env.sample +0 -3
  661. data/.github/workflows/add_to_project.yml +0 -21
  662. data/.rubocop.yml +0 -18
  663. data/bin/console +0 -14
  664. data/bin/setup +0 -8
  665. data/lib/plaid/client.rb +0 -190
  666. data/lib/plaid/errors.rb +0 -89
  667. data/lib/plaid/middleware.rb +0 -31
  668. data/lib/plaid/models.rb +0 -2144
  669. data/lib/plaid/products/accounts.rb +0 -63
  670. data/lib/plaid/products/asset_report.rb +0 -199
  671. data/lib/plaid/products/auth.rb +0 -42
  672. data/lib/plaid/products/base_product.rb +0 -64
  673. data/lib/plaid/products/categories.rb +0 -21
  674. data/lib/plaid/products/credit_details.rb +0 -40
  675. data/lib/plaid/products/deposit_switch.rb +0 -99
  676. data/lib/plaid/products/identity.rb +0 -31
  677. data/lib/plaid/products/income.rb +0 -31
  678. data/lib/plaid/products/institutions.rb +0 -91
  679. data/lib/plaid/products/investments.rb +0 -127
  680. data/lib/plaid/products/item.rb +0 -209
  681. data/lib/plaid/products/liabilities.rb +0 -39
  682. data/lib/plaid/products/link_token.rb +0 -74
  683. data/lib/plaid/products/payment_initiation.rb +0 -237
  684. data/lib/plaid/products/processor.rb +0 -190
  685. data/lib/plaid/products/sandbox.rb +0 -148
  686. data/lib/plaid/products/transactions.rb +0 -81
  687. data/lib/plaid/products/webhooks.rb +0 -23
@@ -0,0 +1,4483 @@
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.11.0
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
+ # Create Asset Report Audit Copy
153
+ # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
154
+ # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [AssetReportAuditCopyCreateResponse]
157
+ def asset_report_audit_copy_create(asset_report_audit_copy_create_request, opts = {})
158
+ data, _status_code, _headers = asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts)
159
+ data
160
+ end
161
+
162
+ # Create Asset Report Audit Copy
163
+ # 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.
164
+ # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [Array<(AssetReportAuditCopyCreateResponse, Integer, Hash)>] AssetReportAuditCopyCreateResponse data, response status code and response headers
167
+ def asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_create ...'
170
+ end
171
+ # verify the required parameter 'asset_report_audit_copy_create_request' is set
172
+ if @api_client.config.client_side_validation && asset_report_audit_copy_create_request.nil?
173
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_create_request' when calling PlaidApi.asset_report_audit_copy_create"
174
+ end
175
+ # resource path
176
+ local_var_path = '/asset_report/audit_copy/create'
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(asset_report_audit_copy_create_request)
193
+
194
+ # return_type
195
+ return_type = opts[:debug_return_type] || 'AssetReportAuditCopyCreateResponse'
196
+
197
+ # auth_names
198
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
199
+
200
+ new_options = opts.merge(
201
+ :operation => :"PlaidApi.asset_report_audit_copy_create",
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#asset_report_audit_copy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
217
+ # Retrieve an Asset Report Audit Copy
218
+ # `/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`.
219
+ # @param asset_report_audit_copy_get_request [AssetReportAuditCopyGetRequest]
220
+ # @param [Hash] opts the optional parameters
221
+ # @return [AssetReportGetResponse]
222
+ def asset_report_audit_copy_get(asset_report_audit_copy_get_request, opts = {})
223
+ data, _status_code, _headers = asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts)
224
+ data
225
+ end
226
+
227
+ # Retrieve an Asset Report Audit Copy
228
+ # &#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;.
229
+ # @param asset_report_audit_copy_get_request [AssetReportAuditCopyGetRequest]
230
+ # @param [Hash] opts the optional parameters
231
+ # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
232
+ def asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_get ...'
235
+ end
236
+ # verify the required parameter 'asset_report_audit_copy_get_request' is set
237
+ if @api_client.config.client_side_validation && asset_report_audit_copy_get_request.nil?
238
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_get_request' when calling PlaidApi.asset_report_audit_copy_get"
239
+ end
240
+ # resource path
241
+ local_var_path = '/asset_report/audit_copy/get'
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_get_request)
258
+
259
+ # return_type
260
+ return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
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_get",
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_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
+ end
279
+ return data, status_code, headers
280
+ end
281
+
282
+ # Remove Asset Report Audit Copy
283
+ # 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.
284
+ # @param asset_report_audit_copy_remove_request [AssetReportAuditCopyRemoveRequest]
285
+ # @param [Hash] opts the optional parameters
286
+ # @return [AssetReportAuditCopyRemoveResponse]
287
+ def asset_report_audit_copy_remove(asset_report_audit_copy_remove_request, opts = {})
288
+ data, _status_code, _headers = asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts)
289
+ data
290
+ end
291
+
292
+ # Remove Asset Report Audit Copy
293
+ # 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.
294
+ # @param asset_report_audit_copy_remove_request [AssetReportAuditCopyRemoveRequest]
295
+ # @param [Hash] opts the optional parameters
296
+ # @return [Array<(AssetReportAuditCopyRemoveResponse, Integer, Hash)>] AssetReportAuditCopyRemoveResponse data, response status code and response headers
297
+ def asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts = {})
298
+ if @api_client.config.debugging
299
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_remove ...'
300
+ end
301
+ # verify the required parameter 'asset_report_audit_copy_remove_request' is set
302
+ if @api_client.config.client_side_validation && asset_report_audit_copy_remove_request.nil?
303
+ fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_remove_request' when calling PlaidApi.asset_report_audit_copy_remove"
304
+ end
305
+ # resource path
306
+ local_var_path = '/asset_report/audit_copy/remove'
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_remove_request)
323
+
324
+ # return_type
325
+ return_type = opts[:debug_return_type] || 'AssetReportAuditCopyRemoveResponse'
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_remove",
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_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
+ end
344
+ return data, status_code, headers
345
+ end
346
+
347
+ # Create an Asset Report
348
+ # The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
349
+ # @param asset_report_create_request [AssetReportCreateRequest]
350
+ # @param [Hash] opts the optional parameters
351
+ # @return [AssetReportCreateResponse]
352
+ def asset_report_create(asset_report_create_request, opts = {})
353
+ data, _status_code, _headers = asset_report_create_with_http_info(asset_report_create_request, opts)
354
+ data
355
+ end
356
+
357
+ # Create an Asset Report
358
+ # The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. When the Asset Report is ready to be retrieved using &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.
359
+ # @param asset_report_create_request [AssetReportCreateRequest]
360
+ # @param [Hash] opts the optional parameters
361
+ # @return [Array<(AssetReportCreateResponse, Integer, Hash)>] AssetReportCreateResponse data, response status code and response headers
362
+ def asset_report_create_with_http_info(asset_report_create_request, opts = {})
363
+ if @api_client.config.debugging
364
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_create ...'
365
+ end
366
+ # verify the required parameter 'asset_report_create_request' is set
367
+ if @api_client.config.client_side_validation && asset_report_create_request.nil?
368
+ fail ArgumentError, "Missing the required parameter 'asset_report_create_request' when calling PlaidApi.asset_report_create"
369
+ end
370
+ # resource path
371
+ local_var_path = '/asset_report/create'
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_create_request)
388
+
389
+ # return_type
390
+ return_type = opts[:debug_return_type] || 'AssetReportCreateResponse'
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_create",
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_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
408
+ end
409
+ return data, status_code, headers
410
+ end
411
+
412
+ # Filter Asset Report
413
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select Account view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
414
+ # @param asset_report_filter_request [AssetReportFilterRequest]
415
+ # @param [Hash] opts the optional parameters
416
+ # @return [AssetReportFilterResponse]
417
+ def asset_report_filter(asset_report_filter_request, opts = {})
418
+ data, _status_code, _headers = asset_report_filter_with_http_info(asset_report_filter_request, opts)
419
+ data
420
+ end
421
+
422
+ # Filter Asset Report
423
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select Account view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
424
+ # @param asset_report_filter_request [AssetReportFilterRequest]
425
+ # @param [Hash] opts the optional parameters
426
+ # @return [Array<(AssetReportFilterResponse, Integer, Hash)>] AssetReportFilterResponse data, response status code and response headers
427
+ def asset_report_filter_with_http_info(asset_report_filter_request, opts = {})
428
+ if @api_client.config.debugging
429
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_filter ...'
430
+ end
431
+ # verify the required parameter 'asset_report_filter_request' is set
432
+ if @api_client.config.client_side_validation && asset_report_filter_request.nil?
433
+ fail ArgumentError, "Missing the required parameter 'asset_report_filter_request' when calling PlaidApi.asset_report_filter"
434
+ end
435
+ # resource path
436
+ local_var_path = '/asset_report/filter'
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_filter_request)
453
+
454
+ # return_type
455
+ return_type = opts[:debug_return_type] || 'AssetReportFilterResponse'
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_filter",
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_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
473
+ end
474
+ return data, status_code, headers
475
+ end
476
+
477
+ # Retrieve an Asset Report
478
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
479
+ # @param asset_report_get_request [AssetReportGetRequest]
480
+ # @param [Hash] opts the optional parameters
481
+ # @return [AssetReportGetResponse]
482
+ def asset_report_get(asset_report_get_request, opts = {})
483
+ data, _status_code, _headers = asset_report_get_with_http_info(asset_report_get_request, opts)
484
+ data
485
+ end
486
+
487
+ # Retrieve an Asset Report
488
+ # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
489
+ # @param asset_report_get_request [AssetReportGetRequest]
490
+ # @param [Hash] opts the optional parameters
491
+ # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
492
+ def asset_report_get_with_http_info(asset_report_get_request, opts = {})
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_get ...'
495
+ end
496
+ # verify the required parameter 'asset_report_get_request' is set
497
+ if @api_client.config.client_side_validation && asset_report_get_request.nil?
498
+ fail ArgumentError, "Missing the required parameter 'asset_report_get_request' when calling PlaidApi.asset_report_get"
499
+ end
500
+ # resource path
501
+ local_var_path = '/asset_report/get'
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_get_request)
518
+
519
+ # return_type
520
+ return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
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_get",
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_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
538
+ end
539
+ return data, status_code, headers
540
+ end
541
+
542
+ # Retrieve a PDF Asset Report
543
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report with Insights](https://plaid.com/documents/sample-asset-report.pdf).
544
+ # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
545
+ # @param [Hash] opts the optional parameters
546
+ # @return [File]
547
+ def asset_report_pdf_get(asset_report_pdf_get_request, opts = {})
548
+ data, _status_code, _headers = asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts)
549
+ data
550
+ end
551
+
552
+ # Retrieve a PDF Asset Report
553
+ # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report with Insights](https://plaid.com/documents/sample-asset-report.pdf).
554
+ # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
555
+ # @param [Hash] opts the optional parameters
556
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
557
+ def asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts = {})
558
+ if @api_client.config.debugging
559
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_pdf_get ...'
560
+ end
561
+ # verify the required parameter 'asset_report_pdf_get_request' is set
562
+ if @api_client.config.client_side_validation && asset_report_pdf_get_request.nil?
563
+ fail ArgumentError, "Missing the required parameter 'asset_report_pdf_get_request' when calling PlaidApi.asset_report_pdf_get"
564
+ end
565
+ # resource path
566
+ local_var_path = '/asset_report/pdf/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/pdf'])
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_pdf_get_request)
583
+
584
+ # return_type
585
+ return_type = opts[:debug_return_type] || 'File'
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_pdf_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_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
603
+ end
604
+ return data, status_code, headers
605
+ end
606
+
607
+ # Refresh an Asset Report
608
+ # 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.
609
+ # @param asset_report_refresh_request [AssetReportRefreshRequest]
610
+ # @param [Hash] opts the optional parameters
611
+ # @return [AssetReportRefreshResponse]
612
+ def asset_report_refresh(asset_report_refresh_request, opts = {})
613
+ data, _status_code, _headers = asset_report_refresh_with_http_info(asset_report_refresh_request, opts)
614
+ data
615
+ end
616
+
617
+ # Refresh an Asset Report
618
+ # 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.
619
+ # @param asset_report_refresh_request [AssetReportRefreshRequest]
620
+ # @param [Hash] opts the optional parameters
621
+ # @return [Array<(AssetReportRefreshResponse, Integer, Hash)>] AssetReportRefreshResponse data, response status code and response headers
622
+ def asset_report_refresh_with_http_info(asset_report_refresh_request, opts = {})
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_refresh ...'
625
+ end
626
+ # verify the required parameter 'asset_report_refresh_request' is set
627
+ if @api_client.config.client_side_validation && asset_report_refresh_request.nil?
628
+ fail ArgumentError, "Missing the required parameter 'asset_report_refresh_request' when calling PlaidApi.asset_report_refresh"
629
+ end
630
+ # resource path
631
+ local_var_path = '/asset_report/refresh'
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/json'])
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_refresh_request)
648
+
649
+ # return_type
650
+ return_type = opts[:debug_return_type] || 'AssetReportRefreshResponse'
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_refresh",
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_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
668
+ end
669
+ return data, status_code, headers
670
+ end
671
+
672
+ # Delete an Asset Report
673
+ # 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.
674
+ # @param asset_report_remove_request [AssetReportRemoveRequest]
675
+ # @param [Hash] opts the optional parameters
676
+ # @return [AssetReportRemoveResponse]
677
+ def asset_report_remove(asset_report_remove_request, opts = {})
678
+ data, _status_code, _headers = asset_report_remove_with_http_info(asset_report_remove_request, opts)
679
+ data
680
+ end
681
+
682
+ # Delete an Asset Report
683
+ # 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.
684
+ # @param asset_report_remove_request [AssetReportRemoveRequest]
685
+ # @param [Hash] opts the optional parameters
686
+ # @return [Array<(AssetReportRemoveResponse, Integer, Hash)>] AssetReportRemoveResponse data, response status code and response headers
687
+ def asset_report_remove_with_http_info(asset_report_remove_request, opts = {})
688
+ if @api_client.config.debugging
689
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_remove ...'
690
+ end
691
+ # verify the required parameter 'asset_report_remove_request' is set
692
+ if @api_client.config.client_side_validation && asset_report_remove_request.nil?
693
+ fail ArgumentError, "Missing the required parameter 'asset_report_remove_request' when calling PlaidApi.asset_report_remove"
694
+ end
695
+ # resource path
696
+ local_var_path = '/asset_report/remove'
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_remove_request)
713
+
714
+ # return_type
715
+ return_type = opts[:debug_return_type] || 'AssetReportRemoveResponse'
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_remove",
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_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
733
+ end
734
+ return data, status_code, headers
735
+ end
736
+
737
+ # Retrieve auth data
738
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
739
+ # @param auth_get_request [AuthGetRequest]
740
+ # @param [Hash] opts the optional parameters
741
+ # @return [AuthGetResponse]
742
+ def auth_get(auth_get_request, opts = {})
743
+ data, _status_code, _headers = auth_get_with_http_info(auth_get_request, opts)
744
+ data
745
+ end
746
+
747
+ # Retrieve auth data
748
+ # The &#x60;/auth/get&#x60; endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item&#39;s checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if &#x60;auth&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
749
+ # @param auth_get_request [AuthGetRequest]
750
+ # @param [Hash] opts the optional parameters
751
+ # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
752
+ def auth_get_with_http_info(auth_get_request, opts = {})
753
+ if @api_client.config.debugging
754
+ @api_client.config.logger.debug 'Calling API: PlaidApi.auth_get ...'
755
+ end
756
+ # verify the required parameter 'auth_get_request' is set
757
+ if @api_client.config.client_side_validation && auth_get_request.nil?
758
+ fail ArgumentError, "Missing the required parameter 'auth_get_request' when calling PlaidApi.auth_get"
759
+ end
760
+ # resource path
761
+ local_var_path = '/auth/get'
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(auth_get_request)
778
+
779
+ # return_type
780
+ return_type = opts[:debug_return_type] || 'AuthGetResponse'
781
+
782
+ # auth_names
783
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
784
+
785
+ new_options = opts.merge(
786
+ :operation => :"PlaidApi.auth_get",
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#auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
+ end
799
+ return data, status_code, headers
800
+ end
801
+
802
+ # Get balance of your Bank Transfer account
803
+ # 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.
804
+ # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
805
+ # @param [Hash] opts the optional parameters
806
+ # @return [BankTransferBalanceGetResponse]
807
+ def bank_transfer_balance_get(bank_transfer_balance_get_request, opts = {})
808
+ data, _status_code, _headers = bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts)
809
+ data
810
+ end
811
+
812
+ # Get balance of your Bank Transfer account
813
+ # 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.
814
+ # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
815
+ # @param [Hash] opts the optional parameters
816
+ # @return [Array<(BankTransferBalanceGetResponse, Integer, Hash)>] BankTransferBalanceGetResponse data, response status code and response headers
817
+ def bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts = {})
818
+ if @api_client.config.debugging
819
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_balance_get ...'
820
+ end
821
+ # verify the required parameter 'bank_transfer_balance_get_request' is set
822
+ if @api_client.config.client_side_validation && bank_transfer_balance_get_request.nil?
823
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_balance_get_request' when calling PlaidApi.bank_transfer_balance_get"
824
+ end
825
+ # resource path
826
+ local_var_path = '/bank_transfer/balance/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(bank_transfer_balance_get_request)
843
+
844
+ # return_type
845
+ return_type = opts[:debug_return_type] || 'BankTransferBalanceGetResponse'
846
+
847
+ # auth_names
848
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
849
+
850
+ new_options = opts.merge(
851
+ :operation => :"PlaidApi.bank_transfer_balance_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#bank_transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
863
+ end
864
+ return data, status_code, headers
865
+ end
866
+
867
+ # Cancel a bank transfer
868
+ # 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`.
869
+ # @param bank_transfer_cancel_request [BankTransferCancelRequest]
870
+ # @param [Hash] opts the optional parameters
871
+ # @return [BankTransferCancelResponse]
872
+ def bank_transfer_cancel(bank_transfer_cancel_request, opts = {})
873
+ data, _status_code, _headers = bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts)
874
+ data
875
+ end
876
+
877
+ # Cancel a bank transfer
878
+ # 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;.
879
+ # @param bank_transfer_cancel_request [BankTransferCancelRequest]
880
+ # @param [Hash] opts the optional parameters
881
+ # @return [Array<(BankTransferCancelResponse, Integer, Hash)>] BankTransferCancelResponse data, response status code and response headers
882
+ def bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts = {})
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_cancel ...'
885
+ end
886
+ # verify the required parameter 'bank_transfer_cancel_request' is set
887
+ if @api_client.config.client_side_validation && bank_transfer_cancel_request.nil?
888
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_cancel_request' when calling PlaidApi.bank_transfer_cancel"
889
+ end
890
+ # resource path
891
+ local_var_path = '/bank_transfer/cancel'
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_cancel_request)
908
+
909
+ # return_type
910
+ return_type = opts[:debug_return_type] || 'BankTransferCancelResponse'
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_cancel",
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_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
928
+ end
929
+ return data, status_code, headers
930
+ end
931
+
932
+ # Create a bank transfer
933
+ # Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
934
+ # @param bank_transfer_create_request [BankTransferCreateRequest]
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [BankTransferCreateResponse]
937
+ def bank_transfer_create(bank_transfer_create_request, opts = {})
938
+ data, _status_code, _headers = bank_transfer_create_with_http_info(bank_transfer_create_request, opts)
939
+ data
940
+ end
941
+
942
+ # Create a bank transfer
943
+ # Use the &#x60;/bank_transfer/create&#x60; endpoint to initiate a new bank transfer.
944
+ # @param bank_transfer_create_request [BankTransferCreateRequest]
945
+ # @param [Hash] opts the optional parameters
946
+ # @return [Array<(BankTransferCreateResponse, Integer, Hash)>] BankTransferCreateResponse data, response status code and response headers
947
+ def bank_transfer_create_with_http_info(bank_transfer_create_request, opts = {})
948
+ if @api_client.config.debugging
949
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_create ...'
950
+ end
951
+ # verify the required parameter 'bank_transfer_create_request' is set
952
+ if @api_client.config.client_side_validation && bank_transfer_create_request.nil?
953
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_create_request' when calling PlaidApi.bank_transfer_create"
954
+ end
955
+ # resource path
956
+ local_var_path = '/bank_transfer/create'
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_create_request)
973
+
974
+ # return_type
975
+ return_type = opts[:debug_return_type] || 'BankTransferCreateResponse'
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_create",
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_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
993
+ end
994
+ return data, status_code, headers
995
+ end
996
+
997
+ # List bank transfer events
998
+ # Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
999
+ # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1000
+ # @param [Hash] opts the optional parameters
1001
+ # @return [BankTransferEventListResponse]
1002
+ def bank_transfer_event_list(bank_transfer_event_list_request, opts = {})
1003
+ data, _status_code, _headers = bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts)
1004
+ data
1005
+ end
1006
+
1007
+ # List bank transfer events
1008
+ # Use the &#x60;/bank_transfer/event/list&#x60; endpoint to get a list of bank transfer events based on specified filter criteria.
1009
+ # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1010
+ # @param [Hash] opts the optional parameters
1011
+ # @return [Array<(BankTransferEventListResponse, Integer, Hash)>] BankTransferEventListResponse data, response status code and response headers
1012
+ def bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts = {})
1013
+ if @api_client.config.debugging
1014
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_list ...'
1015
+ end
1016
+ # verify the required parameter 'bank_transfer_event_list_request' is set
1017
+ if @api_client.config.client_side_validation && bank_transfer_event_list_request.nil?
1018
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_event_list_request' when calling PlaidApi.bank_transfer_event_list"
1019
+ end
1020
+ # resource path
1021
+ local_var_path = '/bank_transfer/event/list'
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_event_list_request)
1038
+
1039
+ # return_type
1040
+ return_type = opts[:debug_return_type] || 'BankTransferEventListResponse'
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_event_list",
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_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1058
+ end
1059
+ return data, status_code, headers
1060
+ end
1061
+
1062
+ # Sync bank transfer events
1063
+ # `/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.
1064
+ # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1065
+ # @param [Hash] opts the optional parameters
1066
+ # @return [BankTransferEventSyncResponse]
1067
+ def bank_transfer_event_sync(bank_transfer_event_sync_request, opts = {})
1068
+ data, _status_code, _headers = bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts)
1069
+ data
1070
+ end
1071
+
1072
+ # Sync bank transfer events
1073
+ # &#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.
1074
+ # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1075
+ # @param [Hash] opts the optional parameters
1076
+ # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
1077
+ def bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts = {})
1078
+ if @api_client.config.debugging
1079
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_sync ...'
1080
+ end
1081
+ # verify the required parameter 'bank_transfer_event_sync_request' is set
1082
+ if @api_client.config.client_side_validation && bank_transfer_event_sync_request.nil?
1083
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_event_sync_request' when calling PlaidApi.bank_transfer_event_sync"
1084
+ end
1085
+ # resource path
1086
+ local_var_path = '/bank_transfer/event/sync'
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_sync_request)
1103
+
1104
+ # return_type
1105
+ return_type = opts[:debug_return_type] || 'BankTransferEventSyncResponse'
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_sync",
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_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1123
+ end
1124
+ return data, status_code, headers
1125
+ end
1126
+
1127
+ # Retrieve a bank transfer
1128
+ # The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
1129
+ # @param bank_transfer_get_request [BankTransferGetRequest]
1130
+ # @param [Hash] opts the optional parameters
1131
+ # @return [BankTransferGetResponse]
1132
+ def bank_transfer_get(bank_transfer_get_request, opts = {})
1133
+ data, _status_code, _headers = bank_transfer_get_with_http_info(bank_transfer_get_request, opts)
1134
+ data
1135
+ end
1136
+
1137
+ # Retrieve a bank transfer
1138
+ # The &#x60;/bank_transfer/get&#x60; fetches information about the bank transfer corresponding to the given &#x60;bank_transfer_id&#x60;.
1139
+ # @param bank_transfer_get_request [BankTransferGetRequest]
1140
+ # @param [Hash] opts the optional parameters
1141
+ # @return [Array<(BankTransferGetResponse, Integer, Hash)>] BankTransferGetResponse data, response status code and response headers
1142
+ def bank_transfer_get_with_http_info(bank_transfer_get_request, opts = {})
1143
+ if @api_client.config.debugging
1144
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_get ...'
1145
+ end
1146
+ # verify the required parameter 'bank_transfer_get_request' is set
1147
+ if @api_client.config.client_side_validation && bank_transfer_get_request.nil?
1148
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_get_request' when calling PlaidApi.bank_transfer_get"
1149
+ end
1150
+ # resource path
1151
+ local_var_path = '/bank_transfer/get'
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_get_request)
1168
+
1169
+ # return_type
1170
+ return_type = opts[:debug_return_type] || 'BankTransferGetResponse'
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_get",
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_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1188
+ end
1189
+ return data, status_code, headers
1190
+ end
1191
+
1192
+ # List bank transfers
1193
+ # 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.
1194
+ # @param bank_transfer_list_request [BankTransferListRequest]
1195
+ # @param [Hash] opts the optional parameters
1196
+ # @return [BankTransferListResponse]
1197
+ def bank_transfer_list(bank_transfer_list_request, opts = {})
1198
+ data, _status_code, _headers = bank_transfer_list_with_http_info(bank_transfer_list_request, opts)
1199
+ data
1200
+ end
1201
+
1202
+ # List bank transfers
1203
+ # 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.
1204
+ # @param bank_transfer_list_request [BankTransferListRequest]
1205
+ # @param [Hash] opts the optional parameters
1206
+ # @return [Array<(BankTransferListResponse, Integer, Hash)>] BankTransferListResponse data, response status code and response headers
1207
+ def bank_transfer_list_with_http_info(bank_transfer_list_request, opts = {})
1208
+ if @api_client.config.debugging
1209
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_list ...'
1210
+ end
1211
+ # verify the required parameter 'bank_transfer_list_request' is set
1212
+ if @api_client.config.client_side_validation && bank_transfer_list_request.nil?
1213
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_list_request' when calling PlaidApi.bank_transfer_list"
1214
+ end
1215
+ # resource path
1216
+ local_var_path = '/bank_transfer/list'
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_list_request)
1233
+
1234
+ # return_type
1235
+ return_type = opts[:debug_return_type] || 'BankTransferListResponse'
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_list",
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_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1253
+ end
1254
+ return data, status_code, headers
1255
+ end
1256
+
1257
+ # Migrate account into Bank Transfers
1258
+ # 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.
1259
+ # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1260
+ # @param [Hash] opts the optional parameters
1261
+ # @return [BankTransferMigrateAccountResponse]
1262
+ def bank_transfer_migrate_account(bank_transfer_migrate_account_request, opts = {})
1263
+ data, _status_code, _headers = bank_transfer_migrate_account_with_http_info(bank_transfer_migrate_account_request, opts)
1264
+ data
1265
+ end
1266
+
1267
+ # Migrate account into Bank Transfers
1268
+ # 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.
1269
+ # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1270
+ # @param [Hash] opts the optional parameters
1271
+ # @return [Array<(BankTransferMigrateAccountResponse, Integer, Hash)>] BankTransferMigrateAccountResponse data, response status code and response headers
1272
+ def bank_transfer_migrate_account_with_http_info(bank_transfer_migrate_account_request, opts = {})
1273
+ if @api_client.config.debugging
1274
+ @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_migrate_account ...'
1275
+ end
1276
+ # verify the required parameter 'bank_transfer_migrate_account_request' is set
1277
+ if @api_client.config.client_side_validation && bank_transfer_migrate_account_request.nil?
1278
+ fail ArgumentError, "Missing the required parameter 'bank_transfer_migrate_account_request' when calling PlaidApi.bank_transfer_migrate_account"
1279
+ end
1280
+ # resource path
1281
+ local_var_path = '/bank_transfer/migrate_account'
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_migrate_account_request)
1298
+
1299
+ # return_type
1300
+ return_type = opts[:debug_return_type] || 'BankTransferMigrateAccountResponse'
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_migrate_account",
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_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1318
+ end
1319
+ return data, status_code, headers
1320
+ end
1321
+
1322
+ # Get Categories
1323
+ # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1324
+ # @param body [Object]
1325
+ # @param [Hash] opts the optional parameters
1326
+ # @return [CategoriesGetResponse]
1327
+ def categories_get(body, opts = {})
1328
+ data, _status_code, _headers = categories_get_with_http_info(body, opts)
1329
+ data
1330
+ end
1331
+
1332
+ # Get Categories
1333
+ # 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.
1334
+ # @param body [Object]
1335
+ # @param [Hash] opts the optional parameters
1336
+ # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
1337
+ def categories_get_with_http_info(body, opts = {})
1338
+ if @api_client.config.debugging
1339
+ @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
1340
+ end
1341
+ # verify the required parameter 'body' is set
1342
+ if @api_client.config.client_side_validation && body.nil?
1343
+ fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
1344
+ end
1345
+ # resource path
1346
+ local_var_path = '/categories/get'
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(body)
1363
+
1364
+ # return_type
1365
+ return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
1366
+
1367
+ # auth_names
1368
+ auth_names = opts[:debug_auth_names] || []
1369
+
1370
+ new_options = opts.merge(
1371
+ :operation => :"PlaidApi.categories_get",
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#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1383
+ end
1384
+ return data, status_code, headers
1385
+ end
1386
+
1387
+ # Create payment token
1388
+ # 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.
1389
+ # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
1390
+ # @param [Hash] opts the optional parameters
1391
+ # @return [PaymentInitiationPaymentTokenCreateResponse]
1392
+ def create_payment_token(payment_initiation_payment_token_create_request, opts = {})
1393
+ data, _status_code, _headers = create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts)
1394
+ data
1395
+ end
1396
+
1397
+ # Create payment token
1398
+ # 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.
1399
+ # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
1400
+ # @param [Hash] opts the optional parameters
1401
+ # @return [Array<(PaymentInitiationPaymentTokenCreateResponse, Integer, Hash)>] PaymentInitiationPaymentTokenCreateResponse data, response status code and response headers
1402
+ def create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts = {})
1403
+ if @api_client.config.debugging
1404
+ @api_client.config.logger.debug 'Calling API: PlaidApi.create_payment_token ...'
1405
+ end
1406
+ # verify the required parameter 'payment_initiation_payment_token_create_request' is set
1407
+ if @api_client.config.client_side_validation && payment_initiation_payment_token_create_request.nil?
1408
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_token_create_request' when calling PlaidApi.create_payment_token"
1409
+ end
1410
+ # resource path
1411
+ local_var_path = '/payment_initiation/payment/token/create'
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(payment_initiation_payment_token_create_request)
1428
+
1429
+ # return_type
1430
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentTokenCreateResponse'
1431
+
1432
+ # auth_names
1433
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1434
+
1435
+ new_options = opts.merge(
1436
+ :operation => :"PlaidApi.create_payment_token",
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#create_payment_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1448
+ end
1449
+ return data, status_code, headers
1450
+ end
1451
+
1452
+ # Create a deposit switch when not using Plaid Exchange.'
1453
+ # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1454
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1455
+ # @param [Hash] opts the optional parameters
1456
+ # @return [DepositSwitchAltCreateResponse]
1457
+ def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
1458
+ data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
1459
+ data
1460
+ end
1461
+
1462
+ # Create a deposit switch when not using Plaid Exchange.&#39;
1463
+ # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1464
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1465
+ # @param [Hash] opts the optional parameters
1466
+ # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1467
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1468
+ if @api_client.config.debugging
1469
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
1470
+ end
1471
+ # verify the required parameter 'deposit_switch_alt_create_request' is set
1472
+ if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
1473
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
1474
+ end
1475
+ # resource path
1476
+ local_var_path = '/deposit_switch/alt/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(deposit_switch_alt_create_request)
1493
+
1494
+ # return_type
1495
+ return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
1496
+
1497
+ # auth_names
1498
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1499
+
1500
+ new_options = opts.merge(
1501
+ :operation => :"PlaidApi.deposit_switch_alt_create",
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#deposit_switch_alt_create\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
1518
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1519
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @return [DepositSwitchCreateResponse]
1522
+ def deposit_switch_create(deposit_switch_create_request, opts = {})
1523
+ data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
1524
+ data
1525
+ end
1526
+
1527
+ # Create a deposit switch
1528
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1529
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
1532
+ def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
1533
+ if @api_client.config.debugging
1534
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
1535
+ end
1536
+ # verify the required parameter 'deposit_switch_create_request' is set
1537
+ if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
1539
+ end
1540
+ # resource path
1541
+ local_var_path = '/deposit_switch/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_create_request)
1558
+
1559
+ # return_type
1560
+ return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
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_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_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1578
+ end
1579
+ return data, status_code, headers
1580
+ end
1581
+
1582
+ # Retrieve a deposit switch
1583
+ # 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.
1584
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
1585
+ # @param [Hash] opts the optional parameters
1586
+ # @return [DepositSwitchGetResponse]
1587
+ def deposit_switch_get(deposit_switch_get_request, opts = {})
1588
+ data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
1589
+ data
1590
+ end
1591
+
1592
+ # Retrieve a deposit switch
1593
+ # 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.
1594
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
1595
+ # @param [Hash] opts the optional parameters
1596
+ # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
1597
+ def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
1598
+ if @api_client.config.debugging
1599
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
1600
+ end
1601
+ # verify the required parameter 'deposit_switch_get_request' is set
1602
+ if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
1603
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
1604
+ end
1605
+ # resource path
1606
+ local_var_path = '/deposit_switch/get'
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_get_request)
1623
+
1624
+ # return_type
1625
+ return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
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_get",
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_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1643
+ end
1644
+ return data, status_code, headers
1645
+ end
1646
+
1647
+ # Create a deposit switch token
1648
+ # 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.
1649
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
1650
+ # @param [Hash] opts the optional parameters
1651
+ # @return [DepositSwitchTokenCreateResponse]
1652
+ def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
1653
+ data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
1654
+ data
1655
+ end
1656
+
1657
+ # Create a deposit switch token
1658
+ # 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.
1659
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
1660
+ # @param [Hash] opts the optional parameters
1661
+ # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
1662
+ def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
1663
+ if @api_client.config.debugging
1664
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
1665
+ end
1666
+ # verify the required parameter 'deposit_switch_token_create_request' is set
1667
+ if @api_client.config.client_side_validation && deposit_switch_token_create_request.nil?
1668
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_token_create_request' when calling PlaidApi.deposit_switch_token_create"
1669
+ end
1670
+ # resource path
1671
+ local_var_path = '/deposit_switch/token/create'
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_token_create_request)
1688
+
1689
+ # return_type
1690
+ return_type = opts[:debug_return_type] || 'DepositSwitchTokenCreateResponse'
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_token_create",
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_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1708
+ end
1709
+ return data, status_code, headers
1710
+ end
1711
+
1712
+ # Search employer database
1713
+ # `/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.
1714
+ # @param [Hash] opts the optional parameters
1715
+ # @option opts [EmployersSearchRequest] :employers_search_request
1716
+ # @return [EmployersSearchResponse]
1717
+ def employers_search(opts = {})
1718
+ data, _status_code, _headers = employers_search_with_http_info(opts)
1719
+ data
1720
+ end
1721
+
1722
+ # Search employer database
1723
+ # &#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.
1724
+ # @param [Hash] opts the optional parameters
1725
+ # @option opts [EmployersSearchRequest] :employers_search_request
1726
+ # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
1727
+ def employers_search_with_http_info(opts = {})
1728
+ if @api_client.config.debugging
1729
+ @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
1730
+ end
1731
+ # resource path
1732
+ local_var_path = '/employers/search'
1733
+
1734
+ # query parameters
1735
+ query_params = opts[:query_params] || {}
1736
+
1737
+ # header parameters
1738
+ header_params = opts[:header_params] || {}
1739
+ # HTTP header 'Accept' (if needed)
1740
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1741
+ # HTTP header 'Content-Type'
1742
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1743
+
1744
+ # form parameters
1745
+ form_params = opts[:form_params] || {}
1746
+
1747
+ # http body (model)
1748
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'employers_search_request'])
1749
+
1750
+ # return_type
1751
+ return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
1752
+
1753
+ # auth_names
1754
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1755
+
1756
+ new_options = opts.merge(
1757
+ :operation => :"PlaidApi.employers_search",
1758
+ :header_params => header_params,
1759
+ :query_params => query_params,
1760
+ :form_params => form_params,
1761
+ :body => post_body,
1762
+ :auth_names => auth_names,
1763
+ :return_type => return_type
1764
+ )
1765
+
1766
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1767
+ if @api_client.config.debugging
1768
+ @api_client.config.logger.debug "API called: PlaidApi#employers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1769
+ end
1770
+ return data, status_code, headers
1771
+ end
1772
+
1773
+ # Retrieve identity data
1774
+ # 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.
1775
+ # @param identity_get_request [IdentityGetRequest]
1776
+ # @param [Hash] opts the optional parameters
1777
+ # @return [IdentityGetResponse]
1778
+ def identity_get(identity_get_request, opts = {})
1779
+ data, _status_code, _headers = identity_get_with_http_info(identity_get_request, opts)
1780
+ data
1781
+ end
1782
+
1783
+ # Retrieve identity data
1784
+ # 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.
1785
+ # @param identity_get_request [IdentityGetRequest]
1786
+ # @param [Hash] opts the optional parameters
1787
+ # @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
1788
+ def identity_get_with_http_info(identity_get_request, opts = {})
1789
+ if @api_client.config.debugging
1790
+ @api_client.config.logger.debug 'Calling API: PlaidApi.identity_get ...'
1791
+ end
1792
+ # verify the required parameter 'identity_get_request' is set
1793
+ if @api_client.config.client_side_validation && identity_get_request.nil?
1794
+ fail ArgumentError, "Missing the required parameter 'identity_get_request' when calling PlaidApi.identity_get"
1795
+ end
1796
+ # resource path
1797
+ local_var_path = '/identity/get'
1798
+
1799
+ # query parameters
1800
+ query_params = opts[:query_params] || {}
1801
+
1802
+ # header parameters
1803
+ header_params = opts[:header_params] || {}
1804
+ # HTTP header 'Accept' (if needed)
1805
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1806
+ # HTTP header 'Content-Type'
1807
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1808
+
1809
+ # form parameters
1810
+ form_params = opts[:form_params] || {}
1811
+
1812
+ # http body (model)
1813
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_get_request)
1814
+
1815
+ # return_type
1816
+ return_type = opts[:debug_return_type] || 'IdentityGetResponse'
1817
+
1818
+ # auth_names
1819
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1820
+
1821
+ new_options = opts.merge(
1822
+ :operation => :"PlaidApi.identity_get",
1823
+ :header_params => header_params,
1824
+ :query_params => query_params,
1825
+ :form_params => form_params,
1826
+ :body => post_body,
1827
+ :auth_names => auth_names,
1828
+ :return_type => return_type
1829
+ )
1830
+
1831
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1832
+ if @api_client.config.debugging
1833
+ @api_client.config.logger.debug "API called: PlaidApi#identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1834
+ end
1835
+ return data, status_code, headers
1836
+ end
1837
+
1838
+ # Download the original documents used for income verification
1839
+ # `/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.
1840
+ # @param [Hash] opts the optional parameters
1841
+ # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1842
+ # @return [File]
1843
+ def income_verification_documents_download(opts = {})
1844
+ data, _status_code, _headers = income_verification_documents_download_with_http_info(opts)
1845
+ data
1846
+ end
1847
+
1848
+ # Download the original documents used for income verification
1849
+ # &#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.
1850
+ # @param [Hash] opts the optional parameters
1851
+ # @option opts [IncomeVerificationDocumentsDownloadRequest] :income_verification_documents_download_request
1852
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1853
+ def income_verification_documents_download_with_http_info(opts = {})
1854
+ if @api_client.config.debugging
1855
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
1856
+ end
1857
+ # resource path
1858
+ local_var_path = '/income/verification/documents/download'
1859
+
1860
+ # query parameters
1861
+ query_params = opts[:query_params] || {}
1862
+
1863
+ # header parameters
1864
+ header_params = opts[:header_params] || {}
1865
+ # HTTP header 'Accept' (if needed)
1866
+ header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
1867
+ # HTTP header 'Content-Type'
1868
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1869
+
1870
+ # form parameters
1871
+ form_params = opts[:form_params] || {}
1872
+
1873
+ # http body (model)
1874
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_documents_download_request'])
1875
+
1876
+ # return_type
1877
+ return_type = opts[:debug_return_type] || 'File'
1878
+
1879
+ # auth_names
1880
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1881
+
1882
+ new_options = opts.merge(
1883
+ :operation => :"PlaidApi.income_verification_documents_download",
1884
+ :header_params => header_params,
1885
+ :query_params => query_params,
1886
+ :form_params => form_params,
1887
+ :body => post_body,
1888
+ :auth_names => auth_names,
1889
+ :return_type => return_type
1890
+ )
1891
+
1892
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1893
+ if @api_client.config.debugging
1894
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1895
+ end
1896
+ return data, status_code, headers
1897
+ end
1898
+
1899
+ # Retrieve information from the paystub used for income verification
1900
+ # `/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.
1901
+ # @param [Hash] opts the optional parameters
1902
+ # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1903
+ # @return [IncomeVerificationPaystubGetResponse]
1904
+ def income_verification_paystub_get(opts = {})
1905
+ data, _status_code, _headers = income_verification_paystub_get_with_http_info(opts)
1906
+ data
1907
+ end
1908
+
1909
+ # Retrieve information from the paystub used for income verification
1910
+ # &#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.
1911
+ # @param [Hash] opts the optional parameters
1912
+ # @option opts [IncomeVerificationPaystubGetRequest] :income_verification_paystub_get_request
1913
+ # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
1914
+ def income_verification_paystub_get_with_http_info(opts = {})
1915
+ if @api_client.config.debugging
1916
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
1917
+ end
1918
+ # resource path
1919
+ local_var_path = '/income/verification/paystub/get'
1920
+
1921
+ # query parameters
1922
+ query_params = opts[:query_params] || {}
1923
+
1924
+ # header parameters
1925
+ header_params = opts[:header_params] || {}
1926
+ # HTTP header 'Accept' (if needed)
1927
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1928
+ # HTTP header 'Content-Type'
1929
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1930
+
1931
+ # form parameters
1932
+ form_params = opts[:form_params] || {}
1933
+
1934
+ # http body (model)
1935
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_paystub_get_request'])
1936
+
1937
+ # return_type
1938
+ return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
1939
+
1940
+ # auth_names
1941
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1942
+
1943
+ new_options = opts.merge(
1944
+ :operation => :"PlaidApi.income_verification_paystub_get",
1945
+ :header_params => header_params,
1946
+ :query_params => query_params,
1947
+ :form_params => form_params,
1948
+ :body => post_body,
1949
+ :auth_names => auth_names,
1950
+ :return_type => return_type
1951
+ )
1952
+
1953
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1954
+ if @api_client.config.debugging
1955
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1956
+ end
1957
+ return data, status_code, headers
1958
+ end
1959
+
1960
+ # Retrieve a summary of information derived from income verification
1961
+ # `/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.
1962
+ # @param [Hash] opts the optional parameters
1963
+ # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1964
+ # @return [IncomeVerificationSummaryGetResponse]
1965
+ def income_verification_summary_get(opts = {})
1966
+ data, _status_code, _headers = income_verification_summary_get_with_http_info(opts)
1967
+ data
1968
+ end
1969
+
1970
+ # Retrieve a summary of information derived from income verification
1971
+ # &#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.
1972
+ # @param [Hash] opts the optional parameters
1973
+ # @option opts [IncomeVerificationSummaryGetRequest] :income_verification_summary_get_request
1974
+ # @return [Array<(IncomeVerificationSummaryGetResponse, Integer, Hash)>] IncomeVerificationSummaryGetResponse data, response status code and response headers
1975
+ def income_verification_summary_get_with_http_info(opts = {})
1976
+ if @api_client.config.debugging
1977
+ @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
1978
+ end
1979
+ # resource path
1980
+ local_var_path = '/income/verification/summary/get'
1981
+
1982
+ # query parameters
1983
+ query_params = opts[:query_params] || {}
1984
+
1985
+ # header parameters
1986
+ header_params = opts[:header_params] || {}
1987
+ # HTTP header 'Accept' (if needed)
1988
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1989
+ # HTTP header 'Content-Type'
1990
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1991
+
1992
+ # form parameters
1993
+ form_params = opts[:form_params] || {}
1994
+
1995
+ # http body (model)
1996
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_summary_get_request'])
1997
+
1998
+ # return_type
1999
+ return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
2000
+
2001
+ # auth_names
2002
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2003
+
2004
+ new_options = opts.merge(
2005
+ :operation => :"PlaidApi.income_verification_summary_get",
2006
+ :header_params => header_params,
2007
+ :query_params => query_params,
2008
+ :form_params => form_params,
2009
+ :body => post_body,
2010
+ :auth_names => auth_names,
2011
+ :return_type => return_type
2012
+ )
2013
+
2014
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2015
+ if @api_client.config.debugging
2016
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2017
+ end
2018
+ return data, status_code, headers
2019
+ end
2020
+
2021
+ # Get details of all supported institutions
2022
+ # 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.
2023
+ # @param institutions_get_request [InstitutionsGetRequest]
2024
+ # @param [Hash] opts the optional parameters
2025
+ # @return [InstitutionsGetResponse]
2026
+ def institutions_get(institutions_get_request, opts = {})
2027
+ data, _status_code, _headers = institutions_get_with_http_info(institutions_get_request, opts)
2028
+ data
2029
+ end
2030
+
2031
+ # Get details of all supported institutions
2032
+ # 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.
2033
+ # @param institutions_get_request [InstitutionsGetRequest]
2034
+ # @param [Hash] opts the optional parameters
2035
+ # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
2036
+ def institutions_get_with_http_info(institutions_get_request, opts = {})
2037
+ if @api_client.config.debugging
2038
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get ...'
2039
+ end
2040
+ # verify the required parameter 'institutions_get_request' is set
2041
+ if @api_client.config.client_side_validation && institutions_get_request.nil?
2042
+ fail ArgumentError, "Missing the required parameter 'institutions_get_request' when calling PlaidApi.institutions_get"
2043
+ end
2044
+ # resource path
2045
+ local_var_path = '/institutions/get'
2046
+
2047
+ # query parameters
2048
+ query_params = opts[:query_params] || {}
2049
+
2050
+ # header parameters
2051
+ header_params = opts[:header_params] || {}
2052
+ # HTTP header 'Accept' (if needed)
2053
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2054
+ # HTTP header 'Content-Type'
2055
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
2056
+
2057
+ # form parameters
2058
+ form_params = opts[:form_params] || {}
2059
+
2060
+ # http body (model)
2061
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_request)
2062
+
2063
+ # return_type
2064
+ return_type = opts[:debug_return_type] || 'InstitutionsGetResponse'
2065
+
2066
+ # auth_names
2067
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2068
+
2069
+ new_options = opts.merge(
2070
+ :operation => :"PlaidApi.institutions_get",
2071
+ :header_params => header_params,
2072
+ :query_params => query_params,
2073
+ :form_params => form_params,
2074
+ :body => post_body,
2075
+ :auth_names => auth_names,
2076
+ :return_type => return_type
2077
+ )
2078
+
2079
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2080
+ if @api_client.config.debugging
2081
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2082
+ end
2083
+ return data, status_code, headers
2084
+ end
2085
+
2086
+ # Get details of an institution
2087
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2088
+ # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2089
+ # @param [Hash] opts the optional parameters
2090
+ # @return [InstitutionsGetByIdResponse]
2091
+ def institutions_get_by_id(institutions_get_by_id_request, opts = {})
2092
+ data, _status_code, _headers = institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts)
2093
+ data
2094
+ end
2095
+
2096
+ # Get details of an institution
2097
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2098
+ # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2099
+ # @param [Hash] opts the optional parameters
2100
+ # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
2101
+ def institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts = {})
2102
+ if @api_client.config.debugging
2103
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get_by_id ...'
2104
+ end
2105
+ # verify the required parameter 'institutions_get_by_id_request' is set
2106
+ if @api_client.config.client_side_validation && institutions_get_by_id_request.nil?
2107
+ fail ArgumentError, "Missing the required parameter 'institutions_get_by_id_request' when calling PlaidApi.institutions_get_by_id"
2108
+ end
2109
+ # resource path
2110
+ local_var_path = '/institutions/get_by_id'
2111
+
2112
+ # query parameters
2113
+ query_params = opts[:query_params] || {}
2114
+
2115
+ # header parameters
2116
+ header_params = opts[:header_params] || {}
2117
+ # HTTP header 'Accept' (if needed)
2118
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2119
+ # HTTP header 'Content-Type'
2120
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2121
+
2122
+ # form parameters
2123
+ form_params = opts[:form_params] || {}
2124
+
2125
+ # http body (model)
2126
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_by_id_request)
2127
+
2128
+ # return_type
2129
+ return_type = opts[:debug_return_type] || 'InstitutionsGetByIdResponse'
2130
+
2131
+ # auth_names
2132
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2133
+
2134
+ new_options = opts.merge(
2135
+ :operation => :"PlaidApi.institutions_get_by_id",
2136
+ :header_params => header_params,
2137
+ :query_params => query_params,
2138
+ :form_params => form_params,
2139
+ :body => post_body,
2140
+ :auth_names => auth_names,
2141
+ :return_type => return_type
2142
+ )
2143
+
2144
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2145
+ if @api_client.config.debugging
2146
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2147
+ end
2148
+ return data, status_code, headers
2149
+ end
2150
+
2151
+ # Search institutions
2152
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2153
+ # @param institutions_search_request [InstitutionsSearchRequest]
2154
+ # @param [Hash] opts the optional parameters
2155
+ # @return [InstitutionsSearchResponse]
2156
+ def institutions_search(institutions_search_request, opts = {})
2157
+ data, _status_code, _headers = institutions_search_with_http_info(institutions_search_request, opts)
2158
+ data
2159
+ end
2160
+
2161
+ # Search institutions
2162
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2163
+ # @param institutions_search_request [InstitutionsSearchRequest]
2164
+ # @param [Hash] opts the optional parameters
2165
+ # @return [Array<(InstitutionsSearchResponse, Integer, Hash)>] InstitutionsSearchResponse data, response status code and response headers
2166
+ def institutions_search_with_http_info(institutions_search_request, opts = {})
2167
+ if @api_client.config.debugging
2168
+ @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_search ...'
2169
+ end
2170
+ # verify the required parameter 'institutions_search_request' is set
2171
+ if @api_client.config.client_side_validation && institutions_search_request.nil?
2172
+ fail ArgumentError, "Missing the required parameter 'institutions_search_request' when calling PlaidApi.institutions_search"
2173
+ end
2174
+ # resource path
2175
+ local_var_path = '/institutions/search'
2176
+
2177
+ # query parameters
2178
+ query_params = opts[:query_params] || {}
2179
+
2180
+ # header parameters
2181
+ header_params = opts[:header_params] || {}
2182
+ # HTTP header 'Accept' (if needed)
2183
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2184
+ # HTTP header 'Content-Type'
2185
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2186
+
2187
+ # form parameters
2188
+ form_params = opts[:form_params] || {}
2189
+
2190
+ # http body (model)
2191
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_search_request)
2192
+
2193
+ # return_type
2194
+ return_type = opts[:debug_return_type] || 'InstitutionsSearchResponse'
2195
+
2196
+ # auth_names
2197
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2198
+
2199
+ new_options = opts.merge(
2200
+ :operation => :"PlaidApi.institutions_search",
2201
+ :header_params => header_params,
2202
+ :query_params => query_params,
2203
+ :form_params => form_params,
2204
+ :body => post_body,
2205
+ :auth_names => auth_names,
2206
+ :return_type => return_type
2207
+ )
2208
+
2209
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2210
+ if @api_client.config.debugging
2211
+ @api_client.config.logger.debug "API called: PlaidApi#institutions_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2212
+ end
2213
+ return data, status_code, headers
2214
+ end
2215
+
2216
+ # Get Investment holdings
2217
+ # The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
2218
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
2219
+ # @param [Hash] opts the optional parameters
2220
+ # @return [InvestmentsHoldingsGetResponse]
2221
+ def investments_holdings_get(investments_holdings_get_request, opts = {})
2222
+ data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
2223
+ data
2224
+ end
2225
+
2226
+ # Get Investment holdings
2227
+ # The &#x60;/investments/holdings/get&#x60; endpoint allows developers to receive user-authorized stock position data for &#x60;investment&#x60;-type accounts.
2228
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
2229
+ # @param [Hash] opts the optional parameters
2230
+ # @return [Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>] InvestmentsHoldingsGetResponse data, response status code and response headers
2231
+ def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
2232
+ if @api_client.config.debugging
2233
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
2234
+ end
2235
+ # verify the required parameter 'investments_holdings_get_request' is set
2236
+ if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
2237
+ fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
2238
+ end
2239
+ # resource path
2240
+ local_var_path = '/investments/holdings/get'
2241
+
2242
+ # query parameters
2243
+ query_params = opts[:query_params] || {}
2244
+
2245
+ # header parameters
2246
+ header_params = opts[:header_params] || {}
2247
+ # HTTP header 'Accept' (if needed)
2248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2249
+ # HTTP header 'Content-Type'
2250
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2251
+
2252
+ # form parameters
2253
+ form_params = opts[:form_params] || {}
2254
+
2255
+ # http body (model)
2256
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)
2257
+
2258
+ # return_type
2259
+ return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'
2260
+
2261
+ # auth_names
2262
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2263
+
2264
+ new_options = opts.merge(
2265
+ :operation => :"PlaidApi.investments_holdings_get",
2266
+ :header_params => header_params,
2267
+ :query_params => query_params,
2268
+ :form_params => form_params,
2269
+ :body => post_body,
2270
+ :auth_names => auth_names,
2271
+ :return_type => return_type
2272
+ )
2273
+
2274
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2275
+ if @api_client.config.debugging
2276
+ @api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2277
+ end
2278
+ return data, status_code, headers
2279
+ end
2280
+
2281
+ # Get investment transactions
2282
+ # 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.
2283
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
2284
+ # @param [Hash] opts the optional parameters
2285
+ # @return [InvestmentsTransactionsGetResponse]
2286
+ def investments_transactions_get(investments_transactions_get_request, opts = {})
2287
+ data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
2288
+ data
2289
+ end
2290
+
2291
+ # Get investment transactions
2292
+ # 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.
2293
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
2294
+ # @param [Hash] opts the optional parameters
2295
+ # @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
2296
+ def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
2297
+ if @api_client.config.debugging
2298
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
2299
+ end
2300
+ # verify the required parameter 'investments_transactions_get_request' is set
2301
+ if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
2302
+ fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
2303
+ end
2304
+ # resource path
2305
+ local_var_path = '/investments/transactions/get'
2306
+
2307
+ # query parameters
2308
+ query_params = opts[:query_params] || {}
2309
+
2310
+ # header parameters
2311
+ header_params = opts[:header_params] || {}
2312
+ # HTTP header 'Accept' (if needed)
2313
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2314
+ # HTTP header 'Content-Type'
2315
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2316
+
2317
+ # form parameters
2318
+ form_params = opts[:form_params] || {}
2319
+
2320
+ # http body (model)
2321
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)
2322
+
2323
+ # return_type
2324
+ return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'
2325
+
2326
+ # auth_names
2327
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2328
+
2329
+ new_options = opts.merge(
2330
+ :operation => :"PlaidApi.investments_transactions_get",
2331
+ :header_params => header_params,
2332
+ :query_params => query_params,
2333
+ :form_params => form_params,
2334
+ :body => post_body,
2335
+ :auth_names => auth_names,
2336
+ :return_type => return_type
2337
+ )
2338
+
2339
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2340
+ if @api_client.config.debugging
2341
+ @api_client.config.logger.debug "API called: PlaidApi#investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2342
+ end
2343
+ return data, status_code, headers
2344
+ end
2345
+
2346
+ # Invalidate access_token
2347
+ # 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`.
2348
+ # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest]
2349
+ # @param [Hash] opts the optional parameters
2350
+ # @return [ItemAccessTokenInvalidateResponse]
2351
+ def item_access_token_invalidate(item_access_token_invalidate_request, opts = {})
2352
+ data, _status_code, _headers = item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts)
2353
+ data
2354
+ end
2355
+
2356
+ # Invalidate access_token
2357
+ # 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;.
2358
+ # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest]
2359
+ # @param [Hash] opts the optional parameters
2360
+ # @return [Array<(ItemAccessTokenInvalidateResponse, Integer, Hash)>] ItemAccessTokenInvalidateResponse data, response status code and response headers
2361
+ def item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts = {})
2362
+ if @api_client.config.debugging
2363
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_access_token_invalidate ...'
2364
+ end
2365
+ # verify the required parameter 'item_access_token_invalidate_request' is set
2366
+ if @api_client.config.client_side_validation && item_access_token_invalidate_request.nil?
2367
+ fail ArgumentError, "Missing the required parameter 'item_access_token_invalidate_request' when calling PlaidApi.item_access_token_invalidate"
2368
+ end
2369
+ # resource path
2370
+ local_var_path = '/item/access_token/invalidate'
2371
+
2372
+ # query parameters
2373
+ query_params = opts[:query_params] || {}
2374
+
2375
+ # header parameters
2376
+ header_params = opts[:header_params] || {}
2377
+ # HTTP header 'Accept' (if needed)
2378
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2379
+ # HTTP header 'Content-Type'
2380
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2381
+
2382
+ # form parameters
2383
+ form_params = opts[:form_params] || {}
2384
+
2385
+ # http body (model)
2386
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_access_token_invalidate_request)
2387
+
2388
+ # return_type
2389
+ return_type = opts[:debug_return_type] || 'ItemAccessTokenInvalidateResponse'
2390
+
2391
+ # auth_names
2392
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2393
+
2394
+ new_options = opts.merge(
2395
+ :operation => :"PlaidApi.item_access_token_invalidate",
2396
+ :header_params => header_params,
2397
+ :query_params => query_params,
2398
+ :form_params => form_params,
2399
+ :body => post_body,
2400
+ :auth_names => auth_names,
2401
+ :return_type => return_type
2402
+ )
2403
+
2404
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2405
+ if @api_client.config.debugging
2406
+ @api_client.config.logger.debug "API called: PlaidApi#item_access_token_invalidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2407
+ end
2408
+ return data, status_code, headers
2409
+ end
2410
+
2411
+ # Create public token
2412
+ # 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.
2413
+ # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2414
+ # @param [Hash] opts the optional parameters
2415
+ # @return [ItemPublicTokenCreateResponse]
2416
+ def item_create_public_token(item_public_token_create_request, opts = {})
2417
+ data, _status_code, _headers = item_create_public_token_with_http_info(item_public_token_create_request, opts)
2418
+ data
2419
+ end
2420
+
2421
+ # Create public token
2422
+ # 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.
2423
+ # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
2424
+ # @param [Hash] opts the optional parameters
2425
+ # @return [Array<(ItemPublicTokenCreateResponse, Integer, Hash)>] ItemPublicTokenCreateResponse data, response status code and response headers
2426
+ def item_create_public_token_with_http_info(item_public_token_create_request, opts = {})
2427
+ if @api_client.config.debugging
2428
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_create_public_token ...'
2429
+ end
2430
+ # verify the required parameter 'item_public_token_create_request' is set
2431
+ if @api_client.config.client_side_validation && item_public_token_create_request.nil?
2432
+ fail ArgumentError, "Missing the required parameter 'item_public_token_create_request' when calling PlaidApi.item_create_public_token"
2433
+ end
2434
+ # resource path
2435
+ local_var_path = '/item/public_token/create'
2436
+
2437
+ # query parameters
2438
+ query_params = opts[:query_params] || {}
2439
+
2440
+ # header parameters
2441
+ header_params = opts[:header_params] || {}
2442
+ # HTTP header 'Accept' (if needed)
2443
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2444
+ # HTTP header 'Content-Type'
2445
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2446
+
2447
+ # form parameters
2448
+ form_params = opts[:form_params] || {}
2449
+
2450
+ # http body (model)
2451
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_create_request)
2452
+
2453
+ # return_type
2454
+ return_type = opts[:debug_return_type] || 'ItemPublicTokenCreateResponse'
2455
+
2456
+ # auth_names
2457
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2458
+
2459
+ new_options = opts.merge(
2460
+ :operation => :"PlaidApi.item_create_public_token",
2461
+ :header_params => header_params,
2462
+ :query_params => query_params,
2463
+ :form_params => form_params,
2464
+ :body => post_body,
2465
+ :auth_names => auth_names,
2466
+ :return_type => return_type
2467
+ )
2468
+
2469
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2470
+ if @api_client.config.debugging
2471
+ @api_client.config.logger.debug "API called: PlaidApi#item_create_public_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2472
+ end
2473
+ return data, status_code, headers
2474
+ end
2475
+
2476
+ # Retrieve an Item
2477
+ # Returns information about the status of an Item.
2478
+ # @param item_get_request [ItemGetRequest]
2479
+ # @param [Hash] opts the optional parameters
2480
+ # @return [ItemGetResponse]
2481
+ def item_get(item_get_request, opts = {})
2482
+ data, _status_code, _headers = item_get_with_http_info(item_get_request, opts)
2483
+ data
2484
+ end
2485
+
2486
+ # Retrieve an Item
2487
+ # Returns information about the status of an Item.
2488
+ # @param item_get_request [ItemGetRequest]
2489
+ # @param [Hash] opts the optional parameters
2490
+ # @return [Array<(ItemGetResponse, Integer, Hash)>] ItemGetResponse data, response status code and response headers
2491
+ def item_get_with_http_info(item_get_request, opts = {})
2492
+ if @api_client.config.debugging
2493
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_get ...'
2494
+ end
2495
+ # verify the required parameter 'item_get_request' is set
2496
+ if @api_client.config.client_side_validation && item_get_request.nil?
2497
+ fail ArgumentError, "Missing the required parameter 'item_get_request' when calling PlaidApi.item_get"
2498
+ end
2499
+ # resource path
2500
+ local_var_path = '/item/get'
2501
+
2502
+ # query parameters
2503
+ query_params = opts[:query_params] || {}
2504
+
2505
+ # header parameters
2506
+ header_params = opts[:header_params] || {}
2507
+ # HTTP header 'Accept' (if needed)
2508
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2509
+ # HTTP header 'Content-Type'
2510
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2511
+
2512
+ # form parameters
2513
+ form_params = opts[:form_params] || {}
2514
+
2515
+ # http body (model)
2516
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_get_request)
2517
+
2518
+ # return_type
2519
+ return_type = opts[:debug_return_type] || 'ItemGetResponse'
2520
+
2521
+ # auth_names
2522
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2523
+
2524
+ new_options = opts.merge(
2525
+ :operation => :"PlaidApi.item_get",
2526
+ :header_params => header_params,
2527
+ :query_params => query_params,
2528
+ :form_params => form_params,
2529
+ :body => post_body,
2530
+ :auth_names => auth_names,
2531
+ :return_type => return_type
2532
+ )
2533
+
2534
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2535
+ if @api_client.config.debugging
2536
+ @api_client.config.logger.debug "API called: PlaidApi#item_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2537
+ end
2538
+ return data, status_code, headers
2539
+ end
2540
+
2541
+ # Import Item
2542
+ # `/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`).
2543
+ # @param item_import_request [ItemImportRequest]
2544
+ # @param [Hash] opts the optional parameters
2545
+ # @return [ItemImportResponse]
2546
+ def item_import(item_import_request, opts = {})
2547
+ data, _status_code, _headers = item_import_with_http_info(item_import_request, opts)
2548
+ data
2549
+ end
2550
+
2551
+ # Import Item
2552
+ # &#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;).
2553
+ # @param item_import_request [ItemImportRequest]
2554
+ # @param [Hash] opts the optional parameters
2555
+ # @return [Array<(ItemImportResponse, Integer, Hash)>] ItemImportResponse data, response status code and response headers
2556
+ def item_import_with_http_info(item_import_request, opts = {})
2557
+ if @api_client.config.debugging
2558
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_import ...'
2559
+ end
2560
+ # verify the required parameter 'item_import_request' is set
2561
+ if @api_client.config.client_side_validation && item_import_request.nil?
2562
+ fail ArgumentError, "Missing the required parameter 'item_import_request' when calling PlaidApi.item_import"
2563
+ end
2564
+ # resource path
2565
+ local_var_path = '/item/import'
2566
+
2567
+ # query parameters
2568
+ query_params = opts[:query_params] || {}
2569
+
2570
+ # header parameters
2571
+ header_params = opts[:header_params] || {}
2572
+ # HTTP header 'Accept' (if needed)
2573
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2574
+ # HTTP header 'Content-Type'
2575
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2576
+
2577
+ # form parameters
2578
+ form_params = opts[:form_params] || {}
2579
+
2580
+ # http body (model)
2581
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_import_request)
2582
+
2583
+ # return_type
2584
+ return_type = opts[:debug_return_type] || 'ItemImportResponse'
2585
+
2586
+ # auth_names
2587
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2588
+
2589
+ new_options = opts.merge(
2590
+ :operation => :"PlaidApi.item_import",
2591
+ :header_params => header_params,
2592
+ :query_params => query_params,
2593
+ :form_params => form_params,
2594
+ :body => post_body,
2595
+ :auth_names => auth_names,
2596
+ :return_type => return_type
2597
+ )
2598
+
2599
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2600
+ if @api_client.config.debugging
2601
+ @api_client.config.logger.debug "API called: PlaidApi#item_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2602
+ end
2603
+ return data, status_code, headers
2604
+ end
2605
+
2606
+ # Exchange public token for an access token
2607
+ # 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.
2608
+ # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
2609
+ # @param [Hash] opts the optional parameters
2610
+ # @return [ItemPublicTokenExchangeResponse]
2611
+ def item_public_token_exchange(item_public_token_exchange_request, opts = {})
2612
+ data, _status_code, _headers = item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts)
2613
+ data
2614
+ end
2615
+
2616
+ # Exchange public token for an access token
2617
+ # 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.
2618
+ # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
2619
+ # @param [Hash] opts the optional parameters
2620
+ # @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
2621
+ def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
2622
+ if @api_client.config.debugging
2623
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
2624
+ end
2625
+ # verify the required parameter 'item_public_token_exchange_request' is set
2626
+ if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
2627
+ fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
2628
+ end
2629
+ # resource path
2630
+ local_var_path = '/item/public_token/exchange'
2631
+
2632
+ # query parameters
2633
+ query_params = opts[:query_params] || {}
2634
+
2635
+ # header parameters
2636
+ header_params = opts[:header_params] || {}
2637
+ # HTTP header 'Accept' (if needed)
2638
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2639
+ # HTTP header 'Content-Type'
2640
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2641
+
2642
+ # form parameters
2643
+ form_params = opts[:form_params] || {}
2644
+
2645
+ # http body (model)
2646
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)
2647
+
2648
+ # return_type
2649
+ return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
2650
+
2651
+ # auth_names
2652
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2653
+
2654
+ new_options = opts.merge(
2655
+ :operation => :"PlaidApi.item_public_token_exchange",
2656
+ :header_params => header_params,
2657
+ :query_params => query_params,
2658
+ :form_params => form_params,
2659
+ :body => post_body,
2660
+ :auth_names => auth_names,
2661
+ :return_type => return_type
2662
+ )
2663
+
2664
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2665
+ if @api_client.config.debugging
2666
+ @api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2667
+ end
2668
+ return data, status_code, headers
2669
+ end
2670
+
2671
+ # Remove an Item
2672
+ # 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.
2673
+ # @param item_remove_request [ItemRemoveRequest]
2674
+ # @param [Hash] opts the optional parameters
2675
+ # @return [ItemRemoveResponse]
2676
+ def item_remove(item_remove_request, opts = {})
2677
+ data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
2678
+ data
2679
+ end
2680
+
2681
+ # Remove an Item
2682
+ # 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.
2683
+ # @param item_remove_request [ItemRemoveRequest]
2684
+ # @param [Hash] opts the optional parameters
2685
+ # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
2686
+ def item_remove_with_http_info(item_remove_request, opts = {})
2687
+ if @api_client.config.debugging
2688
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
2689
+ end
2690
+ # verify the required parameter 'item_remove_request' is set
2691
+ if @api_client.config.client_side_validation && item_remove_request.nil?
2692
+ fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
2693
+ end
2694
+ # resource path
2695
+ local_var_path = '/item/remove'
2696
+
2697
+ # query parameters
2698
+ query_params = opts[:query_params] || {}
2699
+
2700
+ # header parameters
2701
+ header_params = opts[:header_params] || {}
2702
+ # HTTP header 'Accept' (if needed)
2703
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2704
+ # HTTP header 'Content-Type'
2705
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2706
+
2707
+ # form parameters
2708
+ form_params = opts[:form_params] || {}
2709
+
2710
+ # http body (model)
2711
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)
2712
+
2713
+ # return_type
2714
+ return_type = opts[:debug_return_type] || 'ItemRemoveResponse'
2715
+
2716
+ # auth_names
2717
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2718
+
2719
+ new_options = opts.merge(
2720
+ :operation => :"PlaidApi.item_remove",
2721
+ :header_params => header_params,
2722
+ :query_params => query_params,
2723
+ :form_params => form_params,
2724
+ :body => post_body,
2725
+ :auth_names => auth_names,
2726
+ :return_type => return_type
2727
+ )
2728
+
2729
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2730
+ if @api_client.config.debugging
2731
+ @api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2732
+ end
2733
+ return data, status_code, headers
2734
+ end
2735
+
2736
+ # Update Webhook URL
2737
+ # 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.
2738
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2739
+ # @param [Hash] opts the optional parameters
2740
+ # @return [ItemWebhookUpdateResponse]
2741
+ def item_webhook_update(item_webhook_update_request, opts = {})
2742
+ data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
2743
+ data
2744
+ end
2745
+
2746
+ # Update Webhook URL
2747
+ # 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.
2748
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
2749
+ # @param [Hash] opts the optional parameters
2750
+ # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
2751
+ def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
2752
+ if @api_client.config.debugging
2753
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
2754
+ end
2755
+ # verify the required parameter 'item_webhook_update_request' is set
2756
+ if @api_client.config.client_side_validation && item_webhook_update_request.nil?
2757
+ fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
2758
+ end
2759
+ # resource path
2760
+ local_var_path = '/item/webhook/update'
2761
+
2762
+ # query parameters
2763
+ query_params = opts[:query_params] || {}
2764
+
2765
+ # header parameters
2766
+ header_params = opts[:header_params] || {}
2767
+ # HTTP header 'Accept' (if needed)
2768
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2769
+ # HTTP header 'Content-Type'
2770
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2771
+
2772
+ # form parameters
2773
+ form_params = opts[:form_params] || {}
2774
+
2775
+ # http body (model)
2776
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)
2777
+
2778
+ # return_type
2779
+ return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'
2780
+
2781
+ # auth_names
2782
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2783
+
2784
+ new_options = opts.merge(
2785
+ :operation => :"PlaidApi.item_webhook_update",
2786
+ :header_params => header_params,
2787
+ :query_params => query_params,
2788
+ :form_params => form_params,
2789
+ :body => post_body,
2790
+ :auth_names => auth_names,
2791
+ :return_type => return_type
2792
+ )
2793
+
2794
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2795
+ if @api_client.config.debugging
2796
+ @api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2797
+ end
2798
+ return data, status_code, headers
2799
+ end
2800
+
2801
+ # Retrieve Liabilities data
2802
+ # 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.
2803
+ # @param liabilities_get_request [LiabilitiesGetRequest]
2804
+ # @param [Hash] opts the optional parameters
2805
+ # @return [LiabilitiesGetResponse]
2806
+ def liabilities_get(liabilities_get_request, opts = {})
2807
+ data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
2808
+ data
2809
+ end
2810
+
2811
+ # Retrieve Liabilities data
2812
+ # 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.
2813
+ # @param liabilities_get_request [LiabilitiesGetRequest]
2814
+ # @param [Hash] opts the optional parameters
2815
+ # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
2816
+ def liabilities_get_with_http_info(liabilities_get_request, opts = {})
2817
+ if @api_client.config.debugging
2818
+ @api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
2819
+ end
2820
+ # verify the required parameter 'liabilities_get_request' is set
2821
+ if @api_client.config.client_side_validation && liabilities_get_request.nil?
2822
+ fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
2823
+ end
2824
+ # resource path
2825
+ local_var_path = '/liabilities/get'
2826
+
2827
+ # query parameters
2828
+ query_params = opts[:query_params] || {}
2829
+
2830
+ # header parameters
2831
+ header_params = opts[:header_params] || {}
2832
+ # HTTP header 'Accept' (if needed)
2833
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2834
+ # HTTP header 'Content-Type'
2835
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2836
+
2837
+ # form parameters
2838
+ form_params = opts[:form_params] || {}
2839
+
2840
+ # http body (model)
2841
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)
2842
+
2843
+ # return_type
2844
+ return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'
2845
+
2846
+ # auth_names
2847
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2848
+
2849
+ new_options = opts.merge(
2850
+ :operation => :"PlaidApi.liabilities_get",
2851
+ :header_params => header_params,
2852
+ :query_params => query_params,
2853
+ :form_params => form_params,
2854
+ :body => post_body,
2855
+ :auth_names => auth_names,
2856
+ :return_type => return_type
2857
+ )
2858
+
2859
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2860
+ if @api_client.config.debugging
2861
+ @api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2862
+ end
2863
+ return data, status_code, headers
2864
+ end
2865
+
2866
+ # Create Link Token
2867
+ # 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.
2868
+ # @param link_token_create_request [LinkTokenCreateRequest]
2869
+ # @param [Hash] opts the optional parameters
2870
+ # @return [LinkTokenCreateResponse]
2871
+ def link_token_create(link_token_create_request, opts = {})
2872
+ data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
2873
+ data
2874
+ end
2875
+
2876
+ # Create Link Token
2877
+ # 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.
2878
+ # @param link_token_create_request [LinkTokenCreateRequest]
2879
+ # @param [Hash] opts the optional parameters
2880
+ # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
2881
+ def link_token_create_with_http_info(link_token_create_request, opts = {})
2882
+ if @api_client.config.debugging
2883
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
2884
+ end
2885
+ # verify the required parameter 'link_token_create_request' is set
2886
+ if @api_client.config.client_side_validation && link_token_create_request.nil?
2887
+ fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
2888
+ end
2889
+ # resource path
2890
+ local_var_path = '/link/token/create'
2891
+
2892
+ # query parameters
2893
+ query_params = opts[:query_params] || {}
2894
+
2895
+ # header parameters
2896
+ header_params = opts[:header_params] || {}
2897
+ # HTTP header 'Accept' (if needed)
2898
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2899
+ # HTTP header 'Content-Type'
2900
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2901
+
2902
+ # form parameters
2903
+ form_params = opts[:form_params] || {}
2904
+
2905
+ # http body (model)
2906
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)
2907
+
2908
+ # return_type
2909
+ return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
2910
+
2911
+ # auth_names
2912
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2913
+
2914
+ new_options = opts.merge(
2915
+ :operation => :"PlaidApi.link_token_create",
2916
+ :header_params => header_params,
2917
+ :query_params => query_params,
2918
+ :form_params => form_params,
2919
+ :body => post_body,
2920
+ :auth_names => auth_names,
2921
+ :return_type => return_type
2922
+ )
2923
+
2924
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2925
+ if @api_client.config.debugging
2926
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2927
+ end
2928
+ return data, status_code, headers
2929
+ end
2930
+
2931
+ # Get Link Token
2932
+ # 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.
2933
+ # @param link_token_get_request [LinkTokenGetRequest]
2934
+ # @param [Hash] opts the optional parameters
2935
+ # @return [LinkTokenGetResponse]
2936
+ def link_token_get(link_token_get_request, opts = {})
2937
+ data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
2938
+ data
2939
+ end
2940
+
2941
+ # Get Link Token
2942
+ # 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.
2943
+ # @param link_token_get_request [LinkTokenGetRequest]
2944
+ # @param [Hash] opts the optional parameters
2945
+ # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
2946
+ def link_token_get_with_http_info(link_token_get_request, opts = {})
2947
+ if @api_client.config.debugging
2948
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
2949
+ end
2950
+ # verify the required parameter 'link_token_get_request' is set
2951
+ if @api_client.config.client_side_validation && link_token_get_request.nil?
2952
+ fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
2953
+ end
2954
+ # resource path
2955
+ local_var_path = '/link/token/get'
2956
+
2957
+ # query parameters
2958
+ query_params = opts[:query_params] || {}
2959
+
2960
+ # header parameters
2961
+ header_params = opts[:header_params] || {}
2962
+ # HTTP header 'Accept' (if needed)
2963
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2964
+ # HTTP header 'Content-Type'
2965
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2966
+
2967
+ # form parameters
2968
+ form_params = opts[:form_params] || {}
2969
+
2970
+ # http body (model)
2971
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)
2972
+
2973
+ # return_type
2974
+ return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'
2975
+
2976
+ # auth_names
2977
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2978
+
2979
+ new_options = opts.merge(
2980
+ :operation => :"PlaidApi.link_token_get",
2981
+ :header_params => header_params,
2982
+ :query_params => query_params,
2983
+ :form_params => form_params,
2984
+ :body => post_body,
2985
+ :auth_names => auth_names,
2986
+ :return_type => return_type
2987
+ )
2988
+
2989
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2990
+ if @api_client.config.debugging
2991
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2992
+ end
2993
+ return data, status_code, headers
2994
+ end
2995
+
2996
+ # Create a payment
2997
+ # 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.
2998
+ # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
2999
+ # @param [Hash] opts the optional parameters
3000
+ # @return [PaymentInitiationPaymentCreateResponse]
3001
+ def payment_initiation_payment_create(payment_initiation_payment_create_request, opts = {})
3002
+ data, _status_code, _headers = payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts)
3003
+ data
3004
+ end
3005
+
3006
+ # Create a payment
3007
+ # 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.
3008
+ # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3009
+ # @param [Hash] opts the optional parameters
3010
+ # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
3011
+ def payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts = {})
3012
+ if @api_client.config.debugging
3013
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_create ...'
3014
+ end
3015
+ # verify the required parameter 'payment_initiation_payment_create_request' is set
3016
+ if @api_client.config.client_side_validation && payment_initiation_payment_create_request.nil?
3017
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_create_request' when calling PlaidApi.payment_initiation_payment_create"
3018
+ end
3019
+ # resource path
3020
+ local_var_path = '/payment_initiation/payment/create'
3021
+
3022
+ # query parameters
3023
+ query_params = opts[:query_params] || {}
3024
+
3025
+ # header parameters
3026
+ header_params = opts[:header_params] || {}
3027
+ # HTTP header 'Accept' (if needed)
3028
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3029
+ # HTTP header 'Content-Type'
3030
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3031
+
3032
+ # form parameters
3033
+ form_params = opts[:form_params] || {}
3034
+
3035
+ # http body (model)
3036
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_create_request)
3037
+
3038
+ # return_type
3039
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentCreateResponse'
3040
+
3041
+ # auth_names
3042
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3043
+
3044
+ new_options = opts.merge(
3045
+ :operation => :"PlaidApi.payment_initiation_payment_create",
3046
+ :header_params => header_params,
3047
+ :query_params => query_params,
3048
+ :form_params => form_params,
3049
+ :body => post_body,
3050
+ :auth_names => auth_names,
3051
+ :return_type => return_type
3052
+ )
3053
+
3054
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3055
+ if @api_client.config.debugging
3056
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3057
+ end
3058
+ return data, status_code, headers
3059
+ end
3060
+
3061
+ # Get payment details
3062
+ # 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.
3063
+ # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
3064
+ # @param [Hash] opts the optional parameters
3065
+ # @return [PaymentInitiationPaymentGetResponse]
3066
+ def payment_initiation_payment_get(payment_initiation_payment_get_request, opts = {})
3067
+ data, _status_code, _headers = payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts)
3068
+ data
3069
+ end
3070
+
3071
+ # Get payment details
3072
+ # 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.
3073
+ # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
3074
+ # @param [Hash] opts the optional parameters
3075
+ # @return [Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>] PaymentInitiationPaymentGetResponse data, response status code and response headers
3076
+ def payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts = {})
3077
+ if @api_client.config.debugging
3078
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_get ...'
3079
+ end
3080
+ # verify the required parameter 'payment_initiation_payment_get_request' is set
3081
+ if @api_client.config.client_side_validation && payment_initiation_payment_get_request.nil?
3082
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_get_request' when calling PlaidApi.payment_initiation_payment_get"
3083
+ end
3084
+ # resource path
3085
+ local_var_path = '/payment_initiation/payment/get'
3086
+
3087
+ # query parameters
3088
+ query_params = opts[:query_params] || {}
3089
+
3090
+ # header parameters
3091
+ header_params = opts[:header_params] || {}
3092
+ # HTTP header 'Accept' (if needed)
3093
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3094
+ # HTTP header 'Content-Type'
3095
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3096
+
3097
+ # form parameters
3098
+ form_params = opts[:form_params] || {}
3099
+
3100
+ # http body (model)
3101
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_get_request)
3102
+
3103
+ # return_type
3104
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentGetResponse'
3105
+
3106
+ # auth_names
3107
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3108
+
3109
+ new_options = opts.merge(
3110
+ :operation => :"PlaidApi.payment_initiation_payment_get",
3111
+ :header_params => header_params,
3112
+ :query_params => query_params,
3113
+ :form_params => form_params,
3114
+ :body => post_body,
3115
+ :auth_names => auth_names,
3116
+ :return_type => return_type
3117
+ )
3118
+
3119
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3120
+ if @api_client.config.debugging
3121
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3122
+ end
3123
+ return data, status_code, headers
3124
+ end
3125
+
3126
+ # List payments
3127
+ # 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.
3128
+ # @param payment_initiation_payment_list_request [PaymentInitiationPaymentListRequest]
3129
+ # @param [Hash] opts the optional parameters
3130
+ # @return [PaymentInitiationPaymentListResponse]
3131
+ def payment_initiation_payment_list(payment_initiation_payment_list_request, opts = {})
3132
+ data, _status_code, _headers = payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts)
3133
+ data
3134
+ end
3135
+
3136
+ # List payments
3137
+ # 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.
3138
+ # @param payment_initiation_payment_list_request [PaymentInitiationPaymentListRequest]
3139
+ # @param [Hash] opts the optional parameters
3140
+ # @return [Array<(PaymentInitiationPaymentListResponse, Integer, Hash)>] PaymentInitiationPaymentListResponse data, response status code and response headers
3141
+ def payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts = {})
3142
+ if @api_client.config.debugging
3143
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_list ...'
3144
+ end
3145
+ # verify the required parameter 'payment_initiation_payment_list_request' is set
3146
+ if @api_client.config.client_side_validation && payment_initiation_payment_list_request.nil?
3147
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_list_request' when calling PlaidApi.payment_initiation_payment_list"
3148
+ end
3149
+ # resource path
3150
+ local_var_path = '/payment_initiation/payment/list'
3151
+
3152
+ # query parameters
3153
+ query_params = opts[:query_params] || {}
3154
+
3155
+ # header parameters
3156
+ header_params = opts[:header_params] || {}
3157
+ # HTTP header 'Accept' (if needed)
3158
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3159
+ # HTTP header 'Content-Type'
3160
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3161
+
3162
+ # form parameters
3163
+ form_params = opts[:form_params] || {}
3164
+
3165
+ # http body (model)
3166
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_list_request)
3167
+
3168
+ # return_type
3169
+ return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentListResponse'
3170
+
3171
+ # auth_names
3172
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3173
+
3174
+ new_options = opts.merge(
3175
+ :operation => :"PlaidApi.payment_initiation_payment_list",
3176
+ :header_params => header_params,
3177
+ :query_params => query_params,
3178
+ :form_params => form_params,
3179
+ :body => post_body,
3180
+ :auth_names => auth_names,
3181
+ :return_type => return_type
3182
+ )
3183
+
3184
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3185
+ if @api_client.config.debugging
3186
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3187
+ end
3188
+ return data, status_code, headers
3189
+ end
3190
+
3191
+ # Create payment recipient
3192
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`. In the Sandbox environment, you can use the `/payment_initiation/recipient/create` endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid's Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3193
+ # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3194
+ # @param [Hash] opts the optional parameters
3195
+ # @return [PaymentInitiationRecipientCreateResponse]
3196
+ def payment_initiation_recipient_create(payment_initiation_recipient_create_request, opts = {})
3197
+ data, _status_code, _headers = payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts)
3198
+ data
3199
+ end
3200
+
3201
+ # Create payment recipient
3202
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;. In the Sandbox environment, you can use the &#x60;/payment_initiation/recipient/create&#x60; endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid&#39;s Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
3203
+ # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
3204
+ # @param [Hash] opts the optional parameters
3205
+ # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
3206
+ def payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts = {})
3207
+ if @api_client.config.debugging
3208
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_create ...'
3209
+ end
3210
+ # verify the required parameter 'payment_initiation_recipient_create_request' is set
3211
+ if @api_client.config.client_side_validation && payment_initiation_recipient_create_request.nil?
3212
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_create_request' when calling PlaidApi.payment_initiation_recipient_create"
3213
+ end
3214
+ # resource path
3215
+ local_var_path = '/payment_initiation/recipient/create'
3216
+
3217
+ # query parameters
3218
+ query_params = opts[:query_params] || {}
3219
+
3220
+ # header parameters
3221
+ header_params = opts[:header_params] || {}
3222
+ # HTTP header 'Accept' (if needed)
3223
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3224
+ # HTTP header 'Content-Type'
3225
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3226
+
3227
+ # form parameters
3228
+ form_params = opts[:form_params] || {}
3229
+
3230
+ # http body (model)
3231
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_create_request)
3232
+
3233
+ # return_type
3234
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientCreateResponse'
3235
+
3236
+ # auth_names
3237
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3238
+
3239
+ new_options = opts.merge(
3240
+ :operation => :"PlaidApi.payment_initiation_recipient_create",
3241
+ :header_params => header_params,
3242
+ :query_params => query_params,
3243
+ :form_params => form_params,
3244
+ :body => post_body,
3245
+ :auth_names => auth_names,
3246
+ :return_type => return_type
3247
+ )
3248
+
3249
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3250
+ if @api_client.config.debugging
3251
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3252
+ end
3253
+ return data, status_code, headers
3254
+ end
3255
+
3256
+ # Get payment recipient
3257
+ # Get details about a payment recipient you have previously created.
3258
+ # @param payment_initiation_recipient_get_request [PaymentInitiationRecipientGetRequest]
3259
+ # @param [Hash] opts the optional parameters
3260
+ # @return [PaymentInitiationRecipientGetResponse]
3261
+ def payment_initiation_recipient_get(payment_initiation_recipient_get_request, opts = {})
3262
+ data, _status_code, _headers = payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts)
3263
+ data
3264
+ end
3265
+
3266
+ # Get payment recipient
3267
+ # Get details about a payment recipient you have previously created.
3268
+ # @param payment_initiation_recipient_get_request [PaymentInitiationRecipientGetRequest]
3269
+ # @param [Hash] opts the optional parameters
3270
+ # @return [Array<(PaymentInitiationRecipientGetResponse, Integer, Hash)>] PaymentInitiationRecipientGetResponse data, response status code and response headers
3271
+ def payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts = {})
3272
+ if @api_client.config.debugging
3273
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_get ...'
3274
+ end
3275
+ # verify the required parameter 'payment_initiation_recipient_get_request' is set
3276
+ if @api_client.config.client_side_validation && payment_initiation_recipient_get_request.nil?
3277
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_get_request' when calling PlaidApi.payment_initiation_recipient_get"
3278
+ end
3279
+ # resource path
3280
+ local_var_path = '/payment_initiation/recipient/get'
3281
+
3282
+ # query parameters
3283
+ query_params = opts[:query_params] || {}
3284
+
3285
+ # header parameters
3286
+ header_params = opts[:header_params] || {}
3287
+ # HTTP header 'Accept' (if needed)
3288
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3289
+ # HTTP header 'Content-Type'
3290
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3291
+
3292
+ # form parameters
3293
+ form_params = opts[:form_params] || {}
3294
+
3295
+ # http body (model)
3296
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_get_request)
3297
+
3298
+ # return_type
3299
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientGetResponse'
3300
+
3301
+ # auth_names
3302
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3303
+
3304
+ new_options = opts.merge(
3305
+ :operation => :"PlaidApi.payment_initiation_recipient_get",
3306
+ :header_params => header_params,
3307
+ :query_params => query_params,
3308
+ :form_params => form_params,
3309
+ :body => post_body,
3310
+ :auth_names => auth_names,
3311
+ :return_type => return_type
3312
+ )
3313
+
3314
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3315
+ if @api_client.config.debugging
3316
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3317
+ end
3318
+ return data, status_code, headers
3319
+ end
3320
+
3321
+ # List payment recipients
3322
+ # The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
3323
+ # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
3324
+ # @param [Hash] opts the optional parameters
3325
+ # @return [PaymentInitiationRecipientListResponse]
3326
+ def payment_initiation_recipient_list(payment_initiation_recipient_list_request, opts = {})
3327
+ data, _status_code, _headers = payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts)
3328
+ data
3329
+ end
3330
+
3331
+ # List payment recipients
3332
+ # The &#x60;/payment_initiation/recipient/list&#x60; endpoint list the payment recipients that you have previously created.
3333
+ # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
3334
+ # @param [Hash] opts the optional parameters
3335
+ # @return [Array<(PaymentInitiationRecipientListResponse, Integer, Hash)>] PaymentInitiationRecipientListResponse data, response status code and response headers
3336
+ def payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts = {})
3337
+ if @api_client.config.debugging
3338
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_list ...'
3339
+ end
3340
+ # verify the required parameter 'payment_initiation_recipient_list_request' is set
3341
+ if @api_client.config.client_side_validation && payment_initiation_recipient_list_request.nil?
3342
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_list_request' when calling PlaidApi.payment_initiation_recipient_list"
3343
+ end
3344
+ # resource path
3345
+ local_var_path = '/payment_initiation/recipient/list'
3346
+
3347
+ # query parameters
3348
+ query_params = opts[:query_params] || {}
3349
+
3350
+ # header parameters
3351
+ header_params = opts[:header_params] || {}
3352
+ # HTTP header 'Accept' (if needed)
3353
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3354
+ # HTTP header 'Content-Type'
3355
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3356
+
3357
+ # form parameters
3358
+ form_params = opts[:form_params] || {}
3359
+
3360
+ # http body (model)
3361
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_list_request)
3362
+
3363
+ # return_type
3364
+ return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientListResponse'
3365
+
3366
+ # auth_names
3367
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3368
+
3369
+ new_options = opts.merge(
3370
+ :operation => :"PlaidApi.payment_initiation_recipient_list",
3371
+ :header_params => header_params,
3372
+ :query_params => query_params,
3373
+ :form_params => form_params,
3374
+ :body => post_body,
3375
+ :auth_names => auth_names,
3376
+ :return_type => return_type
3377
+ )
3378
+
3379
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3380
+ if @api_client.config.debugging
3381
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3382
+ end
3383
+ return data, status_code, headers
3384
+ end
3385
+
3386
+ # Create an income verification instance
3387
+ # `/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.
3388
+ # @param [Hash] opts the optional parameters
3389
+ # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3390
+ # @return [IncomeVerificationCreateResponse]
3391
+ def post_income_verification_create(opts = {})
3392
+ data, _status_code, _headers = post_income_verification_create_with_http_info(opts)
3393
+ data
3394
+ end
3395
+
3396
+ # Create an income verification instance
3397
+ # &#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.
3398
+ # @param [Hash] opts the optional parameters
3399
+ # @option opts [IncomeVerificationCreateRequest] :income_verification_create_request
3400
+ # @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
3401
+ def post_income_verification_create_with_http_info(opts = {})
3402
+ if @api_client.config.debugging
3403
+ @api_client.config.logger.debug 'Calling API: PlaidApi.post_income_verification_create ...'
3404
+ end
3405
+ # resource path
3406
+ local_var_path = '/income/verification/create'
3407
+
3408
+ # query parameters
3409
+ query_params = opts[:query_params] || {}
3410
+
3411
+ # header parameters
3412
+ header_params = opts[:header_params] || {}
3413
+ # HTTP header 'Accept' (if needed)
3414
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3415
+ # HTTP header 'Content-Type'
3416
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3417
+
3418
+ # form parameters
3419
+ form_params = opts[:form_params] || {}
3420
+
3421
+ # http body (model)
3422
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'income_verification_create_request'])
3423
+
3424
+ # return_type
3425
+ return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
3426
+
3427
+ # auth_names
3428
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3429
+
3430
+ new_options = opts.merge(
3431
+ :operation => :"PlaidApi.post_income_verification_create",
3432
+ :header_params => header_params,
3433
+ :query_params => query_params,
3434
+ :form_params => form_params,
3435
+ :body => post_body,
3436
+ :auth_names => auth_names,
3437
+ :return_type => return_type
3438
+ )
3439
+
3440
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3441
+ if @api_client.config.debugging
3442
+ @api_client.config.logger.debug "API called: PlaidApi#post_income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3443
+ end
3444
+ return data, status_code, headers
3445
+ end
3446
+
3447
+ # Create Apex bank account token
3448
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3449
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3450
+ # @param [Hash] opts the optional parameters
3451
+ # @return [ProcessorTokenCreateResponse]
3452
+ def processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {})
3453
+ data, _status_code, _headers = processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts)
3454
+ data
3455
+ end
3456
+
3457
+ # Create Apex bank account token
3458
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
3459
+ # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
3460
+ # @param [Hash] opts the optional parameters
3461
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3462
+ def processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {})
3463
+ if @api_client.config.debugging
3464
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_apex_processor_token_create ...'
3465
+ end
3466
+ # verify the required parameter 'processor_apex_processor_token_create_request' is set
3467
+ if @api_client.config.client_side_validation && processor_apex_processor_token_create_request.nil?
3468
+ fail ArgumentError, "Missing the required parameter 'processor_apex_processor_token_create_request' when calling PlaidApi.processor_apex_processor_token_create"
3469
+ end
3470
+ # resource path
3471
+ local_var_path = '/processor/apex/processor_token/create'
3472
+
3473
+ # query parameters
3474
+ query_params = opts[:query_params] || {}
3475
+
3476
+ # header parameters
3477
+ header_params = opts[:header_params] || {}
3478
+ # HTTP header 'Accept' (if needed)
3479
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3480
+ # HTTP header 'Content-Type'
3481
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3482
+
3483
+ # form parameters
3484
+ form_params = opts[:form_params] || {}
3485
+
3486
+ # http body (model)
3487
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_apex_processor_token_create_request)
3488
+
3489
+ # return_type
3490
+ return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
3491
+
3492
+ # auth_names
3493
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3494
+
3495
+ new_options = opts.merge(
3496
+ :operation => :"PlaidApi.processor_apex_processor_token_create",
3497
+ :header_params => header_params,
3498
+ :query_params => query_params,
3499
+ :form_params => form_params,
3500
+ :body => post_body,
3501
+ :auth_names => auth_names,
3502
+ :return_type => return_type
3503
+ )
3504
+
3505
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3506
+ if @api_client.config.debugging
3507
+ @api_client.config.logger.debug "API called: PlaidApi#processor_apex_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3508
+ end
3509
+ return data, status_code, headers
3510
+ end
3511
+
3512
+ # Retrieve Auth data
3513
+ # 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.
3514
+ # @param processor_auth_get_request [ProcessorAuthGetRequest]
3515
+ # @param [Hash] opts the optional parameters
3516
+ # @return [ProcessorAuthGetResponse]
3517
+ def processor_auth_get(processor_auth_get_request, opts = {})
3518
+ data, _status_code, _headers = processor_auth_get_with_http_info(processor_auth_get_request, opts)
3519
+ data
3520
+ end
3521
+
3522
+ # Retrieve Auth data
3523
+ # 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.
3524
+ # @param processor_auth_get_request [ProcessorAuthGetRequest]
3525
+ # @param [Hash] opts the optional parameters
3526
+ # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
3527
+ def processor_auth_get_with_http_info(processor_auth_get_request, opts = {})
3528
+ if @api_client.config.debugging
3529
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_auth_get ...'
3530
+ end
3531
+ # verify the required parameter 'processor_auth_get_request' is set
3532
+ if @api_client.config.client_side_validation && processor_auth_get_request.nil?
3533
+ fail ArgumentError, "Missing the required parameter 'processor_auth_get_request' when calling PlaidApi.processor_auth_get"
3534
+ end
3535
+ # resource path
3536
+ local_var_path = '/processor/auth/get'
3537
+
3538
+ # query parameters
3539
+ query_params = opts[:query_params] || {}
3540
+
3541
+ # header parameters
3542
+ header_params = opts[:header_params] || {}
3543
+ # HTTP header 'Accept' (if needed)
3544
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3545
+ # HTTP header 'Content-Type'
3546
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3547
+
3548
+ # form parameters
3549
+ form_params = opts[:form_params] || {}
3550
+
3551
+ # http body (model)
3552
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_auth_get_request)
3553
+
3554
+ # return_type
3555
+ return_type = opts[:debug_return_type] || 'ProcessorAuthGetResponse'
3556
+
3557
+ # auth_names
3558
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3559
+
3560
+ new_options = opts.merge(
3561
+ :operation => :"PlaidApi.processor_auth_get",
3562
+ :header_params => header_params,
3563
+ :query_params => query_params,
3564
+ :form_params => form_params,
3565
+ :body => post_body,
3566
+ :auth_names => auth_names,
3567
+ :return_type => return_type
3568
+ )
3569
+
3570
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3571
+ if @api_client.config.debugging
3572
+ @api_client.config.logger.debug "API called: PlaidApi#processor_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3573
+ end
3574
+ return data, status_code, headers
3575
+ end
3576
+
3577
+ # Retrieve Balance data
3578
+ # 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.
3579
+ # @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;.
3580
+ # @param [Hash] opts the optional parameters
3581
+ # @return [ProcessorBalanceGetResponse]
3582
+ def processor_balance_get(processor_balance_get_request, opts = {})
3583
+ data, _status_code, _headers = processor_balance_get_with_http_info(processor_balance_get_request, opts)
3584
+ data
3585
+ end
3586
+
3587
+ # Retrieve Balance data
3588
+ # 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.
3589
+ # @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;.
3590
+ # @param [Hash] opts the optional parameters
3591
+ # @return [Array<(ProcessorBalanceGetResponse, Integer, Hash)>] ProcessorBalanceGetResponse data, response status code and response headers
3592
+ def processor_balance_get_with_http_info(processor_balance_get_request, opts = {})
3593
+ if @api_client.config.debugging
3594
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_balance_get ...'
3595
+ end
3596
+ # verify the required parameter 'processor_balance_get_request' is set
3597
+ if @api_client.config.client_side_validation && processor_balance_get_request.nil?
3598
+ fail ArgumentError, "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get"
3599
+ end
3600
+ # resource path
3601
+ local_var_path = '/processor/balance/get'
3602
+
3603
+ # query parameters
3604
+ query_params = opts[:query_params] || {}
3605
+
3606
+ # header parameters
3607
+ header_params = opts[:header_params] || {}
3608
+ # HTTP header 'Accept' (if needed)
3609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3610
+ # HTTP header 'Content-Type'
3611
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3612
+
3613
+ # form parameters
3614
+ form_params = opts[:form_params] || {}
3615
+
3616
+ # http body (model)
3617
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_balance_get_request)
3618
+
3619
+ # return_type
3620
+ return_type = opts[:debug_return_type] || 'ProcessorBalanceGetResponse'
3621
+
3622
+ # auth_names
3623
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3624
+
3625
+ new_options = opts.merge(
3626
+ :operation => :"PlaidApi.processor_balance_get",
3627
+ :header_params => header_params,
3628
+ :query_params => query_params,
3629
+ :form_params => form_params,
3630
+ :body => post_body,
3631
+ :auth_names => auth_names,
3632
+ :return_type => return_type
3633
+ )
3634
+
3635
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3636
+ if @api_client.config.debugging
3637
+ @api_client.config.logger.debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3638
+ end
3639
+ return data, status_code, headers
3640
+ end
3641
+
3642
+ # Retrieve Identity data
3643
+ # 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.
3644
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
3645
+ # @param [Hash] opts the optional parameters
3646
+ # @return [ProcessorIdentityGetResponse]
3647
+ def processor_identity_get(processor_identity_get_request, opts = {})
3648
+ data, _status_code, _headers = processor_identity_get_with_http_info(processor_identity_get_request, opts)
3649
+ data
3650
+ end
3651
+
3652
+ # Retrieve Identity data
3653
+ # 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.
3654
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
3655
+ # @param [Hash] opts the optional parameters
3656
+ # @return [Array<(ProcessorIdentityGetResponse, Integer, Hash)>] ProcessorIdentityGetResponse data, response status code and response headers
3657
+ def processor_identity_get_with_http_info(processor_identity_get_request, opts = {})
3658
+ if @api_client.config.debugging
3659
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_get ...'
3660
+ end
3661
+ # verify the required parameter 'processor_identity_get_request' is set
3662
+ if @api_client.config.client_side_validation && processor_identity_get_request.nil?
3663
+ fail ArgumentError, "Missing the required parameter 'processor_identity_get_request' when calling PlaidApi.processor_identity_get"
3664
+ end
3665
+ # resource path
3666
+ local_var_path = '/processor/identity/get'
3667
+
3668
+ # query parameters
3669
+ query_params = opts[:query_params] || {}
3670
+
3671
+ # header parameters
3672
+ header_params = opts[:header_params] || {}
3673
+ # HTTP header 'Accept' (if needed)
3674
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3675
+ # HTTP header 'Content-Type'
3676
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3677
+
3678
+ # form parameters
3679
+ form_params = opts[:form_params] || {}
3680
+
3681
+ # http body (model)
3682
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_get_request)
3683
+
3684
+ # return_type
3685
+ return_type = opts[:debug_return_type] || 'ProcessorIdentityGetResponse'
3686
+
3687
+ # auth_names
3688
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3689
+
3690
+ new_options = opts.merge(
3691
+ :operation => :"PlaidApi.processor_identity_get",
3692
+ :header_params => header_params,
3693
+ :query_params => query_params,
3694
+ :form_params => form_params,
3695
+ :body => post_body,
3696
+ :auth_names => auth_names,
3697
+ :return_type => return_type
3698
+ )
3699
+
3700
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3701
+ if @api_client.config.debugging
3702
+ @api_client.config.logger.debug "API called: PlaidApi#processor_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3703
+ end
3704
+ return data, status_code, headers
3705
+ end
3706
+
3707
+ # Create Stripe bank account token
3708
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
3709
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3710
+ # @param [Hash] opts the optional parameters
3711
+ # @return [ProcessorStripeBankAccountTokenCreateResponse]
3712
+ def processor_stripe_bank_account_token_create(processor_stripe_bank_account_token_create_request, opts = {})
3713
+ data, _status_code, _headers = processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts)
3714
+ data
3715
+ end
3716
+
3717
+ # Create Stripe bank account token
3718
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
3719
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
3720
+ # @param [Hash] opts the optional parameters
3721
+ # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
3722
+ def processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts = {})
3723
+ if @api_client.config.debugging
3724
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_stripe_bank_account_token_create ...'
3725
+ end
3726
+ # verify the required parameter 'processor_stripe_bank_account_token_create_request' is set
3727
+ if @api_client.config.client_side_validation && processor_stripe_bank_account_token_create_request.nil?
3728
+ fail ArgumentError, "Missing the required parameter 'processor_stripe_bank_account_token_create_request' when calling PlaidApi.processor_stripe_bank_account_token_create"
3729
+ end
3730
+ # resource path
3731
+ local_var_path = '/processor/stripe/bank_account_token/create'
3732
+
3733
+ # query parameters
3734
+ query_params = opts[:query_params] || {}
3735
+
3736
+ # header parameters
3737
+ header_params = opts[:header_params] || {}
3738
+ # HTTP header 'Accept' (if needed)
3739
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3740
+ # HTTP header 'Content-Type'
3741
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3742
+
3743
+ # form parameters
3744
+ form_params = opts[:form_params] || {}
3745
+
3746
+ # http body (model)
3747
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_stripe_bank_account_token_create_request)
3748
+
3749
+ # return_type
3750
+ return_type = opts[:debug_return_type] || 'ProcessorStripeBankAccountTokenCreateResponse'
3751
+
3752
+ # auth_names
3753
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3754
+
3755
+ new_options = opts.merge(
3756
+ :operation => :"PlaidApi.processor_stripe_bank_account_token_create",
3757
+ :header_params => header_params,
3758
+ :query_params => query_params,
3759
+ :form_params => form_params,
3760
+ :body => post_body,
3761
+ :auth_names => auth_names,
3762
+ :return_type => return_type
3763
+ )
3764
+
3765
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3766
+ if @api_client.config.debugging
3767
+ @api_client.config.logger.debug "API called: PlaidApi#processor_stripe_bank_account_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3768
+ end
3769
+ return data, status_code, headers
3770
+ end
3771
+
3772
+ # Create processor token
3773
+ # 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.
3774
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
3775
+ # @param [Hash] opts the optional parameters
3776
+ # @return [ProcessorTokenCreateResponse]
3777
+ def processor_token_create(processor_token_create_request, opts = {})
3778
+ data, _status_code, _headers = processor_token_create_with_http_info(processor_token_create_request, opts)
3779
+ data
3780
+ end
3781
+
3782
+ # Create processor token
3783
+ # 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.
3784
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
3785
+ # @param [Hash] opts the optional parameters
3786
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
3787
+ def processor_token_create_with_http_info(processor_token_create_request, opts = {})
3788
+ if @api_client.config.debugging
3789
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_create ...'
3790
+ end
3791
+ # verify the required parameter 'processor_token_create_request' is set
3792
+ if @api_client.config.client_side_validation && processor_token_create_request.nil?
3793
+ fail ArgumentError, "Missing the required parameter 'processor_token_create_request' when calling PlaidApi.processor_token_create"
3794
+ end
3795
+ # resource path
3796
+ local_var_path = '/processor/token/create'
3797
+
3798
+ # query parameters
3799
+ query_params = opts[:query_params] || {}
3800
+
3801
+ # header parameters
3802
+ header_params = opts[:header_params] || {}
3803
+ # HTTP header 'Accept' (if needed)
3804
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3805
+ # HTTP header 'Content-Type'
3806
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3807
+
3808
+ # form parameters
3809
+ form_params = opts[:form_params] || {}
3810
+
3811
+ # http body (model)
3812
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_create_request)
3813
+
3814
+ # return_type
3815
+ return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
3816
+
3817
+ # auth_names
3818
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3819
+
3820
+ new_options = opts.merge(
3821
+ :operation => :"PlaidApi.processor_token_create",
3822
+ :header_params => header_params,
3823
+ :query_params => query_params,
3824
+ :form_params => form_params,
3825
+ :body => post_body,
3826
+ :auth_names => auth_names,
3827
+ :return_type => return_type
3828
+ )
3829
+
3830
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3831
+ if @api_client.config.debugging
3832
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3833
+ end
3834
+ return data, status_code, headers
3835
+ end
3836
+
3837
+ # Manually fire a Bank Transfer webhook
3838
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3839
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3840
+ # @param [Hash] opts the optional parameters
3841
+ # @return [SandboxBankTransferFireWebhookResponse]
3842
+ def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
3843
+ data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
3844
+ data
3845
+ end
3846
+
3847
+ # Manually fire a Bank Transfer webhook
3848
+ # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3849
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3850
+ # @param [Hash] opts the optional parameters
3851
+ # @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
3852
+ def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
3853
+ if @api_client.config.debugging
3854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
3855
+ end
3856
+ # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
3857
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
3858
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
3859
+ end
3860
+ # resource path
3861
+ local_var_path = '/sandbox/bank_transfer/fire_webhook'
3862
+
3863
+ # query parameters
3864
+ query_params = opts[:query_params] || {}
3865
+
3866
+ # header parameters
3867
+ header_params = opts[:header_params] || {}
3868
+ # HTTP header 'Accept' (if needed)
3869
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3870
+ # HTTP header 'Content-Type'
3871
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3872
+
3873
+ # form parameters
3874
+ form_params = opts[:form_params] || {}
3875
+
3876
+ # http body (model)
3877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_fire_webhook_request)
3878
+
3879
+ # return_type
3880
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
3881
+
3882
+ # auth_names
3883
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3884
+
3885
+ new_options = opts.merge(
3886
+ :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
3887
+ :header_params => header_params,
3888
+ :query_params => query_params,
3889
+ :form_params => form_params,
3890
+ :body => post_body,
3891
+ :auth_names => auth_names,
3892
+ :return_type => return_type
3893
+ )
3894
+
3895
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3896
+ if @api_client.config.debugging
3897
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3898
+ end
3899
+ return data, status_code, headers
3900
+ end
3901
+
3902
+ # Simulate a bank transfer event in Sandbox
3903
+ # 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.
3904
+ # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
3905
+ # @param [Hash] opts the optional parameters
3906
+ # @return [SandboxBankTransferSimulateResponse]
3907
+ def sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request, opts = {})
3908
+ data, _status_code, _headers = sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts)
3909
+ data
3910
+ end
3911
+
3912
+ # Simulate a bank transfer event in Sandbox
3913
+ # 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.
3914
+ # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
3915
+ # @param [Hash] opts the optional parameters
3916
+ # @return [Array<(SandboxBankTransferSimulateResponse, Integer, Hash)>] SandboxBankTransferSimulateResponse data, response status code and response headers
3917
+ def sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts = {})
3918
+ if @api_client.config.debugging
3919
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_simulate ...'
3920
+ end
3921
+ # verify the required parameter 'sandbox_bank_transfer_simulate_request' is set
3922
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_simulate_request.nil?
3923
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_simulate_request' when calling PlaidApi.sandbox_bank_transfer_simulate"
3924
+ end
3925
+ # resource path
3926
+ local_var_path = '/sandbox/bank_transfer/simulate'
3927
+
3928
+ # query parameters
3929
+ query_params = opts[:query_params] || {}
3930
+
3931
+ # header parameters
3932
+ header_params = opts[:header_params] || {}
3933
+ # HTTP header 'Accept' (if needed)
3934
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3935
+ # HTTP header 'Content-Type'
3936
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3937
+
3938
+ # form parameters
3939
+ form_params = opts[:form_params] || {}
3940
+
3941
+ # http body (model)
3942
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_simulate_request)
3943
+
3944
+ # return_type
3945
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferSimulateResponse'
3946
+
3947
+ # auth_names
3948
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3949
+
3950
+ new_options = opts.merge(
3951
+ :operation => :"PlaidApi.sandbox_bank_transfer_simulate",
3952
+ :header_params => header_params,
3953
+ :query_params => query_params,
3954
+ :form_params => form_params,
3955
+ :body => post_body,
3956
+ :auth_names => auth_names,
3957
+ :return_type => return_type
3958
+ )
3959
+
3960
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3961
+ if @api_client.config.debugging
3962
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3963
+ end
3964
+ return data, status_code, headers
3965
+ end
3966
+
3967
+ # Fire a test webhook
3968
+ # 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.
3969
+ # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
3970
+ # @param [Hash] opts the optional parameters
3971
+ # @return [SandboxItemFireWebhookResponse]
3972
+ def sandbox_item_fire_webhook(sandbox_item_fire_webhook_request, opts = {})
3973
+ data, _status_code, _headers = sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts)
3974
+ data
3975
+ end
3976
+
3977
+ # Fire a test webhook
3978
+ # 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.
3979
+ # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
3980
+ # @param [Hash] opts the optional parameters
3981
+ # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
3982
+ def sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts = {})
3983
+ if @api_client.config.debugging
3984
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_fire_webhook ...'
3985
+ end
3986
+ # verify the required parameter 'sandbox_item_fire_webhook_request' is set
3987
+ if @api_client.config.client_side_validation && sandbox_item_fire_webhook_request.nil?
3988
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_fire_webhook_request' when calling PlaidApi.sandbox_item_fire_webhook"
3989
+ end
3990
+ # resource path
3991
+ local_var_path = '/sandbox/item/fire_webhook'
3992
+
3993
+ # query parameters
3994
+ query_params = opts[:query_params] || {}
3995
+
3996
+ # header parameters
3997
+ header_params = opts[:header_params] || {}
3998
+ # HTTP header 'Accept' (if needed)
3999
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4000
+ # HTTP header 'Content-Type'
4001
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4002
+
4003
+ # form parameters
4004
+ form_params = opts[:form_params] || {}
4005
+
4006
+ # http body (model)
4007
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_fire_webhook_request)
4008
+
4009
+ # return_type
4010
+ return_type = opts[:debug_return_type] || 'SandboxItemFireWebhookResponse'
4011
+
4012
+ # auth_names
4013
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4014
+
4015
+ new_options = opts.merge(
4016
+ :operation => :"PlaidApi.sandbox_item_fire_webhook",
4017
+ :header_params => header_params,
4018
+ :query_params => query_params,
4019
+ :form_params => form_params,
4020
+ :body => post_body,
4021
+ :auth_names => auth_names,
4022
+ :return_type => return_type
4023
+ )
4024
+
4025
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4026
+ if @api_client.config.debugging
4027
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4028
+ end
4029
+ return data, status_code, headers
4030
+ end
4031
+
4032
+ # Force a Sandbox Item into an error state
4033
+ # `/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.
4034
+ # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
4035
+ # @param [Hash] opts the optional parameters
4036
+ # @return [SandboxItemResetLoginResponse]
4037
+ def sandbox_item_reset_login(sandbox_item_reset_login_request, opts = {})
4038
+ data, _status_code, _headers = sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts)
4039
+ data
4040
+ end
4041
+
4042
+ # Force a Sandbox Item into an error state
4043
+ # &#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.
4044
+ # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
4045
+ # @param [Hash] opts the optional parameters
4046
+ # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
4047
+ def sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts = {})
4048
+ if @api_client.config.debugging
4049
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_reset_login ...'
4050
+ end
4051
+ # verify the required parameter 'sandbox_item_reset_login_request' is set
4052
+ if @api_client.config.client_side_validation && sandbox_item_reset_login_request.nil?
4053
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login"
4054
+ end
4055
+ # resource path
4056
+ local_var_path = '/sandbox/item/reset_login'
4057
+
4058
+ # query parameters
4059
+ query_params = opts[:query_params] || {}
4060
+
4061
+ # header parameters
4062
+ header_params = opts[:header_params] || {}
4063
+ # HTTP header 'Accept' (if needed)
4064
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4065
+ # HTTP header 'Content-Type'
4066
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4067
+
4068
+ # form parameters
4069
+ form_params = opts[:form_params] || {}
4070
+
4071
+ # http body (model)
4072
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_reset_login_request)
4073
+
4074
+ # return_type
4075
+ return_type = opts[:debug_return_type] || 'SandboxItemResetLoginResponse'
4076
+
4077
+ # auth_names
4078
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4079
+
4080
+ new_options = opts.merge(
4081
+ :operation => :"PlaidApi.sandbox_item_reset_login",
4082
+ :header_params => header_params,
4083
+ :query_params => query_params,
4084
+ :form_params => form_params,
4085
+ :body => post_body,
4086
+ :auth_names => auth_names,
4087
+ :return_type => return_type
4088
+ )
4089
+
4090
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4091
+ if @api_client.config.debugging
4092
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4093
+ end
4094
+ return data, status_code, headers
4095
+ end
4096
+
4097
+ # Set verification status for Sandbox account
4098
+ # 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#).
4099
+ # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4100
+ # @param [Hash] opts the optional parameters
4101
+ # @return [SandboxItemSetVerificationStatusResponse]
4102
+ def sandbox_item_set_verification_status(sandbox_item_set_verification_status_request, opts = {})
4103
+ data, _status_code, _headers = sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts)
4104
+ data
4105
+ end
4106
+
4107
+ # Set verification status for Sandbox account
4108
+ # 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#).
4109
+ # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
4110
+ # @param [Hash] opts the optional parameters
4111
+ # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
4112
+ def sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts = {})
4113
+ if @api_client.config.debugging
4114
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_set_verification_status ...'
4115
+ end
4116
+ # verify the required parameter 'sandbox_item_set_verification_status_request' is set
4117
+ if @api_client.config.client_side_validation && sandbox_item_set_verification_status_request.nil?
4118
+ fail ArgumentError, "Missing the required parameter 'sandbox_item_set_verification_status_request' when calling PlaidApi.sandbox_item_set_verification_status"
4119
+ end
4120
+ # resource path
4121
+ local_var_path = '/sandbox/item/set_verification_status'
4122
+
4123
+ # query parameters
4124
+ query_params = opts[:query_params] || {}
4125
+
4126
+ # header parameters
4127
+ header_params = opts[:header_params] || {}
4128
+ # HTTP header 'Accept' (if needed)
4129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4130
+ # HTTP header 'Content-Type'
4131
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4132
+
4133
+ # form parameters
4134
+ form_params = opts[:form_params] || {}
4135
+
4136
+ # http body (model)
4137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_set_verification_status_request)
4138
+
4139
+ # return_type
4140
+ return_type = opts[:debug_return_type] || 'SandboxItemSetVerificationStatusResponse'
4141
+
4142
+ # auth_names
4143
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4144
+
4145
+ new_options = opts.merge(
4146
+ :operation => :"PlaidApi.sandbox_item_set_verification_status",
4147
+ :header_params => header_params,
4148
+ :query_params => query_params,
4149
+ :form_params => form_params,
4150
+ :body => post_body,
4151
+ :auth_names => auth_names,
4152
+ :return_type => return_type
4153
+ )
4154
+
4155
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4156
+ if @api_client.config.debugging
4157
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_set_verification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4158
+ end
4159
+ return data, status_code, headers
4160
+ end
4161
+
4162
+ # Create a test Item and processor token
4163
+ # 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.
4164
+ # @param [Hash] opts the optional parameters
4165
+ # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4166
+ # @return [SandboxProcessorTokenCreateResponse]
4167
+ def sandbox_processor_token_create(opts = {})
4168
+ data, _status_code, _headers = sandbox_processor_token_create_with_http_info(opts)
4169
+ data
4170
+ end
4171
+
4172
+ # Create a test Item and processor token
4173
+ # 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.
4174
+ # @param [Hash] opts the optional parameters
4175
+ # @option opts [SandboxProcessorTokenCreateRequest] :sandbox_processor_token_create_request
4176
+ # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
4177
+ def sandbox_processor_token_create_with_http_info(opts = {})
4178
+ if @api_client.config.debugging
4179
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
4180
+ end
4181
+ # resource path
4182
+ local_var_path = '/sandbox/processor_token/create'
4183
+
4184
+ # query parameters
4185
+ query_params = opts[:query_params] || {}
4186
+
4187
+ # header parameters
4188
+ header_params = opts[:header_params] || {}
4189
+ # HTTP header 'Accept' (if needed)
4190
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4191
+ # HTTP header 'Content-Type'
4192
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4193
+
4194
+ # form parameters
4195
+ form_params = opts[:form_params] || {}
4196
+
4197
+ # http body (model)
4198
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sandbox_processor_token_create_request'])
4199
+
4200
+ # return_type
4201
+ return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
4202
+
4203
+ # auth_names
4204
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4205
+
4206
+ new_options = opts.merge(
4207
+ :operation => :"PlaidApi.sandbox_processor_token_create",
4208
+ :header_params => header_params,
4209
+ :query_params => query_params,
4210
+ :form_params => form_params,
4211
+ :body => post_body,
4212
+ :auth_names => auth_names,
4213
+ :return_type => return_type
4214
+ )
4215
+
4216
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4217
+ if @api_client.config.debugging
4218
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4219
+ end
4220
+ return data, status_code, headers
4221
+ end
4222
+
4223
+ # Create a test Item
4224
+ # 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.
4225
+ # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4226
+ # @param [Hash] opts the optional parameters
4227
+ # @return [SandboxPublicTokenCreateResponse]
4228
+ def sandbox_public_token_create(sandbox_public_token_create_request, opts = {})
4229
+ data, _status_code, _headers = sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts)
4230
+ data
4231
+ end
4232
+
4233
+ # Create a test Item
4234
+ # 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.
4235
+ # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
4236
+ # @param [Hash] opts the optional parameters
4237
+ # @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
4238
+ def sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts = {})
4239
+ if @api_client.config.debugging
4240
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_public_token_create ...'
4241
+ end
4242
+ # verify the required parameter 'sandbox_public_token_create_request' is set
4243
+ if @api_client.config.client_side_validation && sandbox_public_token_create_request.nil?
4244
+ fail ArgumentError, "Missing the required parameter 'sandbox_public_token_create_request' when calling PlaidApi.sandbox_public_token_create"
4245
+ end
4246
+ # resource path
4247
+ local_var_path = '/sandbox/public_token/create'
4248
+
4249
+ # query parameters
4250
+ query_params = opts[:query_params] || {}
4251
+
4252
+ # header parameters
4253
+ header_params = opts[:header_params] || {}
4254
+ # HTTP header 'Accept' (if needed)
4255
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4256
+ # HTTP header 'Content-Type'
4257
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4258
+
4259
+ # form parameters
4260
+ form_params = opts[:form_params] || {}
4261
+
4262
+ # http body (model)
4263
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_public_token_create_request)
4264
+
4265
+ # return_type
4266
+ return_type = opts[:debug_return_type] || 'SandboxPublicTokenCreateResponse'
4267
+
4268
+ # auth_names
4269
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4270
+
4271
+ new_options = opts.merge(
4272
+ :operation => :"PlaidApi.sandbox_public_token_create",
4273
+ :header_params => header_params,
4274
+ :query_params => query_params,
4275
+ :form_params => form_params,
4276
+ :body => post_body,
4277
+ :auth_names => auth_names,
4278
+ :return_type => return_type
4279
+ )
4280
+
4281
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4282
+ if @api_client.config.debugging
4283
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_public_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4284
+ end
4285
+ return data, status_code, headers
4286
+ end
4287
+
4288
+ # Get transaction data
4289
+ # 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.
4290
+ # @param transactions_get_request [TransactionsGetRequest]
4291
+ # @param [Hash] opts the optional parameters
4292
+ # @return [TransactionsGetResponse]
4293
+ def transactions_get(transactions_get_request, opts = {})
4294
+ data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
4295
+ data
4296
+ end
4297
+
4298
+ # Get transaction data
4299
+ # 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.
4300
+ # @param transactions_get_request [TransactionsGetRequest]
4301
+ # @param [Hash] opts the optional parameters
4302
+ # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
4303
+ def transactions_get_with_http_info(transactions_get_request, opts = {})
4304
+ if @api_client.config.debugging
4305
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
4306
+ end
4307
+ # verify the required parameter 'transactions_get_request' is set
4308
+ if @api_client.config.client_side_validation && transactions_get_request.nil?
4309
+ fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
4310
+ end
4311
+ # resource path
4312
+ local_var_path = '/transactions/get'
4313
+
4314
+ # query parameters
4315
+ query_params = opts[:query_params] || {}
4316
+
4317
+ # header parameters
4318
+ header_params = opts[:header_params] || {}
4319
+ # HTTP header 'Accept' (if needed)
4320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4321
+ # HTTP header 'Content-Type'
4322
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4323
+
4324
+ # form parameters
4325
+ form_params = opts[:form_params] || {}
4326
+
4327
+ # http body (model)
4328
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
4329
+
4330
+ # return_type
4331
+ return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
4332
+
4333
+ # auth_names
4334
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4335
+
4336
+ new_options = opts.merge(
4337
+ :operation => :"PlaidApi.transactions_get",
4338
+ :header_params => header_params,
4339
+ :query_params => query_params,
4340
+ :form_params => form_params,
4341
+ :body => post_body,
4342
+ :auth_names => auth_names,
4343
+ :return_type => return_type
4344
+ )
4345
+
4346
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4347
+ if @api_client.config.debugging
4348
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4349
+ end
4350
+ return data, status_code, headers
4351
+ end
4352
+
4353
+ # Refresh transaction data
4354
+ # `/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.
4355
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
4356
+ # @param [Hash] opts the optional parameters
4357
+ # @return [TransactionsRefreshResponse]
4358
+ def transactions_refresh(transactions_refresh_request, opts = {})
4359
+ data, _status_code, _headers = transactions_refresh_with_http_info(transactions_refresh_request, opts)
4360
+ data
4361
+ end
4362
+
4363
+ # Refresh transaction data
4364
+ # &#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.
4365
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
4366
+ # @param [Hash] opts the optional parameters
4367
+ # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
4368
+ def transactions_refresh_with_http_info(transactions_refresh_request, opts = {})
4369
+ if @api_client.config.debugging
4370
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_refresh ...'
4371
+ end
4372
+ # verify the required parameter 'transactions_refresh_request' is set
4373
+ if @api_client.config.client_side_validation && transactions_refresh_request.nil?
4374
+ fail ArgumentError, "Missing the required parameter 'transactions_refresh_request' when calling PlaidApi.transactions_refresh"
4375
+ end
4376
+ # resource path
4377
+ local_var_path = '/transactions/refresh'
4378
+
4379
+ # query parameters
4380
+ query_params = opts[:query_params] || {}
4381
+
4382
+ # header parameters
4383
+ header_params = opts[:header_params] || {}
4384
+ # HTTP header 'Accept' (if needed)
4385
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4386
+ # HTTP header 'Content-Type'
4387
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4388
+
4389
+ # form parameters
4390
+ form_params = opts[:form_params] || {}
4391
+
4392
+ # http body (model)
4393
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_refresh_request)
4394
+
4395
+ # return_type
4396
+ return_type = opts[:debug_return_type] || 'TransactionsRefreshResponse'
4397
+
4398
+ # auth_names
4399
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4400
+
4401
+ new_options = opts.merge(
4402
+ :operation => :"PlaidApi.transactions_refresh",
4403
+ :header_params => header_params,
4404
+ :query_params => query_params,
4405
+ :form_params => form_params,
4406
+ :body => post_body,
4407
+ :auth_names => auth_names,
4408
+ :return_type => return_type
4409
+ )
4410
+
4411
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4412
+ if @api_client.config.debugging
4413
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4414
+ end
4415
+ return data, status_code, headers
4416
+ end
4417
+
4418
+ # Get webhook verification key
4419
+ # 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.
4420
+ # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
4421
+ # @param [Hash] opts the optional parameters
4422
+ # @return [WebhookVerificationKeyGetResponse]
4423
+ def webhook_verification_key_get(webhook_verification_key_get_request, opts = {})
4424
+ data, _status_code, _headers = webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts)
4425
+ data
4426
+ end
4427
+
4428
+ # Get webhook verification key
4429
+ # 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.
4430
+ # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
4431
+ # @param [Hash] opts the optional parameters
4432
+ # @return [Array<(WebhookVerificationKeyGetResponse, Integer, Hash)>] WebhookVerificationKeyGetResponse data, response status code and response headers
4433
+ def webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts = {})
4434
+ if @api_client.config.debugging
4435
+ @api_client.config.logger.debug 'Calling API: PlaidApi.webhook_verification_key_get ...'
4436
+ end
4437
+ # verify the required parameter 'webhook_verification_key_get_request' is set
4438
+ if @api_client.config.client_side_validation && webhook_verification_key_get_request.nil?
4439
+ fail ArgumentError, "Missing the required parameter 'webhook_verification_key_get_request' when calling PlaidApi.webhook_verification_key_get"
4440
+ end
4441
+ # resource path
4442
+ local_var_path = '/webhook_verification_key/get'
4443
+
4444
+ # query parameters
4445
+ query_params = opts[:query_params] || {}
4446
+
4447
+ # header parameters
4448
+ header_params = opts[:header_params] || {}
4449
+ # HTTP header 'Accept' (if needed)
4450
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4451
+ # HTTP header 'Content-Type'
4452
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4453
+
4454
+ # form parameters
4455
+ form_params = opts[:form_params] || {}
4456
+
4457
+ # http body (model)
4458
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_verification_key_get_request)
4459
+
4460
+ # return_type
4461
+ return_type = opts[:debug_return_type] || 'WebhookVerificationKeyGetResponse'
4462
+
4463
+ # auth_names
4464
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4465
+
4466
+ new_options = opts.merge(
4467
+ :operation => :"PlaidApi.webhook_verification_key_get",
4468
+ :header_params => header_params,
4469
+ :query_params => query_params,
4470
+ :form_params => form_params,
4471
+ :body => post_body,
4472
+ :auth_names => auth_names,
4473
+ :return_type => return_type
4474
+ )
4475
+
4476
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4477
+ if @api_client.config.debugging
4478
+ @api_client.config.logger.debug "API called: PlaidApi#webhook_verification_key_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4479
+ end
4480
+ return data, status_code, headers
4481
+ end
4482
+ end
4483
+ end