plaid 12.0.0 → 14.0.0.beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (678) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +86 -1
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +48 -35
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +21 -0
  8. data/PUBLISH.md +7 -7
  9. data/README.md +103 -95
  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/CategoriesGetResponse.md +20 -0
  89. data/docs/Category.md +22 -0
  90. data/docs/Cause.md +20 -0
  91. data/docs/CountryCode.md +15 -0
  92. data/docs/CreditCardLiability.md +34 -0
  93. data/docs/CreditFilter.md +18 -0
  94. data/docs/DefaultUpdateWebhook.md +26 -0
  95. data/docs/DepositSwitchAddressData.md +26 -0
  96. data/docs/DepositSwitchAltCreateRequest.md +24 -0
  97. data/docs/DepositSwitchAltCreateResponse.md +20 -0
  98. data/docs/DepositSwitchCreateRequest.md +24 -0
  99. data/docs/DepositSwitchCreateResponse.md +20 -0
  100. data/docs/DepositSwitchGetRequest.md +22 -0
  101. data/docs/DepositSwitchGetResponse.md +38 -0
  102. data/docs/DepositSwitchTargetAccount.md +24 -0
  103. data/docs/DepositSwitchTargetUser.md +28 -0
  104. data/docs/DepositSwitchTokenCreateRequest.md +22 -0
  105. data/docs/DepositSwitchTokenCreateResponse.md +22 -0
  106. data/docs/DepositoryFilter.md +18 -0
  107. data/docs/Email.md +22 -0
  108. data/docs/Employee.md +22 -0
  109. data/docs/EmployeeIncomeSummaryFieldString.md +20 -0
  110. data/docs/Employer.md +24 -0
  111. data/docs/EmployerIncomeSummaryFieldString.md +20 -0
  112. data/docs/EmployersSearchRequest.md +24 -0
  113. data/docs/EmployersSearchResponse.md +20 -0
  114. data/docs/Error.md +34 -0
  115. data/docs/ExternalPaymentSchedule.md +24 -0
  116. data/docs/ExternalPaymentScheduleGet.md +26 -0
  117. data/docs/HealthIncident.md +24 -0
  118. data/docs/HistoricalBalance.md +24 -0
  119. data/docs/HistoricalUpdateWebhook.md +26 -0
  120. data/docs/Holding.md +34 -0
  121. data/docs/HoldingsDefaultUpdateWebhook.md +28 -0
  122. data/docs/IdentityGetRequest.md +24 -0
  123. data/docs/IdentityGetRequestOptions.md +18 -0
  124. data/docs/IdentityGetResponse.md +22 -0
  125. data/docs/IncidentUpdate.md +22 -0
  126. data/docs/IncomeBreakdown.md +24 -0
  127. data/docs/IncomeSummary.md +30 -0
  128. data/docs/IncomeSummaryFieldNumber.md +20 -0
  129. data/docs/IncomeSummaryFieldString.md +20 -0
  130. data/docs/IncomeVerificationCreateRequest.md +22 -0
  131. data/docs/IncomeVerificationCreateResponse.md +20 -0
  132. data/docs/IncomeVerificationDocumentsDownloadRequest.md +22 -0
  133. data/docs/IncomeVerificationDocumentsDownloadResponse.md +18 -0
  134. data/docs/IncomeVerificationPaystubGetRequest.md +22 -0
  135. data/docs/IncomeVerificationPaystubGetResponse.md +20 -0
  136. data/docs/IncomeVerificationStatusWebhook.md +24 -0
  137. data/docs/IncomeVerificationSummaryGetRequest.md +22 -0
  138. data/docs/IncomeVerificationSummaryGetResponse.md +20 -0
  139. data/docs/IncomeVerificationWebhookStatus.md +18 -0
  140. data/docs/InflowModel.md +26 -0
  141. data/docs/InitialUpdateWebhook.md +26 -0
  142. data/docs/Institution.md +36 -0
  143. data/docs/InstitutionStatus.md +30 -0
  144. data/docs/InstitutionsGetByIdRequest.md +26 -0
  145. data/docs/InstitutionsGetByIdRequestOptions.md +20 -0
  146. data/docs/InstitutionsGetByIdResponse.md +20 -0
  147. data/docs/InstitutionsGetRequest.md +28 -0
  148. data/docs/InstitutionsGetRequestOptions.md +24 -0
  149. data/docs/InstitutionsGetResponse.md +22 -0
  150. data/docs/InstitutionsSearchAccountFilter.md +24 -0
  151. data/docs/InstitutionsSearchRequest.md +28 -0
  152. data/docs/InstitutionsSearchRequestOptions.md +22 -0
  153. data/docs/InstitutionsSearchResponse.md +20 -0
  154. data/docs/InvestmentFilter.md +18 -0
  155. data/docs/InvestmentHoldingsGetRequestOptions.md +18 -0
  156. data/docs/InvestmentTransaction.md +44 -0
  157. data/docs/InvestmentsDefaultUpdateWebhook.md +28 -0
  158. data/docs/InvestmentsHoldingsGetRequest.md +24 -0
  159. data/docs/InvestmentsHoldingsGetResponse.md +26 -0
  160. data/docs/InvestmentsTransactionsGetRequest.md +28 -0
  161. data/docs/InvestmentsTransactionsGetRequestOptions.md +22 -0
  162. data/docs/InvestmentsTransactionsGetResponse.md +28 -0
  163. data/docs/Item.md +32 -0
  164. data/docs/ItemAccessTokenInvalidateRequest.md +22 -0
  165. data/docs/ItemAccessTokenInvalidateResponse.md +20 -0
  166. data/docs/ItemErrorWebhook.md +24 -0
  167. data/docs/ItemGetRequest.md +22 -0
  168. data/docs/ItemGetResponse.md +24 -0
  169. data/docs/ItemImportRequest.md +26 -0
  170. data/docs/ItemImportRequestOptions.md +18 -0
  171. data/docs/ItemImportRequestUserAuth.md +20 -0
  172. data/docs/ItemImportResponse.md +20 -0
  173. data/docs/ItemProductReadyWebhook.md +24 -0
  174. data/docs/ItemPublicTokenCreateRequest.md +22 -0
  175. data/docs/ItemPublicTokenCreateResponse.md +22 -0
  176. data/docs/ItemPublicTokenExchangeRequest.md +22 -0
  177. data/docs/ItemPublicTokenExchangeResponse.md +22 -0
  178. data/docs/ItemRemoveRequest.md +22 -0
  179. data/docs/ItemRemoveResponse.md +18 -0
  180. data/docs/ItemStatus.md +22 -0
  181. data/docs/ItemWebhookUpdateRequest.md +24 -0
  182. data/docs/ItemWebhookUpdateResponse.md +20 -0
  183. data/docs/JWKPublicKey.md +34 -0
  184. data/docs/JWTHeader.md +18 -0
  185. data/docs/LiabilitiesGetRequest.md +24 -0
  186. data/docs/LiabilitiesGetRequestOptions.md +18 -0
  187. data/docs/LiabilitiesGetResponse.md +24 -0
  188. data/docs/LiabilitiesObject.md +22 -0
  189. data/docs/LiabilityOverride.md +66 -0
  190. data/docs/LinkTokenAccountFilters.md +24 -0
  191. data/docs/LinkTokenCreateRequest.md +48 -0
  192. data/docs/LinkTokenCreateRequestAccountSubtypes.md +24 -0
  193. data/docs/LinkTokenCreateRequestDepositSwitch.md +18 -0
  194. data/docs/LinkTokenCreateRequestIncomeVerification.md +20 -0
  195. data/docs/LinkTokenCreateRequestPaymentInitiation.md +18 -0
  196. data/docs/LinkTokenCreateRequestUser.md +32 -0
  197. data/docs/LinkTokenCreateResponse.md +22 -0
  198. data/docs/LinkTokenGetMetadataResponse.md +30 -0
  199. data/docs/LinkTokenGetRequest.md +22 -0
  200. data/docs/LinkTokenGetResponse.md +26 -0
  201. data/docs/LoanFilter.md +18 -0
  202. data/docs/Location.md +32 -0
  203. data/docs/MFA.md +26 -0
  204. data/docs/Meta.md +22 -0
  205. data/docs/MortgageInterestRate.md +20 -0
  206. data/docs/MortgageLiability.md +56 -0
  207. data/docs/MortgagePropertyAddress.md +26 -0
  208. data/docs/NullableAccessToken.md +15 -0
  209. data/docs/NullableAddress.md +20 -0
  210. data/docs/NullableAddressData.md +26 -0
  211. data/docs/NullableItemStatus.md +22 -0
  212. data/docs/NullableNumbersACH.md +24 -0
  213. data/docs/NullableNumbersBACS.md +22 -0
  214. data/docs/NullableNumbersEFT.md +24 -0
  215. data/docs/NullableNumbersInternational.md +22 -0
  216. data/docs/NullableRecipientBACS.md +20 -0
  217. data/docs/Numbers.md +32 -0
  218. data/docs/NumbersACH.md +24 -0
  219. data/docs/NumbersBACS.md +22 -0
  220. data/docs/NumbersEFT.md +24 -0
  221. data/docs/NumbersInternational.md +22 -0
  222. data/docs/OverrideAccounts.md +38 -0
  223. data/docs/Owner.md +24 -0
  224. data/docs/OwnerOverride.md +24 -0
  225. data/docs/PSLFStatus.md +22 -0
  226. data/docs/PayFrequency.md +20 -0
  227. data/docs/PayPeriodDetails.md +26 -0
  228. data/docs/PaymentAmount.md +20 -0
  229. data/docs/PaymentInitiationAddress.md +24 -0
  230. data/docs/PaymentInitiationPaymentCreateRequest.md +28 -0
  231. data/docs/PaymentInitiationPaymentCreateResponse.md +22 -0
  232. data/docs/PaymentInitiationPaymentGetRequest.md +22 -0
  233. data/docs/PaymentInitiationPaymentGetResponse.md +34 -0
  234. data/docs/PaymentInitiationPaymentListRequest.md +24 -0
  235. data/docs/PaymentInitiationPaymentListResponse.md +22 -0
  236. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +22 -0
  237. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +22 -0
  238. data/docs/PaymentInitiationRecipient.md +26 -0
  239. data/docs/PaymentInitiationRecipientCreateRequest.md +28 -0
  240. data/docs/PaymentInitiationRecipientCreateResponse.md +20 -0
  241. data/docs/PaymentInitiationRecipientGetRequest.md +22 -0
  242. data/docs/PaymentInitiationRecipientGetResponse.md +28 -0
  243. data/docs/PaymentInitiationRecipientListRequest.md +20 -0
  244. data/docs/PaymentInitiationRecipientListResponse.md +20 -0
  245. data/docs/PaymentMeta.md +32 -0
  246. data/docs/PaymentStatusUpdateWebhook.md +38 -0
  247. data/docs/Paystub.md +30 -0
  248. data/docs/PaystubDeduction.md +22 -0
  249. data/docs/PaystubYTDDetails.md +20 -0
  250. data/docs/PendingExpirationWebhook.md +24 -0
  251. data/docs/PhoneNumber.md +22 -0
  252. data/docs/PlaidApi.md +5580 -0
  253. data/docs/ProcessorApexProcessorTokenCreateRequest.md +24 -0
  254. data/docs/ProcessorAuthGetRequest.md +22 -0
  255. data/docs/ProcessorAuthGetResponse.md +22 -0
  256. data/docs/ProcessorBalanceGetRequest.md +22 -0
  257. data/docs/ProcessorBalanceGetResponse.md +20 -0
  258. data/docs/ProcessorIdentityGetRequest.md +22 -0
  259. data/docs/ProcessorIdentityGetResponse.md +20 -0
  260. data/docs/ProcessorNumber.md +24 -0
  261. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +24 -0
  262. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +20 -0
  263. data/docs/ProcessorTokenCreateRequest.md +26 -0
  264. data/docs/ProcessorTokenCreateResponse.md +20 -0
  265. data/docs/ProductStatus.md +22 -0
  266. data/docs/ProductStatusBreakdown.md +24 -0
  267. data/docs/Products.md +15 -0
  268. data/docs/ProjectedIncomeSummaryFieldNumber.md +20 -0
  269. data/docs/RecaptchaRequiredError.md +30 -0
  270. data/docs/RecipientBACS.md +20 -0
  271. data/docs/SandboxBankTransferSimulateRequest.md +26 -0
  272. data/docs/SandboxBankTransferSimulateResponse.md +18 -0
  273. data/docs/SandboxItemFireWebhookRequest.md +24 -0
  274. data/docs/SandboxItemFireWebhookResponse.md +20 -0
  275. data/docs/SandboxItemResetLoginRequest.md +22 -0
  276. data/docs/SandboxItemResetLoginResponse.md +20 -0
  277. data/docs/SandboxItemSetVerificationStatusRequest.md +26 -0
  278. data/docs/SandboxItemSetVerificationStatusResponse.md +18 -0
  279. data/docs/SandboxProcessorTokenCreateRequest.md +24 -0
  280. data/docs/SandboxProcessorTokenCreateRequestOptions.md +20 -0
  281. data/docs/SandboxProcessorTokenCreateResponse.md +20 -0
  282. data/docs/SandboxPublicTokenCreateRequest.md +26 -0
  283. data/docs/SandboxPublicTokenCreateRequestOptions.md +24 -0
  284. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +20 -0
  285. data/docs/SandboxPublicTokenCreateResponse.md +20 -0
  286. data/docs/Security.md +46 -0
  287. data/docs/ServicerAddressData.md +26 -0
  288. data/docs/StandaloneAccountType.md +26 -0
  289. data/docs/StandaloneCurrencyCodeList.md +20 -0
  290. data/docs/StandaloneInvestmentTransactionSubtype.md +104 -0
  291. data/docs/StandaloneInvestmentTransactionType.md +28 -0
  292. data/docs/StudentLoan.md +66 -0
  293. data/docs/StudentLoanRepaymentModel.md +22 -0
  294. data/docs/StudentLoanStatus.md +20 -0
  295. data/docs/StudentRepaymentPlan.md +20 -0
  296. data/docs/Transaction.md +58 -0
  297. data/docs/TransactionCode.md +15 -0
  298. data/docs/TransactionData.md +26 -0
  299. data/docs/TransactionOverride.md +26 -0
  300. data/docs/TransactionsGetRequest.md +28 -0
  301. data/docs/TransactionsGetRequestOptions.md +22 -0
  302. data/docs/TransactionsGetResponse.md +26 -0
  303. data/docs/TransactionsRefreshRequest.md +22 -0
  304. data/docs/TransactionsRefreshResponse.md +18 -0
  305. data/docs/TransactionsRemovedWebhook.md +26 -0
  306. data/docs/UserCustomPassword.md +28 -0
  307. data/docs/UserPermissionRevokedWebhook.md +24 -0
  308. data/docs/VerificationExpiredWebhook.md +24 -0
  309. data/docs/VerificationStatus.md +15 -0
  310. data/docs/Warning.md +22 -0
  311. data/docs/WebhookUpdateAcknowledgedWebhook.md +26 -0
  312. data/docs/WebhookVerificationKeyGetRequest.md +22 -0
  313. data/docs/WebhookVerificationKeyGetResponse.md +20 -0
  314. data/docs/YTDGrossIncomeSummaryFieldNumber.md +20 -0
  315. data/docs/YTDNetIncomeSummaryFieldNumber.md +20 -0
  316. data/lib/plaid.rb +336 -61
  317. data/lib/plaid/api/plaid_api.rb +4414 -0
  318. data/lib/plaid/api_client.rb +383 -0
  319. data/lib/plaid/api_error.rb +57 -0
  320. data/lib/plaid/configuration.rb +297 -0
  321. data/lib/plaid/models/account_assets.rb +406 -0
  322. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  323. data/lib/plaid/models/account_balance.rb +269 -0
  324. data/lib/plaid/models/account_base.rb +345 -0
  325. data/lib/plaid/models/account_filters_response.rb +246 -0
  326. data/lib/plaid/models/account_identity.rb +369 -0
  327. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  328. data/lib/plaid/models/account_subtype.rb +101 -0
  329. data/lib/plaid/models/account_type.rb +41 -0
  330. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  331. data/lib/plaid/models/accounts_balance_get_request_options.rb +222 -0
  332. data/lib/plaid/models/accounts_get_request.rb +254 -0
  333. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  334. data/lib/plaid/models/accounts_get_response.rb +256 -0
  335. data/lib/plaid/models/ach_class.rb +50 -0
  336. data/lib/plaid/models/address.rb +235 -0
  337. data/lib/plaid/models/address_data.rb +277 -0
  338. data/lib/plaid/models/amount.rb +274 -0
  339. data/lib/plaid/models/apr.rb +296 -0
  340. data/lib/plaid/models/asset_report.rb +301 -0
  341. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  342. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  343. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  344. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  345. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  346. data/lib/plaid/models/asset_report_create_request.rb +299 -0
  347. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  348. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  349. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  350. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  351. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  352. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  353. data/lib/plaid/models/asset_report_item.rb +287 -0
  354. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  355. data/lib/plaid/models/asset_report_refresh_request.rb +288 -0
  356. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  357. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  358. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  359. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  360. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  361. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  362. data/lib/plaid/models/asset_report_user.rb +287 -0
  363. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  364. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  365. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  366. data/lib/plaid/models/auth_get_request.rb +254 -0
  367. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  368. data/lib/plaid/models/auth_get_response.rb +270 -0
  369. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  370. data/lib/plaid/models/bank_transfer.rb +444 -0
  371. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  372. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  373. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  374. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  375. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  376. data/lib/plaid/models/bank_transfer_create_request.rb +459 -0
  377. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  378. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  379. data/lib/plaid/models/bank_transfer_event.rb +388 -0
  380. data/lib/plaid/models/bank_transfer_event_list_request.rb +418 -0
  381. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  382. data/lib/plaid/models/bank_transfer_event_sync_request.rb +301 -0
  383. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  384. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  385. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  386. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  387. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  388. data/lib/plaid/models/bank_transfer_list_request.rb +336 -0
  389. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  390. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  391. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  392. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  393. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  394. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  395. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  396. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  397. data/lib/plaid/models/categories_get_response.rb +242 -0
  398. data/lib/plaid/models/category.rb +257 -0
  399. data/lib/plaid/models/cause.rb +235 -0
  400. data/lib/plaid/models/country_code.rb +42 -0
  401. data/lib/plaid/models/credit_card_liability.rb +339 -0
  402. data/lib/plaid/models/credit_filter.rb +227 -0
  403. data/lib/plaid/models/default_update_webhook.rb +280 -0
  404. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  405. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  406. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  407. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  408. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  409. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  410. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  411. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  412. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  413. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  414. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  415. data/lib/plaid/models/depository_filter.rb +227 -0
  416. data/lib/plaid/models/email.rb +289 -0
  417. data/lib/plaid/models/employee.rb +242 -0
  418. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  419. data/lib/plaid/models/employer.rb +261 -0
  420. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  421. data/lib/plaid/models/employers_search_request.rb +262 -0
  422. data/lib/plaid/models/employers_search_response.rb +242 -0
  423. data/lib/plaid/models/error.rb +360 -0
  424. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  425. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  426. data/lib/plaid/models/health_incident.rb +253 -0
  427. data/lib/plaid/models/historical_balance.rb +262 -0
  428. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  429. data/lib/plaid/models/holding.rb +329 -0
  430. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  431. data/lib/plaid/models/identity_get_request.rb +254 -0
  432. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  433. data/lib/plaid/models/identity_get_response.rb +256 -0
  434. data/lib/plaid/models/incident_update.rb +273 -0
  435. data/lib/plaid/models/income_breakdown.rb +253 -0
  436. data/lib/plaid/models/income_summary.rb +275 -0
  437. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  438. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  439. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  440. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  441. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  442. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  443. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  444. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  445. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  446. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  447. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  448. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  449. data/lib/plaid/models/inflow_model.rb +285 -0
  450. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  451. data/lib/plaid/models/institution.rb +344 -0
  452. data/lib/plaid/models/institution_status.rb +307 -0
  453. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  454. data/lib/plaid/models/institutions_get_by_id_request_options.rb +234 -0
  455. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  456. data/lib/plaid/models/institutions_get_request.rb +305 -0
  457. data/lib/plaid/models/institutions_get_request_options.rb +254 -0
  458. data/lib/plaid/models/institutions_get_response.rb +257 -0
  459. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  460. data/lib/plaid/models/institutions_search_request.rb +288 -0
  461. data/lib/plaid/models/institutions_search_request_options.rb +239 -0
  462. data/lib/plaid/models/institutions_search_response.rb +242 -0
  463. data/lib/plaid/models/investment_filter.rb +227 -0
  464. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  465. data/lib/plaid/models/investment_transaction.rb +445 -0
  466. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  467. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  468. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  469. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  470. data/lib/plaid/models/investments_transactions_get_request_options.rb +285 -0
  471. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  472. data/lib/plaid/models/item.rb +351 -0
  473. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  474. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  475. data/lib/plaid/models/item_error_webhook.rb +265 -0
  476. data/lib/plaid/models/item_get_request.rb +245 -0
  477. data/lib/plaid/models/item_get_response.rb +259 -0
  478. data/lib/plaid/models/item_import_request.rb +270 -0
  479. data/lib/plaid/models/item_import_request_options.rb +220 -0
  480. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  481. data/lib/plaid/models/item_import_response.rb +240 -0
  482. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  483. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  484. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  485. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  486. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  487. data/lib/plaid/models/item_remove_request.rb +245 -0
  488. data/lib/plaid/models/item_remove_response.rb +225 -0
  489. data/lib/plaid/models/item_status.rb +249 -0
  490. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  491. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  492. data/lib/plaid/models/jwk_public_key.rb +299 -0
  493. data/lib/plaid/models/jwt_header.rb +224 -0
  494. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  495. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  496. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  497. data/lib/plaid/models/liabilities_object.rb +249 -0
  498. data/lib/plaid/models/liability_override.rb +583 -0
  499. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  500. data/lib/plaid/models/link_token_create_request.rb +390 -0
  501. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  502. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  503. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  504. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  505. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  506. data/lib/plaid/models/link_token_create_response.rb +255 -0
  507. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  508. data/lib/plaid/models/link_token_get_request.rb +245 -0
  509. data/lib/plaid/models/link_token_get_response.rb +266 -0
  510. data/lib/plaid/models/loan_filter.rb +227 -0
  511. data/lib/plaid/models/location.rb +298 -0
  512. data/lib/plaid/models/meta.rb +255 -0
  513. data/lib/plaid/models/mfa.rb +285 -0
  514. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  515. data/lib/plaid/models/mortgage_liability.rb +430 -0
  516. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  517. data/lib/plaid/models/nullable_access_token.rb +209 -0
  518. data/lib/plaid/models/nullable_address.rb +241 -0
  519. data/lib/plaid/models/nullable_address_data.rb +283 -0
  520. data/lib/plaid/models/nullable_item_status.rb +255 -0
  521. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  522. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  523. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  524. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  525. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  526. data/lib/plaid/models/numbers.rb +330 -0
  527. data/lib/plaid/models/numbers_ach.rb +266 -0
  528. data/lib/plaid/models/numbers_bacs.rb +255 -0
  529. data/lib/plaid/models/numbers_eft.rb +270 -0
  530. data/lib/plaid/models/numbers_international.rb +255 -0
  531. data/lib/plaid/models/override_accounts.rb +366 -0
  532. data/lib/plaid/models/owner.rb +278 -0
  533. data/lib/plaid/models/owner_override.rb +278 -0
  534. data/lib/plaid/models/pay_frequency.rb +272 -0
  535. data/lib/plaid/models/pay_period_details.rb +265 -0
  536. data/lib/plaid/models/payment_amount.rb +240 -0
  537. data/lib/plaid/models/payment_initiation_address.rb +252 -0
  538. data/lib/plaid/models/payment_initiation_payment_create_request.rb +284 -0
  539. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  540. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  541. data/lib/plaid/models/payment_initiation_payment_get_response.rb +364 -0
  542. data/lib/plaid/models/payment_initiation_payment_list_request.rb +267 -0
  543. data/lib/plaid/models/payment_initiation_payment_list_response.rb +257 -0
  544. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  545. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  546. data/lib/plaid/models/payment_initiation_recipient.rb +273 -0
  547. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +275 -0
  548. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  549. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  550. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +286 -0
  551. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  552. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  553. data/lib/plaid/models/payment_meta.rb +298 -0
  554. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  555. data/lib/plaid/models/paystub.rb +306 -0
  556. data/lib/plaid/models/paystub_deduction.rb +242 -0
  557. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  558. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  559. data/lib/plaid/models/phone_number.rb +281 -0
  560. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  561. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  562. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  563. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  564. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  565. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  566. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  567. data/lib/plaid/models/processor_number.rb +250 -0
  568. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  569. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  570. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  571. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  572. data/lib/plaid/models/product_status.rb +288 -0
  573. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  574. data/lib/plaid/models/products.rb +46 -0
  575. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  576. data/lib/plaid/models/pslf_status.rb +243 -0
  577. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  578. data/lib/plaid/models/recipient_bacs.rb +230 -0
  579. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  580. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  581. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +289 -0
  582. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  583. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  584. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  585. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  586. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  587. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  588. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  589. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  590. data/lib/plaid/models/sandbox_public_token_create_request.rb +271 -0
  591. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  592. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  593. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  594. data/lib/plaid/models/security.rb +382 -0
  595. data/lib/plaid/models/servicer_address_data.rb +265 -0
  596. data/lib/plaid/models/standalone_account_type.rb +285 -0
  597. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  598. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  599. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  600. data/lib/plaid/models/student_loan.rb +483 -0
  601. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  602. data/lib/plaid/models/student_loan_status.rb +266 -0
  603. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  604. data/lib/plaid/models/transaction.rb +500 -0
  605. data/lib/plaid/models/transaction_code.rb +48 -0
  606. data/lib/plaid/models/transaction_data.rb +285 -0
  607. data/lib/plaid/models/transaction_override.rb +280 -0
  608. data/lib/plaid/models/transactions_get_request.rb +284 -0
  609. data/lib/plaid/models/transactions_get_request_options.rb +285 -0
  610. data/lib/plaid/models/transactions_get_response.rb +288 -0
  611. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  612. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  613. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  614. data/lib/plaid/models/user_custom_password.rb +297 -0
  615. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  616. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  617. data/lib/plaid/models/verification_status.rb +40 -0
  618. data/lib/plaid/models/warning.rb +254 -0
  619. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  620. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  621. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  622. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  623. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  624. data/lib/plaid/version.rb +13 -2
  625. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  626. data/plaid.gemspec +44 -49
  627. data/templates/ruby/api_client.mustache +266 -0
  628. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  629. data/templates/ruby/configuration.mustache +353 -0
  630. data/templates/ruby/gemspec.mustache +41 -0
  631. data/test/test_accounts.rb +103 -0
  632. data/test/test_asset_report.rb +147 -0
  633. data/test/test_auth.rb +61 -0
  634. data/test/test_bank_transfers.rb +219 -0
  635. data/test/test_categories.rb +10 -0
  636. data/test/test_configuration.rb +26 -0
  637. data/test/test_deposit_switch.rb +73 -0
  638. data/test/test_helper.rb +109 -0
  639. data/test/test_identity.rb +38 -0
  640. data/test/test_institutions.rb +159 -0
  641. data/test/test_investments.rb +208 -0
  642. data/test/test_item.rb +285 -0
  643. data/test/test_liabilities.rb +45 -0
  644. data/test/test_link_token.rb +97 -0
  645. data/test/test_payment_initiation.rb +95 -0
  646. data/test/test_processor.rb +67 -0
  647. data/test/test_transactions.rb +168 -0
  648. data/test/test_webhooks.rb +22 -0
  649. metadata +677 -101
  650. data/.circleci/config.yml +0 -21
  651. data/.env.sample +0 -3
  652. data/.github/workflows/add_to_project.yml +0 -21
  653. data/.rubocop.yml +0 -18
  654. data/bin/console +0 -14
  655. data/bin/setup +0 -8
  656. data/lib/plaid/client.rb +0 -190
  657. data/lib/plaid/errors.rb +0 -89
  658. data/lib/plaid/middleware.rb +0 -31
  659. data/lib/plaid/models.rb +0 -2120
  660. data/lib/plaid/products/accounts.rb +0 -63
  661. data/lib/plaid/products/asset_report.rb +0 -199
  662. data/lib/plaid/products/auth.rb +0 -42
  663. data/lib/plaid/products/base_product.rb +0 -64
  664. data/lib/plaid/products/categories.rb +0 -21
  665. data/lib/plaid/products/credit_details.rb +0 -40
  666. data/lib/plaid/products/deposit_switch.rb +0 -99
  667. data/lib/plaid/products/identity.rb +0 -31
  668. data/lib/plaid/products/income.rb +0 -31
  669. data/lib/plaid/products/institutions.rb +0 -91
  670. data/lib/plaid/products/investments.rb +0 -127
  671. data/lib/plaid/products/item.rb +0 -178
  672. data/lib/plaid/products/liabilities.rb +0 -39
  673. data/lib/plaid/products/link_token.rb +0 -74
  674. data/lib/plaid/products/payment_initiation.rb +0 -194
  675. data/lib/plaid/products/processor.rb +0 -190
  676. data/lib/plaid/products/sandbox.rb +0 -148
  677. data/lib/plaid/products/transactions.rb +0 -81
  678. data/lib/plaid/products/webhooks.rb +0 -23
