plaid 13.2.0 → 14.0.0.beta.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (611) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +82 -8
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +43 -34
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +2 -0
  8. data/PUBLISH.md +6 -7
  9. data/README.md +99 -93
  10. data/Rakefile +8 -79
  11. data/UPGRADING.md +4 -0
  12. data/doc/rdoc/apple-touch-icon.png +0 -0
  13. data/doc/rdoc/classes/Object.html +118 -0
  14. data/doc/rdoc/classes/Plaid.html +772 -0
  15. data/doc/rdoc/classes/Plaid/APIError.html +97 -0
  16. data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
  17. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
  18. data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
  19. data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
  20. data/doc/rdoc/classes/Plaid/Apex.html +149 -0
  21. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
  22. data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
  23. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
  24. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
  25. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
  26. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
  27. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
  28. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
  29. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
  30. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
  31. data/doc/rdoc/classes/Plaid/Auth.html +206 -0
  32. data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
  33. data/doc/rdoc/classes/Plaid/Balance.html +206 -0
  34. data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
  35. data/doc/rdoc/classes/Plaid/Categories.html +191 -0
  36. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
  37. data/doc/rdoc/classes/Plaid/Client.html +802 -0
  38. data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
  39. data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
  40. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
  41. data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
  42. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
  43. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
  44. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
  45. data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
  46. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
  47. data/doc/rdoc/classes/Plaid/Error.html +214 -0
  48. data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
  49. data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
  50. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
  51. data/doc/rdoc/classes/Plaid/Identity.html +199 -0
  52. data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
  53. data/doc/rdoc/classes/Plaid/Income.html +198 -0
  54. data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
  55. data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
  56. data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
  57. data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
  58. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
  59. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
  60. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
  61. data/doc/rdoc/classes/Plaid/Investments.html +204 -0
  62. data/doc/rdoc/classes/Plaid/Item.html +382 -0
  63. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
  64. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
  65. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
  66. data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
  67. data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
  68. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
  69. data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
  70. data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
  71. data/doc/rdoc/classes/Plaid/Models.html +506 -0
  72. data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
  73. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
  74. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
  77. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
  78. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
  79. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
  80. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
  81. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
  82. data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
  83. data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
  84. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
  85. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
  86. data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
  87. data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
  88. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
  89. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
  90. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
  91. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
  92. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
  93. data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
  94. data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
  95. data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
  96. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
  97. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
  98. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
  99. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
  100. data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
  101. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
  102. data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
  103. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
  104. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
  105. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
  106. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
  107. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
  108. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
  109. data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
  110. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
  111. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
  112. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
  113. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
  114. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
  115. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
  116. data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
  117. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
  118. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
  119. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
  120. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
  121. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
  122. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
  123. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
  124. data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
  125. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
  126. data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
  127. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
  128. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
  129. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
  130. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
  131. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
  132. data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
  133. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
  134. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
  135. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
  136. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
  137. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
  138. data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
  139. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
  140. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
  141. data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
  142. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
  143. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
  144. data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
  145. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
  146. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
  147. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
  148. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
  149. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
  150. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
  151. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
  152. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
  153. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
  154. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
  155. data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
  156. data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
  157. data/doc/rdoc/classes/Plaid/Processor.html +143 -0
  158. data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
  159. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
  160. data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
  161. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
  162. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
  163. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
  164. data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
  165. data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
  166. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
  167. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
  168. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
  169. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
  170. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
  171. data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
  172. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
  173. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
  174. data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
  175. data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
  176. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
  177. data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
  178. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
  179. data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
  180. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
  181. data/doc/rdoc/created.rid +28 -0
  182. data/doc/rdoc/css/github.css +123 -0
  183. data/doc/rdoc/css/main.css +333 -0
  184. data/doc/rdoc/css/panel.css +383 -0
  185. data/doc/rdoc/css/reset.css +48 -0
  186. data/doc/rdoc/favicon.ico +0 -0
  187. data/doc/rdoc/files/LICENSE_txt.html +98 -0
  188. data/doc/rdoc/files/README_md.html +388 -0
  189. data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
  190. data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
  191. data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
  192. data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
  193. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
  194. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
  195. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
  196. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
  197. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
  198. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
  199. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
  200. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
  201. data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
  202. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
  203. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
  204. data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
  205. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
  206. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
  207. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
  208. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
  209. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
  210. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
  211. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
  212. data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
  213. data/doc/rdoc/files/lib/plaid_rb.html +120 -0
  214. data/doc/rdoc/i/arrows.png +0 -0
  215. data/doc/rdoc/i/results_bg.png +0 -0
  216. data/doc/rdoc/i/tree_bg.png +0 -0
  217. data/doc/rdoc/index.html +13 -0
  218. data/doc/rdoc/js/highlight.pack.js +1 -0
  219. data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
  220. data/doc/rdoc/js/main.js +29 -0
  221. data/doc/rdoc/js/navigation.js +142 -0
  222. data/doc/rdoc/js/navigation.js.gz +0 -0
  223. data/doc/rdoc/js/search_index.js +1 -0
  224. data/doc/rdoc/js/search_index.js.gz +0 -0
  225. data/doc/rdoc/js/searchdoc.js +468 -0
  226. data/doc/rdoc/js/searcher.js +229 -0
  227. data/doc/rdoc/js/searcher.js.gz +0 -0
  228. data/doc/rdoc/panel/index.html +74 -0
  229. data/doc/rdoc/panel/links.html +60 -0
  230. data/doc/rdoc/panel/tree.js +1 -0
  231. data/lib/plaid.rb +352 -61
  232. data/lib/plaid/api/plaid_api.rb +4572 -0
  233. data/lib/plaid/api_client.rb +383 -0
  234. data/lib/plaid/api_error.rb +57 -0
  235. data/lib/plaid/configuration.rb +297 -0
  236. data/lib/plaid/models/account_assets.rb +406 -0
  237. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  238. data/lib/plaid/models/account_balance.rb +280 -0
  239. data/lib/plaid/models/account_base.rb +345 -0
  240. data/lib/plaid/models/account_filters_response.rb +246 -0
  241. data/lib/plaid/models/account_identity.rb +369 -0
  242. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  243. data/lib/plaid/models/account_subtype.rb +102 -0
  244. data/lib/plaid/models/account_type.rb +41 -0
  245. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  246. data/lib/plaid/models/accounts_balance_get_request_options.rb +232 -0
  247. data/lib/plaid/models/accounts_get_request.rb +254 -0
  248. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  249. data/lib/plaid/models/accounts_get_response.rb +256 -0
  250. data/lib/plaid/models/ach_class.rb +50 -0
  251. data/lib/plaid/models/address.rb +235 -0
  252. data/lib/plaid/models/address_data.rb +277 -0
  253. data/lib/plaid/models/application.rb +273 -0
  254. data/lib/plaid/models/application_get_request.rb +255 -0
  255. data/lib/plaid/models/application_get_response.rb +239 -0
  256. data/lib/plaid/models/apr.rb +296 -0
  257. data/lib/plaid/models/asset_report.rb +301 -0
  258. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  259. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  260. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  261. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  262. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  263. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  264. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  265. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  266. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  267. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  268. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  269. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  270. data/lib/plaid/models/asset_report_item.rb +287 -0
  271. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  272. data/lib/plaid/models/asset_report_refresh_request.rb +290 -0
  273. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  274. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  275. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  276. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  277. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  278. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  279. data/lib/plaid/models/asset_report_user.rb +287 -0
  280. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  281. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  282. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  283. data/lib/plaid/models/auth_get_request.rb +254 -0
  284. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  285. data/lib/plaid/models/auth_get_response.rb +270 -0
  286. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  287. data/lib/plaid/models/bank_transfer.rb +453 -0
  288. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  289. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  290. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  291. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  292. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  293. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  294. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  295. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  296. data/lib/plaid/models/bank_transfer_event.rb +390 -0
  297. data/lib/plaid/models/bank_transfer_event_list_request.rb +422 -0
  298. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  299. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  300. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  301. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  302. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  303. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  304. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  305. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  306. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  307. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  308. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  309. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  310. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  311. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  312. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  313. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  314. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  315. data/lib/plaid/models/categories_get_response.rb +242 -0
  316. data/lib/plaid/models/category.rb +257 -0
  317. data/lib/plaid/models/cause.rb +235 -0
  318. data/lib/plaid/models/country_code.rb +42 -0
  319. data/lib/plaid/models/credit_card_liability.rb +324 -0
  320. data/lib/plaid/models/credit_filter.rb +227 -0
  321. data/lib/plaid/models/default_update_webhook.rb +280 -0
  322. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  323. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  324. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  325. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  326. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  327. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  328. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  329. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  330. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  331. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  332. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  333. data/lib/plaid/models/depository_filter.rb +227 -0
  334. data/lib/plaid/models/email.rb +289 -0
  335. data/lib/plaid/models/employee.rb +242 -0
  336. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  337. data/lib/plaid/models/employer.rb +261 -0
  338. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  339. data/lib/plaid/models/employers_search_request.rb +262 -0
  340. data/lib/plaid/models/employers_search_response.rb +242 -0
  341. data/lib/plaid/models/error.rb +360 -0
  342. data/lib/plaid/models/external_payment_options.rb +242 -0
  343. data/lib/plaid/models/external_payment_refund_details.rb +240 -0
  344. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  345. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  346. data/lib/plaid/models/health_incident.rb +253 -0
  347. data/lib/plaid/models/historical_balance.rb +262 -0
  348. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  349. data/lib/plaid/models/holding.rb +329 -0
  350. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  351. data/lib/plaid/models/identity_get_request.rb +254 -0
  352. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  353. data/lib/plaid/models/identity_get_response.rb +256 -0
  354. data/lib/plaid/models/incident_update.rb +273 -0
  355. data/lib/plaid/models/income_breakdown.rb +253 -0
  356. data/lib/plaid/models/income_summary.rb +275 -0
  357. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  358. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  359. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  360. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  361. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  362. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  363. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  364. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  365. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  366. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  367. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  368. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  369. data/lib/plaid/models/inflow_model.rb +285 -0
  370. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  371. data/lib/plaid/models/institution.rb +354 -0
  372. data/lib/plaid/models/institution_status.rb +307 -0
  373. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  374. data/lib/plaid/models/institutions_get_by_id_request_options.rb +246 -0
  375. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  376. data/lib/plaid/models/institutions_get_request.rb +328 -0
  377. data/lib/plaid/models/institutions_get_request_options.rb +266 -0
  378. data/lib/plaid/models/institutions_get_response.rb +257 -0
  379. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  380. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +220 -0
  381. data/lib/plaid/models/institutions_search_request.rb +309 -0
  382. data/lib/plaid/models/institutions_search_request_options.rb +252 -0
  383. data/lib/plaid/models/institutions_search_response.rb +242 -0
  384. data/lib/plaid/models/investment_filter.rb +227 -0
  385. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  386. data/lib/plaid/models/investment_transaction.rb +446 -0
  387. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  388. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  389. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  390. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  391. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  392. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  393. data/lib/plaid/models/item.rb +351 -0
  394. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  395. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  396. data/lib/plaid/models/item_error_webhook.rb +265 -0
  397. data/lib/plaid/models/item_get_request.rb +245 -0
  398. data/lib/plaid/models/item_get_response.rb +249 -0
  399. data/lib/plaid/models/item_import_request.rb +291 -0
  400. data/lib/plaid/models/item_import_request_options.rb +220 -0
  401. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  402. data/lib/plaid/models/item_import_response.rb +240 -0
  403. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  404. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  405. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  406. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  407. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  408. data/lib/plaid/models/item_remove_request.rb +245 -0
  409. data/lib/plaid/models/item_remove_response.rb +225 -0
  410. data/lib/plaid/models/item_status.rb +249 -0
  411. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  412. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  413. data/lib/plaid/models/jwk_public_key.rb +339 -0
  414. data/lib/plaid/models/jwt_header.rb +224 -0
  415. data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
  416. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  417. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  418. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  419. data/lib/plaid/models/liabilities_object.rb +249 -0
  420. data/lib/plaid/models/liability_override.rb +566 -0
  421. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  422. data/lib/plaid/models/link_token_create_request.rb +429 -0
  423. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  424. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  425. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  426. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  427. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  428. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  429. data/lib/plaid/models/link_token_create_response.rb +255 -0
  430. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  431. data/lib/plaid/models/link_token_get_request.rb +245 -0
  432. data/lib/plaid/models/link_token_get_response.rb +266 -0
  433. data/lib/plaid/models/loan_filter.rb +227 -0
  434. data/lib/plaid/models/location.rb +298 -0
  435. data/lib/plaid/models/meta.rb +255 -0
  436. data/lib/plaid/models/mfa.rb +285 -0
  437. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  438. data/lib/plaid/models/mortgage_liability.rb +430 -0
  439. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  440. data/lib/plaid/models/nullable_access_token.rb +209 -0
  441. data/lib/plaid/models/nullable_address.rb +241 -0
  442. data/lib/plaid/models/nullable_address_data.rb +283 -0
  443. data/lib/plaid/models/nullable_item_status.rb +255 -0
  444. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  445. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  446. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  447. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  448. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  449. data/lib/plaid/models/numbers.rb +330 -0
  450. data/lib/plaid/models/numbers_ach.rb +266 -0
  451. data/lib/plaid/models/numbers_bacs.rb +255 -0
  452. data/lib/plaid/models/numbers_eft.rb +270 -0
  453. data/lib/plaid/models/numbers_international.rb +255 -0
  454. data/lib/plaid/models/override_accounts.rb +366 -0
  455. data/lib/plaid/models/owner.rb +278 -0
  456. data/lib/plaid/models/owner_override.rb +278 -0
  457. data/lib/plaid/models/pay_frequency.rb +272 -0
  458. data/lib/plaid/models/pay_period_details.rb +265 -0
  459. data/lib/plaid/models/payment_amount.rb +274 -0
  460. data/lib/plaid/models/payment_initiation_address.rb +269 -0
  461. data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
  462. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +236 -0
  463. data/lib/plaid/models/payment_initiation_payment.rb +395 -0
  464. data/lib/plaid/models/payment_initiation_payment_create_request.rb +294 -0
  465. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  466. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  467. data/lib/plaid/models/payment_initiation_payment_get_response.rb +418 -0
  468. data/lib/plaid/models/payment_initiation_payment_list_request.rb +271 -0
  469. data/lib/plaid/models/payment_initiation_payment_list_response.rb +253 -0
  470. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  471. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  472. data/lib/plaid/models/payment_initiation_recipient.rb +282 -0
  473. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +276 -0
  474. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  475. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  476. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +305 -0
  477. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  478. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  479. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  480. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
  481. data/lib/plaid/models/payment_meta.rb +298 -0
  482. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  483. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  484. data/lib/plaid/models/paystub.rb +306 -0
  485. data/lib/plaid/models/paystub_deduction.rb +242 -0
  486. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  487. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  488. data/lib/plaid/models/phone_number.rb +281 -0
  489. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  490. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  491. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  492. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  493. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  494. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  495. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  496. data/lib/plaid/models/processor_number.rb +250 -0
  497. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  498. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  499. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  500. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  501. data/lib/plaid/models/product_status.rb +288 -0
  502. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  503. data/lib/plaid/models/products.rb +47 -0
  504. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  505. data/lib/plaid/models/pslf_status.rb +243 -0
  506. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  507. data/lib/plaid/models/recipient_bacs.rb +230 -0
  508. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  509. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  510. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  511. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  512. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +294 -0
  513. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  514. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  515. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  516. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  517. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  518. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  519. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  520. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  521. data/lib/plaid/models/sandbox_public_token_create_request.rb +292 -0
  522. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  523. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  524. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  525. data/lib/plaid/models/security.rb +379 -0
  526. data/lib/plaid/models/servicer_address_data.rb +265 -0
  527. data/lib/plaid/models/standalone_account_type.rb +285 -0
  528. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  529. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  530. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  531. data/lib/plaid/models/student_loan.rb +472 -0
  532. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  533. data/lib/plaid/models/student_loan_status.rb +266 -0
  534. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  535. data/lib/plaid/models/transaction.rb +500 -0
  536. data/lib/plaid/models/transaction_code.rb +48 -0
  537. data/lib/plaid/models/transaction_data.rb +285 -0
  538. data/lib/plaid/models/transaction_override.rb +280 -0
  539. data/lib/plaid/models/transactions_get_request.rb +284 -0
  540. data/lib/plaid/models/transactions_get_request_options.rb +289 -0
  541. data/lib/plaid/models/transactions_get_response.rb +288 -0
  542. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  543. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  544. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  545. data/lib/plaid/models/user_custom_password.rb +297 -0
  546. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  547. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  548. data/lib/plaid/models/verification_status.rb +40 -0
  549. data/lib/plaid/models/warning.rb +254 -0
  550. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  551. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  552. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  553. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  554. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  555. data/lib/plaid/version.rb +13 -2
  556. data/pkg/plaid-13.2.0.gem +0 -0
  557. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  558. data/plaid.gemspec +44 -49
  559. data/templates/ruby/api_client.mustache +266 -0
  560. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  561. data/templates/ruby/configuration.mustache +353 -0
  562. data/templates/ruby/gemspec.mustache +41 -0
  563. data/templates/ruby/partial_model_generic.mustache +362 -0
  564. data/test/test_accounts.rb +103 -0
  565. data/test/test_asset_report.rb +147 -0
  566. data/test/test_auth.rb +61 -0
  567. data/test/test_bank_transfers.rb +219 -0
  568. data/test/test_categories.rb +10 -0
  569. data/test/test_configuration.rb +26 -0
  570. data/test/test_deposit_switch.rb +73 -0
  571. data/test/test_helper.rb +109 -0
  572. data/test/test_identity.rb +38 -0
  573. data/test/test_institutions.rb +159 -0
  574. data/test/test_investments.rb +208 -0
  575. data/test/test_item.rb +285 -0
  576. data/test/test_liabilities.rb +45 -0
  577. data/test/test_link_token.rb +97 -0
  578. data/test/test_payment_initiation.rb +94 -0
  579. data/test/test_processor.rb +67 -0
  580. data/test/test_transactions.rb +168 -0
  581. data/test/test_webhooks.rb +22 -0
  582. metadata +606 -97
  583. data/.circleci/config.yml +0 -21
  584. data/.env.sample +0 -3
  585. data/.github/workflows/add_to_project.yml +0 -21
  586. data/.rubocop.yml +0 -18
  587. data/bin/console +0 -14
  588. data/bin/setup +0 -8
  589. data/lib/plaid/client.rb +0 -190
  590. data/lib/plaid/errors.rb +0 -89
  591. data/lib/plaid/middleware.rb +0 -31
  592. data/lib/plaid/models.rb +0 -2221
  593. data/lib/plaid/products/accounts.rb +0 -63
  594. data/lib/plaid/products/asset_report.rb +0 -199
  595. data/lib/plaid/products/auth.rb +0 -42
  596. data/lib/plaid/products/base_product.rb +0 -64
  597. data/lib/plaid/products/categories.rb +0 -21
  598. data/lib/plaid/products/credit_details.rb +0 -40
  599. data/lib/plaid/products/deposit_switch.rb +0 -99
  600. data/lib/plaid/products/identity.rb +0 -31
  601. data/lib/plaid/products/income.rb +0 -31
  602. data/lib/plaid/products/institutions.rb +0 -91
  603. data/lib/plaid/products/investments.rb +0 -127
  604. data/lib/plaid/products/item.rb +0 -209
  605. data/lib/plaid/products/liabilities.rb +0 -39
  606. data/lib/plaid/products/link_token.rb +0 -74
  607. data/lib/plaid/products/payment_initiation.rb +0 -251
  608. data/lib/plaid/products/processor.rb +0 -190
  609. data/lib/plaid/products/sandbox.rb +0 -148
  610. data/lib/plaid/products/transactions.rb +0 -81
  611. data/lib/plaid/products/webhooks.rb +0 -23