@@ -1,39 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Liabilities product.
3
- class Liabilities < BaseProduct
4
- # Public: Get liabilities information.
5
- #
6
- # Does a POST /liabilities/get call which fetches liabilities associated
7
- # with an access_token's item.
8
- #
9
- # access_token - access_token of an item to fetch liabilities for.
10
- # account_ids - Specific account ids to fetch liabilities for
11
- # (optional).
12
- #
13
- # Returns the LiabilitiesResponse object with liabilities data.
14
- def get(access_token, account_ids: nil)
15
- post_with_auth 'liabilities/get',
16
- LiabilitiesResponse,
17
- build_payload(access_token,
18
- account_ids: account_ids)
19
- end
20
- end
21
-
22
- # Public: Response wrapper for /liabilities/get.
23
- class LiabilitiesResponse < Models::BaseResponse
24
- ##
25
- # :attr_reader:
26
- # Public: The list of accounts: Array of Plaid::Models::Account.
27
- property :accounts, coerce: Array[Models::Account]
28
-
29
- ##
30
- # :attr_reader:
31
- # Public: The liabilities: Plaid::Models::Liabilities.
32
- property :liabilities, coerce: Models::Liabilities
33
-
34
- ##
35
- # :attr_reader:
36
- # Public: The item: Plaid::Models::Item.
37
- property :item, coerce: Models::Item
38
- end
39
- end
@@ -1,74 +0,0 @@
1
- LINK_TOKEN_FIELD_NAMES = %i[
2
- user
3
- client_name
4
- products
5
- country_codes
6
- language
7
- webhook
8
- access_token
9
- link_customization_name
10
- redirect_uri
11
- android_package_name
12
- account_filters
13
- cross_app_item_add
14
- payment_initiation
15
- ].freeze
16
-
17
- module Plaid
18
- # Public: Class used to call the LinkToken sub-product.
19
- class LinkToken < BaseProduct
20
- def create(configs)
21
- body = {}
22
-
23
- LINK_TOKEN_FIELD_NAMES.each do |field|
24
- body[field] = configs[field]
25
- end
26
-
27
- post_with_auth 'link/token/create',
28
- CreateResponse,
29
- body
30
- end
31
-
32
- def get(link_token)
33
- post_with_auth 'link/token/get',
34
- GetResponse,
35
- link_token: link_token
36
- end
37
- end
38
-
39
- # Public: Response for /link/token/create.
40
- class CreateResponse < Models::BaseResponse
41
- ##
42
- # :attr_reader:
43
- # Public: The String token.
44
- property :link_token
45
-
46
- ##
47
- # :attr_reader:
48
- # Public: The String token expiration time.
49
- property :expiration
50
- end
51
-
52
- # Public: Response for /link/token/get.
53
- class GetResponse < Models::BaseResponse
54
- ##
55
- # :attr_reader:
56
- # Public: The String token.
57
- property :link_token
58
-
59
- ##
60
- # :attr_reader:
61
- # Public: The link token expiration time.
62
- property :expiration
63
-
64
- ##
65
- # :attr_reader:
66
- # Public: The link token created time.
67
- property :created_at
68
-
69
- ##
70
- # :attr_reader:
71
- # Public: The metadata associated with the link token.
72
- property :metadata, coerce: Models::LinkTokenMetadata
73
- end
74
- end
@@ -1,194 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Payment product.
3
- class PaymentInitiation < BaseProduct
4
- # Public: Create a recipient.
5
- #
6
- # name - Recipient name.
7
- # iban - Recipient IBAN.
8
- # address - Recipient address.
9
- # bacs - Recipient BACS (hash with "account" and "sort_code" keys)
10
- #
11
- # Returns a PaymentRecipientCreateResponse object.
12
- def create_recipient(name, iban, address, bacs)
13
- post_with_auth 'payment_initiation/recipient/create',
14
- PaymentRecipientCreateResponse,
15
- name: name,
16
- iban: iban,
17
- bacs: bacs,
18
- address: address
19
- end
20
-
21
- # Public: Retrieve a recipient.
22
- #
23
- # recipient_id - The recipient ID from the `create_recipient` response.
24
- #
25
- # Returns a PaymentRecipientGetResponse object.
26
- def get_recipient(recipient_id)
27
- post_with_auth 'payment_initiation/recipient/get',
28
- PaymentRecipientGetResponse,
29
- recipient_id: recipient_id
30
- end
31
-
32
- # Public: List all recipients.
33
- #
34
- # Returns a PaymentRecipientListResponse object.
35
- def list_recipients
36
- post_with_auth 'payment_initiation/recipient/list',
37
- PaymentRecipientListResponse,
38
- {}
39
- end
40
-
41
- # Public: Create a payment.
42
- #
43
- # recipient_id - Recipient ID that the payment will be initiated for.
44
- # reference - Payment reference.
45
- # amount - Payment amount.
46
- #
47
- # Returns a PaymentCreateResponse object.
48
- def create_payment(recipient_id, reference, amount)
49
- post_with_auth 'payment_initiation/payment/create',
50
- PaymentCreateResponse,
51
- recipient_id: recipient_id,
52
- reference: reference,
53
- amount: amount
54
- end
55
-
56
- # Public: Retrieve a payment.
57
- #
58
- # payment_id - The payment ID from the `create_payment` response.
59
- #
60
- # Returns a PaymentGetResponse object.
61
- def get_payment(payment_id)
62
- post_with_auth 'payment_initiation/payment/get',
63
- PaymentGetResponse,
64
- payment_id: payment_id
65
- end
66
-
67
- # Public: List all payments.
68
- #
69
- # options - Object to specify optional parameters 'count' and 'cursor'.
70
- # e.g {count: 10, cursor: '2019-12-06T22:35:49Z'} returns 10
71
- # payments initiated before 2019-12-06T22:35:49Z.
72
- #
73
- # Returns a PaymentListResponse object.
74
- def list_payments(options)
75
- post_with_auth 'payment_initiation/payment/list',
76
- PaymentListResponse,
77
- options
78
- end
79
- end
80
-
81
- # Public: The response wrapper for /payment_initiation/recipient/create.
82
- class PaymentRecipientCreateResponse < Models::BaseResponse
83
- ##
84
- # :attr_reader:
85
- # Public: The recipient ID.
86
- property :recipient_id
87
- end
88
-
89
- # Public: The response wrapper for /payment_initiation/recipient/get.
90
- class PaymentRecipientGetResponse < Models::BaseResponse
91
- ##
92
- # :attr_reader:
93
- # Public: The recipient ID.
94
- property :recipient_id
95
-
96
- ##
97
- # :attr_reader:
98
- # Public: The recipient name.
99
- property :name
100
-
101
- ##
102
- # :attr_reader:
103
- # Public: The recipient IBAN.
104
- property :iban
105
-
106
- ##
107
- # :attr_reader:
108
- # Public: The recipient IBAN.
109
- property :bacs, coerce: Models::PaymentRecipientBACS
110
-
111
- ##
112
- # :attr_reader:
113
- # Public: The recipient address.
114
- property :address, coerce: Models::PaymentRecipientAddress
115
- end
116
-
117
- # Public: The response wrapper for /payment_initiation/recipient/list.
118
- class PaymentRecipientListResponse < Models::BaseResponse
119
- ##
120
- # :attr_reader:
121
- # Public: The list of recipients.
122
- property :recipients, coerce: Array[Models::PaymentRecipient]
123
- end
124
-
125
- # Public: The response wrapper for /payment_initiation/payment/create.
126
- class PaymentCreateResponse < Models::BaseResponse
127
- ##
128
- # :attr_reader:
129
- # Public: The payment ID.
130
- property :payment_id
131
-
132
- ##
133
- # :attr_reader:
134
- # Public: The payment status.
135
- property :status
136
- end
137
-
138
- # Public: The response wrapper for /payment_initiation/payment/get.
139
- class PaymentGetResponse < Models::BaseResponse
140
- ##
141
- # :attr_reader:
142
- # Public: The payment ID.
143
- property :payment_id
144
-
145
- ##
146
- # :attr_reader:
147
- # Public: The payment token.
148
- property :payment_token
149
-
150
- ##
151
- # :attr_reader:
152
- # Public: The payment reference.
153
- property :reference
154
-
155
- ##
156
- # :attr_reader:
157
- # Public: The payment amount.
158
- property :amount, coerce: Models::PaymentAmount
159
-
160
- ##
161
- # :attr_reader:
162
- # Public: The payment's status.
163
- property :status
164
-
165
- ##
166
- # :attr_reader:
167
- # Public: The last status update time for payment.
168
- property :last_status_update
169
-
170
- ##
171
- # :attr_reader:
172
- # Public: The payment token's expiration time.
173
- property :payment_token_expiration_time
174
-
175
- ##
176
- # :attr_reader:
177
- # Public: The recipient ID for payment.
178
- property :recipient_id
179
- end
180
-
181
- # Public: The response wrapper for /payment_initiation/payment/list.
182
- class PaymentListResponse < Models::BaseResponse
183
- ##
184
- # :attr_reader:
185
- # Public: The list of payments.
186
- property :payments, coerce: Array[Models::Payment]
187
-
188
- ##
189
- # :attr_reader:
190
- # Public: The cursor (its a timestamp) to use in the next
191
- # /payment_initiation/payment/list call for retrieving more older payments.
192
- property :next_cursor
193
- end
194
- end
@@ -1,190 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Stripe sub-product.
3
- class Stripe < BaseProduct
4
- # Public: Class used to call the BankAccountToken sub-product.
5
- class BankAccountToken < BaseProduct
6
- # Public: Creates a Stripe bank account token from an access_token.
7
- #
8
- # Does a POST /processor/stripe/bank_account_token/create call which can
9
- # be used to generate a Stripe bank account token for a given account
10
- # ID.
11
- #
12
- # access_token - access_token to create a public token for
13
- # account_id - ID of the account to create a bank account token for
14
- #
15
- # Returns CreateResponse object containing a Stripe bank account token.
16
- def create(access_token, account_id)
17
- post_with_auth 'processor/stripe/bank_account_token/create',
18
- CreateResponse,
19
- access_token: access_token, account_id: account_id
20
- end
21
-
22
- # Public: A response for /processor/stripe/bank_account_token/create.
23
- class CreateResponse < Models::BaseResponse
24
- ##
25
- # :attr_reader:
26
- # Public: The String stripe token.
27
- property :stripe_bank_account_token
28
- end
29
- end
30
-
31
- ##
32
- # :attr_reader:
33
- # Public: The Plaid::Stripe::BankAccountToken product accessor.
34
- subproduct :bank_account_token, BankAccountToken
35
- end
36
-
37
- # Public: A response for /processor/.../processor_token/create.
38
- class ProcessorTokenResponse < Models::BaseResponse
39
- ##
40
- # :attr_reader:
41
- # Public: The String processor token.
42
- property :processor_token
43
- end
44
-
45
- # Public: Class used to call the Dwolla sub-product.
46
- class Dwolla < BaseProduct
47
- # Public: Class used to call the dwolla.processor_token subproduct
48
- class ProcessorToken < BaseProduct
49
- # Public: Creates a Dwolla processor token from an access_token.
50
- #
51
- # Does a POST /processor/dwolla/processor_token/create call which can be
52
- # used to generate a Dwolla processor token for a given account ID.
53
- #
54
- # access_token - access_token to create a public token for.
55
- # account_id - ID of the account to create a processor token for.
56
- #
57
- # Returns a ProcessorTokenResponse object containing a Dwolla processor
58
- # token.
59
- def create(access_token, account_id)
60
- post_with_auth 'processor/dwolla/processor_token/create',
61
- ProcessorTokenResponse,
62
- access_token: access_token,
63
- account_id: account_id
64
- end
65
- end
66
-
67
- ##
68
- # :attr_reader:
69
- # Public: The Plaid::Dwolla::ProcessorToken product accessor.
70
- subproduct :processor_token, ProcessorToken
71
- end
72
-
73
- # Public: Class used to call the Apex sub-product.
74
- class Apex < BaseProduct
75
- # Public: Class used to call the apex.processor_token subproduct
76
- class ProcessorToken < BaseProduct
77
- # Public: Creates an Apex processor token from an access_token.
78
- #
79
- # Does a POST /processor/apex/processor_token/create call which can be
80
- # used to generate an Apex processor token for a given account ID.
81
- #
82
- # access_token - access_token to create a public token for.
83
- # account_id - ID of the account to create a processor token for.
84
- #
85
- # Returns a ProcessorTokenResponse object containing an Apex processor
86
- # token.
87
- def create(access_token, account_id)
88
- post_with_auth 'processor/apex/processor_token/create',
89
- ProcessorTokenResponse,
90
- access_token: access_token,
91
- account_id: account_id
92
- end
93
- end
94
-
95
- ##
96
- # :attr_reader:
97
- # Public: The Plaid::ApexProcessorToken product accessor.
98
- subproduct :processor_token, ProcessorToken
99
- end
100
-
101
- # Public: Class used to call the Ocrolus sub-product.
102
- class Ocrolus < BaseProduct
103
- # Public: Class used to call the ocrolus.processor_token subproduct
104
- class ProcessorToken < BaseProduct
105
- # Public: Creates a Ocrolus processor token from an access_token.
106
- #
107
- # Does a POST /processor/ocrolus/processor_token/create call which can be
108
- # used to generate a Ocrolus processor token for a given account ID.
109
- #
110
- # access_token - access_token to create a public token for.
111
- # account_id - ID of the account to create a processor token for.
112
- #
113
- # Returns a ProcessorTokenResponse object containing a Ocrolus processor
114
- # token.
115
- def create(access_token, account_id)
116
- post_with_auth 'processor/ocrolus/processor_token/create',
117
- ProcessorTokenResponse,
118
- access_token: access_token,
119
- account_id: account_id
120
- end
121
- end
122
-
123
- ##
124
- # :attr_reader:
125
- # Public: The Plaid::Ocrolus::ProcessorToken product accessor.
126
- subproduct :processor_token, ProcessorToken
127
- end
128
-
129
- # Public: Class used to call the generic ProcessorToken sub-product.
130
- class ProcessorToken < BaseProduct
131
- # Public: Creates a processor token from an access_token.
132
- #
133
- # Does a POST /processor/token/create call which can be used to
134
- # generate any non-stripe processor token for a given account ID.
135
- # If the processor is Stripe, the stripe endpoint will be called
136
- # instead.
137
- #
138
- # access_token - access_token to create a public token for.
139
- # account_id - ID of the account to create a processor token for.
140
- # processor - name of the processor to create a token for.
141
- #
142
- # Returns a ProcessorTokenResponse object containing a processor token.
143
- def create(access_token, account_id, processor)
144
- endpoint = 'processor/token/create'
145
- options = {
146
- access_token: access_token,
147
- account_id: account_id,
148
- processor: processor
149
- }
150
-
151
- if processor == 'stripe'
152
- endpoint = '/processor/stripe/bank_account_token/create'
153
- options.delete(:processor)
154
- elsif processor == 'apex'
155
- endpoint = '/processor/apex/processor_token/create'
156
- options.delete(:processor)
157
- end
158
-
159
- post_with_auth endpoint, ProcessorTokenResponse, **options
160
- end
161
- end
162
-
163
- # Public: Class used to call the Processor product.
164
- class Processor < BaseProduct
165
- ##
166
- # :attr_reader:
167
- # Public: The Plaid::Stripe product accessor.
168
- subproduct :stripe
169
-
170
- ##
171
- # :attr_reader:
172
- # Public: The Plaid::Dwolla product accessor.
173
- subproduct :dwolla
174
-
175
- ##
176
- # :attr_reader:
177
- # Public: The Plaid::Apex product accessor.
178
- subproduct :apex
179
-
180
- ##
181
- # :attr_reader:
182
- # Public: The Plaid::Ocrolus product accessor.
183
- subproduct :ocrolus
184
-
185
- ##
186
- # :attr_reader:
187
- # Public: The Plaid::ProcessorToken product accessor.
188
- subproduct :processor_token
189
- end
190
- end