@@ -1,31 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Identity product.
3
- class Identity < BaseProduct
4
- # Public: Get Identity information.
5
- #
6
- # Does a POST /identity/get call to retrieve all info for a given
7
- # access_token's item.
8
- #
9
- # access_token - access_token who's item to fetch Identity data for.
10
- #
11
- # Returns the IdentityResponse object with Identity info.
12
- def get(access_token)
13
- post_with_auth 'identity/get',
14
- IdentityResponse,
15
- access_token: access_token
16
- end
17
- end
18
-
19
- # Public: Response for /identity/get.
20
- class IdentityResponse < Models::BaseResponse
21
- ##
22
- # :attr_reader:
23
- # Public: The list of accounts: Array of Plaid::Models::Account.
24
- property :accounts, coerce: Array[Models::AccountWithOwners]
25
-
26
- ##
27
- # :attr_reader:
28
- # Public: The item: Plaid::Models::Item.
29
- property :item, coerce: Models::Item
30
- end
31
- end
@@ -1,31 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Income product.
3
- class Income < BaseProduct
4
- # Public: Get information about user incomes.
5
- #
6
- # Does a POST /income/get call which returns income info for an
7
- # access_token's item.
8
- #
9
- # access_token - access_token whose item to fetch income for.
10
- #
11
- # Returns the IncomeResponse object with Income info.
12
- def get(access_token)
13
- post_with_auth 'income/get',
14
- IncomeResponse,
15
- access_token: access_token
16
- end
17
- end
18
-
19
- # Public: Income product response.
20
- class IncomeResponse < Models::BaseResponse
21
- ##
22
- # :attr_reader:
23
- # Public: The item: Plaid::Models::Item.
24
- property :item, coerce: Models::Item
25
-
26
- ##
27
- # :attr_reader:
28
- # Public: Income information: Plaid::Models::Income.
29
- property :income, coerce: Models::Income
30
- end
31
- end
@@ -1,91 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the Institutions product.
3
- class Institutions < BaseProduct
4
- # Public: Get information about Plaid institutions.
5
- #
6
- # Does a POST /institutions/get call pulls a list of supported Plaid
7
- # institutions with the information for each institution.
8
- #
9
- # count - Amount of institutions to pull.
10
- # offset - Offset to start pulling institutions.
11
- # options - Options for filtering institutions.
12
- #
13
- # Returns a MultipleInstitutionsResponse instance.
14
- def get(count:, offset:, country_codes:, options: nil)
15
- payload = { count: count,
16
- offset: offset,
17
- country_codes: country_codes }
18
- payload[:options] = options unless options.nil?
19
-
20
- post_with_auth 'institutions/get',
21
- MultipleInstitutionsResponse,
22
- payload
23
- end
24
-
25
- # Public: Get information about a Plaid institution by ID.
26
- #
27
- # Does a POST /institutions/get_by_id call which allows you to pull
28
- # information for an institution by ID.
29
- #
30
- # institution_id - Specific institution id to fetch information for.
31
- # options - Options for filtering institutions.
32
- #
33
- # Returns a SingleInstitutionResponse instance.
34
- def get_by_id(institution_id, country_codes, options: nil)
35
- payload = {
36
- institution_id: institution_id,
37
- country_codes: country_codes
38
- }
39
- payload[:options] = options unless options.nil?
40
- post_with_auth 'institutions/get_by_id',
41
- SingleInstitutionResponse,
42
- payload
43
- end
44
-
45
- # Public: Get information about all available institutions matching your
46
- # query.
47
- #
48
- # Does a POST /institutions/search call which allows you to pull a list of
49
- # institutions using a query parameter.
50
- #
51
- # query - Search query to attempt to match institutions to.
52
- # products - Product supported filter (optional).
53
- # options - Options for filtering institutions.
54
- #
55
- # Returns a MultipleInstitutionsResponse instance.
56
- def search(query, country_codes, products = nil, options: nil)
57
- payload = {
58
- query: query,
59
- products: products,
60
- country_codes: country_codes
61
- }
62
-
63
- payload[:options] = options unless options.nil?
64
-
65
- post_with_auth 'institutions/search',
66
- MultipleInstitutionsResponse,
67
- payload
68
- end
69
- end
70
-
71
- # Public: Response for institutions search returning a single institution.
72
- class SingleInstitutionResponse < Models::BaseResponse
73
- ##
74
- # :attr_reader:
75
- # Public: Institution info: Plaid::Models::Institution.
76
- property :institution, coerce: Models::Institution
77
- end
78
-
79
- # Public: Response for institutions search returning multiple institutions.
80
- class MultipleInstitutionsResponse < Models::BaseResponse
81
- ##
82
- # :attr_reader:
83
- # Public: Institutions info: Array of Plaid::Models::Institution.
84
- property :institutions, coerce: Array[Models::Institution]
85
-
86
- ##
87
- # :attr_reader:
88
- # Public: The total number of search results.
89
- property :total
90
- end
91
- end
@@ -1,127 +0,0 @@
1
- require 'date'
2
-
3
- module Plaid
4
- # Public: Class used to get InvestmentTransactions for the Investments
5
- # product.
6
- class InvestmentTransactions < BaseProduct
7
- # Public: Get information about all available investment transactions.
8
- #
9
- # Does a POST /investments/transactions/get call which gives you high level
10
- # account data along with investment transactions and associated securities
11
- # from all investment accounts contained in the access_token's item.
12
- #
13
- # access_token - access_token who's item to get investment transactions for.
14
- # start_date - Start of query for investment transactions.
15
- # end_date - End of query for investment transactions.
16
- # account_ids - Specific account ids to fetch transactions for (optional).
17
- # count - Amount of investment transactions to pull (optional).
18
- # offset - Offset to start pulling investment transactions (optional).
19
- # options - Additional options to merge into API request.
20
- #
21
- # Returns GetResponse.
22
- def get(access_token, start_date, end_date,
23
- account_ids: nil, count: nil, offset: nil, options: nil)
24
-
25
- options_payload = {}
26
- options_payload[:account_ids] = account_ids unless account_ids.nil?
27
- options_payload[:count] = count unless count.nil?
28
- options_payload[:offset] = offset unless offset.nil?
29
- options_payload.merge!(options) unless options.nil?
30
-
31
- post_with_auth 'investments/transactions/get',
32
- GetResponse,
33
- access_token: access_token,
34
- start_date: Plaid.convert_to_date_string(start_date),
35
- end_date: Plaid.convert_to_date_string(end_date),
36
- options: options_payload
37
- end
38
-
39
- # Public: Response for /investments/transactions/get.
40
- class GetResponse < Models::BaseResponse
41
- ##
42
- # :attr_reader:
43
- # Public: The item: Plaid::Models::Item.
44
- property :item, coerce: Models::Item
45
-
46
- ##
47
- # :attr_reader:
48
- # Public: The list of accounts: Array of Plaid::Models::Account.
49
- property :accounts, coerce: Array[Models::Account]
50
-
51
- ##
52
- # :attr_reader:
53
- # Public: The list of investment transactions: Array of
54
- # Plaid::Models::InvestmentTransaction.
55
- property :investment_transactions,
56
- coerce: Array[Models::InvestmentTransaction]
57
-
58
- ##
59
- # :attr_reader:
60
- # Public: The list of securities referenced by the investment
61
- # transactions: Array of Plaid::Models::Security.
62
- property :securities, coerce: Array[Models::Security]
63
-
64
- ##
65
- # :attr_reader:
66
- # Public: The Numeric total investment transactions count.
67
- property :total_investment_transactions
68
- end
69
- end
70
-
71
- # Public: Class used to get Holdings for the Investments product.
72
- class Holdings < BaseProduct
73
- # Public: Get information about all available investment holdings.
74
- #
75
- # Does a POST /investments/holdings/get call which gives you high level
76
- # account data along with investment holdings and associated securities
77
- # from all investment accounts contained in the access_token's item.
78
- #
79
- # access_token - access_token who's item to fetch holdings for.
80
- # account_ids - Specific account ids to fetch holdings for (optional).
81
- # options - Additional options to merge into API request.
82
- #
83
- # Returns GetResponse.
84
- def get(access_token, account_ids: nil, options: nil)
85
- post_with_auth 'investments/holdings/get',
86
- GetResponse,
87
- build_payload(access_token,
88
- account_ids: account_ids,
89
- options: options)
90
- end
91
-
92
- # Public: Response for /investments/holdings/get.
93
- class GetResponse < Models::BaseResponse
94
- ##
95
- # :attr_reader:
96
- # Public: The item: Plaid::Models::Item.
97
- property :item, coerce: Models::Item
98
-
99
- ##
100
- # :attr_reader:
101
- # Public: The list of accounts: Array of Plaid::Models::Account.
102
- property :accounts, coerce: Array[Models::Account]
103
-
104
- ##
105
- # :attr_reader:
106
- # Public: The list of holdings: Array of Plaid::Models::Holding.
107
- property :holdings, coerce: Array[Models::Holding]
108
-
109
- ##
110
- # :attr_reader:
111
- # Public: The list of securities referenced by the holdings: Array of
112
- # Plaid::Models::Security.
113
- property :securities, coerce: Array[Models::Security]
114
- end
115
- end
116
-
117
- # Public: Class used to call the Accounts product.
118
- class Investments < BaseProduct
119
- ##
120
- # Public: The Plaid::InvestmentTransactions product accessor.
121
- subproduct :transactions, Plaid::InvestmentTransactions
122
-
123
- ##
124
- # Public: The Plaid::Holdings product accessor.
125
- subproduct :holdings
126
- end
127
- end
@@ -1,209 +0,0 @@
1
- module Plaid
2
- # Public: Class used to call the AccessToken sub-product.
3
- class AccessToken < BaseProduct
4
- # Public: Rotate your access_token, keeping it attached to the item
5
- #
6
- # Does a POST /item/access_token/invalidate call which will give you a new
7
- # access_token allowing you to rotate access_tokens.
8
- #
9
- # access_token - The String access_token to invalidate and rotate.
10
- #
11
- # Returns an InvalidateResponse object with the new access_token and
12
- # request id.
13
- def invalidate(access_token)
14
- post_with_auth 'item/access_token/invalidate',
15
- InvalidateResponse,
16
- access_token: access_token
17
- end
18
-
19
- # Public: Response for /item/access_token/invalidate.
20
- class InvalidateResponse < Models::BaseResponse
21
- ##
22
- # :attr_reader:
23
- # Public: The String new access token.
24
- property :new_access_token
25
- end
26
- end
27
-
28
- # Public: Class used to call the PublicToken sub-product
29
- class PublicToken < BaseProduct
30
- # Public: Creates a public token from an access_token.
31
- #
32
- # Does a POST /item/public_token/create call which can be used to
33
- # initialize Link in update mode.
34
- #
35
- # access_token - access_token to create a public token for
36
- #
37
- # Returns a CreateResponse object with a public token and expiration info.
38
- def create(access_token)
39
- puts 'Warning: this method will be deprecated in a future version. '\
40
- 'To replace the public_token for initializing Link, look into '\
41
- 'the link_token at https://plaid.com/docs/api/tokens/#linktokencreate.'
42
-
43
- post_with_auth 'item/public_token/create',
44
- CreateResponse,
45
- access_token: access_token
46
- end
47
-
48
- # Public: Response for /item/public_token/create.
49
- class CreateResponse < Models::BaseResponse
50
- ##
51
- # :attr_reader:
52
- # Public: The String token.
53
- property :public_token
54
-
55
- ##
56
- # :attr_reader:
57
- # Public: The String token expiration time.
58
- property :expiration
59
- end
60
-
61
- # Public: Exchange a public token for an access_token
62
- #
63
- # Does a POST /item/public_token/exchange call helps you exchange a public
64
- # token (possibly from Plaid Link) for an access_token you can use in the
65
- # rest of your app.
66
- #
67
- # public_token - The Public token to get an access_token from.
68
- #
69
- # Returns an ExchangeResponse object with an access_token and request id.
70
- def exchange(public_token)
71
- post_with_auth 'item/public_token/exchange',
72
- ExchangeResponse,
73
- public_token: public_token
74
- end
75
-
76
- # Public: Response for /item/public_token/exchange.
77
- class ExchangeResponse < Models::BaseResponse
78
- ##
79
- # :attr_reader:
80
- # Public: The String access token for use with API.
81
- property :access_token
82
-
83
- ##
84
- # :attr_reader:
85
- # Public: The String item ID.
86
- property :item_id
87
- end
88
- end
89
-
90
- # Public: Class used to call the Webhook sub-product
91
- class Webhook < BaseProduct
92
- # Public: Update webhook for an access_token.
93
- #
94
- # Does a POST /item/webhook/update call which is used to update webhook
95
- # for a particular access_token. Webhooks are used to be notified when
96
- # transactions for an item are updated and ready.
97
- #
98
- # access_token - The access_token of an item to update webhook for.
99
- # webhook - The new webhook link.
100
- #
101
- # Returns an UpdateResponse object with either an ItemStatus or MFA
102
- # response.
103
- def update(access_token, webhook)
104
- post_with_auth 'item/webhook/update',
105
- UpdateResponse,
106
- access_token: access_token,
107
- webhook: webhook
108
- end
109
-
110
- # Public: Response for /item/webhook/update.
111
- class UpdateResponse < Models::BaseResponse
112
- ##
113
- # :attr_reader:
114
- # Public: The item: Plaid::Models::Item.
115
- property :item, coerce: Models::Item
116
- end
117
- end
118
-
119
- # Public: Class used to call the Item product.
120
- class Item < BaseProduct
121
- ##
122
- # :attr_reader:
123
- # Public: The Plaid::AccessToken product accessor.
124
- subproduct :access_token
125
-
126
- ##
127
- # :attr_reader:
128
- # Public: The Plaid::PublicToken product accessor.
129
- subproduct :public_token
130
-
131
- ##
132
- # :attr_reader:
133
- # Public: The Plaid::Webhook product accessor.
134
- subproduct :webhook
135
-
136
- # Public: Get information about an item.
137
- #
138
- # Does a POST /item/get call which returns information about an item or
139
- # ItemStatus.
140
- #
141
- # access_token - access_token who's item to fetch status for
142
- #
143
- # Returns a GetResponse object with item information.
144
- def get(access_token)
145
- post_with_auth 'item/get',
146
- GetResponse,
147
- access_token: access_token
148
- end
149
-
150
- # Public: Response for /item/get.
151
- class GetResponse < Models::BaseResponse
152
- ##
153
- # :attr_reader:
154
- # Public: The item: Plaid::Models::Item.
155
- property :item, coerce: Models::Item
156
-
157
- ##
158
- # :attr_reader:
159
- # Public: The item status: Plaid::Models::ItemStatus.
160
- property :status, coerce: Models::ItemStatus
161
- end
162
-
163
- # Public: Removes an item
164
- #
165
- # Does a POST /item/remove call which is used to remove an item
166
- #
167
- # access_token - access_token who's item to remove
168
- #
169
- # Returns a RemoveResponse object with remove result.
170
- def remove(access_token)
171
- post_with_auth 'item/remove',
172
- RemoveResponse,
173
- access_token: access_token
174
- end
175
-
176
- # Public: Response for /item/remove.
177
- class RemoveResponse < Models::BaseResponse
178
- ##
179
- # :attr_reader:
180
- # Public: The Boolean flag meaning successful removal.
181
- property :removed
182
- end
183
-
184
- # Public: Import an item.
185
- #
186
- # Does a POST /item/import call which imports an item.
187
- #
188
- # products - array of products to enable
189
- # user_auth - hash map of user authentication information
190
- # options - optional hash map of options
191
- #
192
- # Returns an access token for the item.
193
- def import(products, user_auth, options)
194
- post_with_auth 'item/import',
195
- ImportResponse,
196
- products: products,
197
- user_auth: user_auth,
198
- options: options
199
- end
200
-
201
- # Public: Response for /item/import.
202
- class ImportResponse < Models::BaseResponse
203
- ##
204
- # :attr_reader:
205
- # Public: The access token string
206
- property :access_token
207
- end
208
- end
209
- end