plaid 14.0.0.beta.2 → 14.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (924) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -1
  3. data/CONTRIBUTING.md +1 -5
  4. data/Gemfile.lock +18 -4
  5. data/LICENSE.txt +1 -1
  6. data/Makefile +2 -21
  7. data/PUBLISH.md +2 -3
  8. data/README.md +7 -6
  9. data/doc/rdoc/.DS_Store +0 -0
  10. data/doc/rdoc/apple-touch-icon.png +0 -0
  11. data/doc/rdoc/classes/Object.html +118 -0
  12. data/doc/rdoc/classes/Plaid.html +772 -0
  13. data/doc/rdoc/classes/Plaid/APIError.html +97 -0
  14. data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
  15. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
  16. data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
  17. data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
  18. data/doc/rdoc/classes/Plaid/Apex.html +149 -0
  19. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
  20. data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
  21. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
  22. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
  23. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
  24. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
  25. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
  26. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
  27. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
  28. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
  29. data/doc/rdoc/classes/Plaid/Auth.html +206 -0
  30. data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
  31. data/doc/rdoc/classes/Plaid/Balance.html +206 -0
  32. data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
  33. data/doc/rdoc/classes/Plaid/Categories.html +191 -0
  34. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
  35. data/doc/rdoc/classes/Plaid/Client.html +802 -0
  36. data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
  37. data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
  38. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
  39. data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
  40. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
  41. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
  42. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
  43. data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
  44. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
  45. data/doc/rdoc/classes/Plaid/Error.html +214 -0
  46. data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
  47. data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
  48. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
  49. data/doc/rdoc/classes/Plaid/Identity.html +199 -0
  50. data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
  51. data/doc/rdoc/classes/Plaid/Income.html +198 -0
  52. data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
  53. data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
  54. data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
  55. data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
  56. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
  57. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
  58. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
  59. data/doc/rdoc/classes/Plaid/Investments.html +204 -0
  60. data/doc/rdoc/classes/Plaid/Item.html +382 -0
  61. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
  62. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
  63. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
  64. data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
  65. data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
  66. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
  67. data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
  68. data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
  69. data/doc/rdoc/classes/Plaid/Models.html +506 -0
  70. data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
  71. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
  72. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
  73. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
  74. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
  77. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
  78. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
  79. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
  80. data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
  81. data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
  82. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
  83. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
  84. data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
  85. data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
  86. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
  87. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
  88. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
  89. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
  90. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
  91. data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
  92. data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
  93. data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
  94. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
  95. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
  96. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
  97. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
  98. data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
  99. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
  100. data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
  101. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
  102. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
  103. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
  104. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
  105. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
  106. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
  107. data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
  108. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
  109. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
  110. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
  111. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
  112. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
  113. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
  114. data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
  115. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
  116. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
  117. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
  118. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
  119. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
  120. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
  121. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
  122. data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
  123. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
  124. data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
  125. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
  126. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
  127. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
  128. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
  129. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
  130. data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
  131. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
  132. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
  133. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
  134. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
  135. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
  136. data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
  137. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
  138. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
  139. data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
  140. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
  141. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
  142. data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
  143. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
  144. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
  145. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
  146. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
  147. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
  148. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
  149. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
  150. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
  151. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
  152. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
  153. data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
  154. data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
  155. data/doc/rdoc/classes/Plaid/Processor.html +143 -0
  156. data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
  157. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
  158. data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
  159. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
  160. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
  161. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
  162. data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
  163. data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
  164. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
  165. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
  166. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
  167. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
  168. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
  169. data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
  170. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
  171. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
  172. data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
  173. data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
  174. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
  175. data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
  176. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
  177. data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
  178. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
  179. data/doc/rdoc/created.rid +28 -0
  180. data/doc/rdoc/css/github.css +123 -0
  181. data/doc/rdoc/css/main.css +333 -0
  182. data/doc/rdoc/css/panel.css +383 -0
  183. data/doc/rdoc/css/reset.css +48 -0
  184. data/doc/rdoc/favicon.ico +0 -0
  185. data/doc/rdoc/files/LICENSE_txt.html +98 -0
  186. data/doc/rdoc/files/README_md.html +388 -0
  187. data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
  188. data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
  189. data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
  190. data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
  191. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
  192. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
  193. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
  194. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
  195. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
  196. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
  197. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
  198. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
  199. data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
  200. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
  201. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
  202. data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
  203. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
  204. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
  205. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
  206. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
  207. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
  208. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
  209. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
  210. data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
  211. data/doc/rdoc/files/lib/plaid_rb.html +120 -0
  212. data/doc/rdoc/i/arrows.png +0 -0
  213. data/doc/rdoc/i/results_bg.png +0 -0
  214. data/doc/rdoc/i/tree_bg.png +0 -0
  215. data/doc/rdoc/index.html +13 -0
  216. data/doc/rdoc/js/highlight.pack.js +1 -0
  217. data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
  218. data/doc/rdoc/js/main.js +29 -0
  219. data/doc/rdoc/js/navigation.js +142 -0
  220. data/doc/rdoc/js/navigation.js.gz +0 -0
  221. data/doc/rdoc/js/search_index.js +1 -0
  222. data/doc/rdoc/js/search_index.js.gz +0 -0
  223. data/doc/rdoc/js/searchdoc.js +468 -0
  224. data/doc/rdoc/js/searcher.js +229 -0
  225. data/doc/rdoc/js/searcher.js.gz +0 -0
  226. data/doc/rdoc/panel/index.html +74 -0
  227. data/doc/rdoc/panel/links.html +60 -0
  228. data/doc/rdoc/panel/tree.js +1 -0
  229. data/lib/plaid.rb +75 -20
  230. data/lib/plaid/.DS_Store +0 -0
  231. data/lib/plaid/api/plaid_api.rb +912 -171
  232. data/lib/plaid/api_client.rb +4 -3
  233. data/lib/plaid/api_error.rb +2 -2
  234. data/lib/plaid/configuration.rb +2 -2
  235. data/lib/plaid/models/account_access.rb +238 -0
  236. data/lib/plaid/models/account_assets.rb +18 -7
  237. data/lib/plaid/models/account_assets_all_of.rb +17 -5
  238. data/lib/plaid/models/account_balance.rb +21 -14
  239. data/lib/plaid/models/account_base.rb +3 -4
  240. data/lib/plaid/models/account_filter.rb +258 -0
  241. data/lib/plaid/models/account_filters_response.rb +2 -2
  242. data/lib/plaid/models/account_identity.rb +3 -4
  243. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  244. data/lib/plaid/models/account_selection_cardinality.rb +38 -0
  245. data/lib/plaid/models/account_subtype.rb +7 -2
  246. data/lib/plaid/models/account_type.rb +2 -2
  247. data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
  248. data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
  249. data/lib/plaid/models/accounts_get_request.rb +4 -4
  250. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  251. data/lib/plaid/models/accounts_get_response.rb +2 -2
  252. data/lib/plaid/models/ach_class.rb +2 -2
  253. data/lib/plaid/models/address.rb +2 -3
  254. data/lib/plaid/models/address_data.rb +3 -7
  255. data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +6 -10
  256. data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +5 -6
  257. data/lib/plaid/models/application.rb +288 -0
  258. data/lib/plaid/models/application_get_request.rb +255 -0
  259. data/lib/plaid/models/application_get_response.rb +239 -0
  260. data/lib/plaid/models/apr.rb +2 -2
  261. data/lib/plaid/models/asset_report.rb +3 -3
  262. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
  263. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  264. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
  265. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
  266. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  267. data/lib/plaid/models/asset_report_create_request.rb +28 -4
  268. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  269. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  270. data/lib/plaid/models/asset_report_filter_request.rb +4 -4
  271. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  272. data/lib/plaid/models/asset_report_get_request.rb +5 -5
  273. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  274. data/lib/plaid/models/asset_report_item.rb +3 -3
  275. data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
  276. data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
  277. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  278. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  279. data/lib/plaid/models/asset_report_remove_request.rb +4 -4
  280. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  281. data/lib/plaid/models/asset_report_transaction.rb +110 -167
  282. data/lib/plaid/models/asset_report_transaction_all_of.rb +7 -22
  283. data/lib/plaid/models/asset_report_user.rb +3 -3
  284. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  285. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  286. data/lib/plaid/models/auth_get_numbers.rb +22 -2
  287. data/lib/plaid/models/auth_get_request.rb +4 -4
  288. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  289. data/lib/plaid/models/auth_get_response.rb +2 -2
  290. data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
  291. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  292. data/lib/plaid/models/bank_transfer.rb +12 -3
  293. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  294. data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
  295. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  296. data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
  297. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  298. data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
  299. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  300. data/lib/plaid/models/bank_transfer_direction.rb +3 -2
  301. data/lib/plaid/models/bank_transfer_event.rb +5 -3
  302. data/lib/plaid/models/bank_transfer_event_list_request.rb +23 -7
  303. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  304. data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
  305. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  306. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  307. data/lib/plaid/models/bank_transfer_failure.rb +3 -3
  308. data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
  309. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  310. data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
  311. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  312. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
  313. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  314. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  315. data/lib/plaid/models/bank_transfer_receiver_details.rb +4 -4
  316. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  317. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  318. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  319. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  320. data/lib/plaid/models/categories_get_response.rb +2 -2
  321. data/lib/plaid/models/category.rb +2 -2
  322. data/lib/plaid/models/cause.rb +2 -2
  323. data/lib/plaid/models/connected_application.rb +357 -0
  324. data/lib/plaid/models/country_code.rb +2 -2
  325. data/lib/plaid/models/credit_card_liability.rb +7 -26
  326. data/lib/plaid/models/credit_filter.rb +3 -3
  327. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  328. data/lib/plaid/models/default_update_webhook.rb +2 -2
  329. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  330. data/lib/plaid/models/deposit_switch_alt_create_request.rb +62 -8
  331. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  332. data/lib/plaid/models/deposit_switch_create_request.rb +62 -8
  333. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  334. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  335. data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
  336. data/lib/plaid/models/deposit_switch_get_response.rb +75 -8
  337. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
  338. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  339. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  340. data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
  341. data/lib/plaid/models/deposit_switch_token_create_response.rb +3 -3
  342. data/lib/plaid/models/depository_filter.rb +3 -3
  343. data/lib/plaid/models/email.rb +2 -2
  344. data/lib/plaid/models/employee.rb +7 -18
  345. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  346. data/lib/plaid/models/employer.rb +8 -4
  347. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  348. data/lib/plaid/models/employers_search_request.rb +4 -4
  349. data/lib/plaid/models/employers_search_response.rb +2 -2
  350. data/lib/plaid/models/error.rb +5 -12
  351. data/lib/plaid/models/external_payment_options.rb +296 -0
  352. data/lib/plaid/models/{payment_initiation_recipient_bacs.rb → external_payment_refund_details.rb} +34 -26
  353. data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +25 -29
  354. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  355. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  356. data/lib/plaid/models/health_incident.rb +19 -6
  357. data/lib/plaid/models/historical_balance.rb +4 -4
  358. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  359. data/lib/plaid/models/holding.rb +5 -5
  360. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  361. data/lib/plaid/models/identity_get_request.rb +4 -4
  362. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  363. data/lib/plaid/models/identity_get_response.rb +2 -2
  364. data/lib/plaid/models/incident_update.rb +5 -5
  365. data/lib/plaid/models/income_breakdown.rb +37 -3
  366. data/lib/plaid/models/income_summary.rb +27 -2
  367. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  368. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  369. data/lib/plaid/models/income_verification_create_request.rb +4 -4
  370. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  371. data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
  372. data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
  373. data/lib/plaid/models/{income_verification_paystub_get_request.rb → income_verification_paystubs_get_request.rb} +8 -8
  374. data/lib/plaid/models/income_verification_paystubs_get_response.rb +241 -0
  375. data/lib/plaid/models/income_verification_refresh_request.rb +245 -0
  376. data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
  377. data/lib/plaid/models/income_verification_status_webhook.rb +3 -3
  378. data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
  379. data/lib/plaid/models/income_verification_summary_get_response.rb +13 -3
  380. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  381. data/lib/plaid/models/inflow_model.rb +2 -2
  382. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  383. data/lib/plaid/models/institution.rb +17 -7
  384. data/lib/plaid/models/institution_status.rb +31 -4
  385. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
  386. data/lib/plaid/models/institutions_get_by_id_request_options.rb +18 -6
  387. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  388. data/lib/plaid/models/institutions_get_request.rb +27 -4
  389. data/lib/plaid/models/institutions_get_request_options.rb +19 -7
  390. data/lib/plaid/models/institutions_get_response.rb +3 -3
  391. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  392. data/lib/plaid/models/{link_token_create_request_account_subtypes_loan.rb → institutions_search_payment_initiation_options.rb} +14 -16
  393. data/lib/plaid/models/institutions_search_request.rb +26 -5
  394. data/lib/plaid/models/institutions_search_request_options.rb +23 -10
  395. data/lib/plaid/models/institutions_search_response.rb +2 -2
  396. data/lib/plaid/models/investment_filter.rb +3 -3
  397. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  398. data/lib/plaid/models/investment_transaction.rb +8 -7
  399. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  400. data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
  401. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  402. data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
  403. data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
  404. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  405. data/lib/plaid/models/item.rb +44 -4
  406. data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
  407. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  408. data/lib/plaid/models/item_application_list_request.rb +241 -0
  409. data/lib/plaid/models/item_application_list_response.rb +237 -0
  410. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  411. data/lib/plaid/models/item_application_scopes_update_request.rb +274 -0
  412. data/lib/plaid/models/{income_verification_paystub_get_response.rb → item_application_scopes_update_response.rb} +12 -16
  413. data/lib/plaid/models/item_error_webhook.rb +2 -2
  414. data/lib/plaid/models/item_get_request.rb +4 -4
  415. data/lib/plaid/models/item_get_response.rb +7 -17
  416. data/lib/plaid/models/item_import_request.rb +25 -4
  417. data/lib/plaid/models/item_import_request_options.rb +2 -2
  418. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  419. data/lib/plaid/models/item_import_response.rb +2 -2
  420. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  421. data/lib/plaid/models/item_public_token_create_request.rb +4 -4
  422. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  423. data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
  424. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  425. data/lib/plaid/models/item_remove_request.rb +4 -4
  426. data/lib/plaid/models/item_remove_response.rb +2 -2
  427. data/lib/plaid/models/item_status.rb +2 -2
  428. data/lib/plaid/models/item_status_investments.rb +4 -4
  429. data/lib/plaid/models/item_status_last_webhook.rb +3 -3
  430. data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +5 -5
  431. data/lib/plaid/models/item_status_transactions.rb +4 -4
  432. data/lib/plaid/models/item_webhook_update_request.rb +4 -4
  433. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  434. data/lib/plaid/models/jwk_public_key.rb +42 -2
  435. data/lib/plaid/models/jwt_header.rb +2 -2
  436. data/lib/plaid/models/liabilities_default_update_webhook.rb +299 -0
  437. data/lib/plaid/models/liabilities_get_request.rb +4 -4
  438. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  439. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  440. data/lib/plaid/models/liabilities_object.rb +5 -5
  441. data/lib/plaid/models/liability_override.rb +9 -26
  442. data/lib/plaid/models/link_token_account_filters.rb +3 -3
  443. data/lib/plaid/models/link_token_create_request.rb +60 -12
  444. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +23 -11
  445. data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
  446. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  447. data/lib/plaid/models/link_token_create_request_income_verification.rb +3 -4
  448. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +23 -2
  449. data/lib/plaid/models/link_token_create_request_user.rb +11 -11
  450. data/lib/plaid/models/link_token_create_response.rb +3 -3
  451. data/lib/plaid/models/{link_token_create_request_account_subtypes_credit.rb → link_token_eu_config.rb} +14 -16
  452. data/lib/plaid/models/link_token_get_metadata_response.rb +12 -2
  453. data/lib/plaid/models/link_token_get_request.rb +4 -4
  454. data/lib/plaid/models/link_token_get_response.rb +12 -2
  455. data/lib/plaid/models/loan_filter.rb +3 -3
  456. data/lib/plaid/models/location.rb +2 -2
  457. data/lib/plaid/models/meta.rb +2 -2
  458. data/lib/plaid/models/mfa.rb +2 -2
  459. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  460. data/lib/plaid/models/mortgage_liability.rb +21 -7
  461. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  462. data/lib/plaid/models/numbers.rb +2 -42
  463. data/lib/plaid/models/numbers_ach.rb +4 -4
  464. data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +7 -7
  465. data/lib/plaid/models/numbers_bacs.rb +2 -2
  466. data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +5 -5
  467. data/lib/plaid/models/numbers_eft.rb +2 -2
  468. data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +5 -5
  469. data/lib/plaid/models/numbers_international.rb +2 -2
  470. data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +5 -5
  471. data/lib/plaid/models/override_account_type.rb +40 -0
  472. data/lib/plaid/models/override_accounts.rb +3 -3
  473. data/lib/plaid/models/owner.rb +3 -3
  474. data/lib/plaid/models/owner_override.rb +2 -2
  475. data/lib/plaid/models/pay_frequency.rb +2 -2
  476. data/lib/plaid/models/pay_period_details.rb +5 -5
  477. data/lib/plaid/models/payment_amount.rb +49 -4
  478. data/lib/plaid/models/payment_initiation_address.rb +133 -2
  479. data/lib/plaid/models/payment_initiation_metadata.rb +267 -0
  480. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +288 -0
  481. data/lib/plaid/models/payment_initiation_payment.rb +413 -0
  482. data/lib/plaid/models/payment_initiation_payment_create_request.rb +70 -10
  483. data/lib/plaid/models/payment_initiation_payment_create_response.rb +36 -2
  484. data/lib/plaid/models/payment_initiation_payment_get_request.rb +25 -4
  485. data/lib/plaid/models/payment_initiation_payment_get_response.rb +95 -22
  486. data/lib/plaid/models/payment_initiation_payment_list_request.rb +6 -19
  487. data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
  488. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +25 -4
  489. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
  490. data/lib/plaid/models/payment_initiation_recipient.rb +21 -10
  491. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +53 -5
  492. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  493. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +25 -4
  494. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +23 -4
  495. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  496. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
  497. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  498. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
  499. data/lib/plaid/models/payment_meta.rb +3 -3
  500. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  501. data/lib/plaid/models/payment_status_update_webhook.rb +48 -4
  502. data/lib/plaid/models/paystub.rb +4 -19
  503. data/lib/plaid/models/paystub_deduction.rb +2 -2
  504. data/lib/plaid/models/{nullable_access_token.rb → paystub_employer.rb} +18 -7
  505. data/lib/plaid/models/paystub_ytd_details.rb +3 -2
  506. data/lib/plaid/models/pending_expiration_webhook.rb +3 -3
  507. data/lib/plaid/models/phone_number.rb +12 -4
  508. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
  509. data/lib/plaid/models/processor_auth_get_request.rb +4 -4
  510. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  511. data/lib/plaid/models/processor_balance_get_request.rb +4 -4
  512. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  513. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  514. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  515. data/lib/plaid/models/processor_identity_get_request.rb +4 -4
  516. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  517. data/lib/plaid/models/processor_number.rb +6 -6
  518. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
  519. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  520. data/lib/plaid/models/processor_token_create_request.rb +39 -5
  521. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  522. data/lib/plaid/models/product_access.rb +262 -0
  523. data/lib/plaid/models/product_status.rb +4 -4
  524. data/lib/plaid/models/product_status_breakdown.rb +2 -3
  525. data/lib/plaid/models/products.rb +4 -2
  526. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  527. data/lib/plaid/models/pslf_status.rb +3 -3
  528. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  529. data/lib/plaid/models/recipient_bacs.rb +54 -2
  530. data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
  531. data/lib/plaid/models/requested_scopes.rb +261 -0
  532. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  533. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  534. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
  535. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  536. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
  537. data/lib/plaid/models/{nullable_recipient_bacs.rb → sandbox_income_fire_webhook_response.rb} +19 -30
  538. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
  539. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  540. data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
  541. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  542. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
  543. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  544. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  545. data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
  546. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  547. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  548. data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
  549. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  550. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +5 -5
  551. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  552. data/lib/plaid/models/scopes.rb +243 -0
  553. data/lib/plaid/models/scopes_nullable.rb +249 -0
  554. data/lib/plaid/models/security.rb +7 -10
  555. data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
  556. data/lib/plaid/models/servicer_address_data.rb +2 -2
  557. data/lib/plaid/models/signal_address_data.rb +263 -0
  558. data/lib/plaid/models/signal_decision_report_request.rb +259 -0
  559. data/lib/plaid/models/signal_decision_report_response.rb +224 -0
  560. data/lib/plaid/models/{link_token_create_request_account_subtypes_investment.rb → signal_device.rb} +26 -16
  561. data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
  562. data/lib/plaid/models/signal_evaluate_request.rb +355 -0
  563. data/lib/plaid/models/signal_evaluate_response.rb +252 -0
  564. data/lib/plaid/models/signal_person_name.rb +265 -0
  565. data/lib/plaid/models/signal_return_report_request.rb +259 -0
  566. data/lib/plaid/models/signal_return_report_response.rb +224 -0
  567. data/lib/plaid/models/signal_scores.rb +227 -0
  568. data/lib/plaid/models/signal_user.rb +252 -0
  569. data/lib/plaid/models/standalone_account_type.rb +2 -2
  570. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  571. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
  572. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  573. data/lib/plaid/models/student_loan.rb +30 -21
  574. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  575. data/lib/plaid/models/student_loan_status.rb +3 -3
  576. data/lib/plaid/models/student_repayment_plan.rb +4 -4
  577. data/lib/plaid/models/transaction.rb +178 -116
  578. data/lib/plaid/models/transaction_all_of.rb +312 -0
  579. data/lib/plaid/models/transaction_base.rb +436 -0
  580. data/lib/plaid/models/transaction_code.rb +2 -2
  581. data/lib/plaid/models/transaction_data.rb +3 -3
  582. data/lib/plaid/models/transaction_override.rb +21 -21
  583. data/lib/plaid/models/transactions_get_request.rb +4 -4
  584. data/lib/plaid/models/transactions_get_request_options.rb +23 -6
  585. data/lib/plaid/models/transactions_get_response.rb +2 -2
  586. data/lib/plaid/models/transactions_refresh_request.rb +9 -4
  587. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  588. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  589. data/lib/plaid/models/user_custom_password.rb +2 -2
  590. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  591. data/lib/plaid/models/verification_expired_webhook.rb +3 -3
  592. data/lib/plaid/models/verification_refresh_status.rb +36 -0
  593. data/lib/plaid/models/verification_status.rb +2 -2
  594. data/lib/plaid/models/warning.rb +36 -2
  595. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  596. data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
  597. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  598. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  599. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  600. data/lib/plaid/version.rb +3 -3
  601. data/pkg/plaid-13.2.0.gem +0 -0
  602. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  603. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  604. data/plaid.gemspec +3 -3
  605. data/templates/ruby/api_client.mustache +3 -1
  606. data/templates/ruby/partial_model_generic.mustache +362 -0
  607. data/test/test_bank_transfers.rb +2 -2
  608. data/test/test_item.rb +1 -10
  609. data/test/test_payment_initiation.rb +2 -3
  610. data/test/test_processor.rb +1 -16
  611. metadata +310 -342
  612. data/docs/ACHClass.md +0 -15
  613. data/docs/APR.md +0 -24
  614. data/docs/AccountAssets.md +0 -40
  615. data/docs/AccountAssetsAllOf.md +0 -24
  616. data/docs/AccountBalance.md +0 -26
  617. data/docs/AccountBase.md +0 -32
  618. data/docs/AccountFiltersResponse.md +0 -24
  619. data/docs/AccountIdentity.md +0 -34
  620. data/docs/AccountIdentityAllOf.md +0 -18
  621. data/docs/AccountSubtype.md +0 -15
  622. data/docs/AccountType.md +0 -15
  623. data/docs/AccountsBalanceGetRequest.md +0 -24
  624. data/docs/AccountsBalanceGetRequestOptions.md +0 -18
  625. data/docs/AccountsGetRequest.md +0 -24
  626. data/docs/AccountsGetRequestOptions.md +0 -18
  627. data/docs/AccountsGetResponse.md +0 -22
  628. data/docs/Address.md +0 -20
  629. data/docs/AddressData.md +0 -26
  630. data/docs/Amount.md +0 -20
  631. data/docs/AssetReport.md +0 -28
  632. data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
  633. data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
  634. data/docs/AssetReportAuditCopyGetRequest.md +0 -22
  635. data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
  636. data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
  637. data/docs/AssetReportCreateRequest.md +0 -26
  638. data/docs/AssetReportCreateRequestOptions.md +0 -22
  639. data/docs/AssetReportCreateResponse.md +0 -22
  640. data/docs/AssetReportFilterRequest.md +0 -24
  641. data/docs/AssetReportFilterResponse.md +0 -22
  642. data/docs/AssetReportGetRequest.md +0 -24
  643. data/docs/AssetReportGetResponse.md +0 -22
  644. data/docs/AssetReportItem.md +0 -26
  645. data/docs/AssetReportPDFGetRequest.md +0 -22
  646. data/docs/AssetReportRefreshRequest.md +0 -26
  647. data/docs/AssetReportRefreshRequestOptions.md +0 -22
  648. data/docs/AssetReportRefreshResponse.md +0 -22
  649. data/docs/AssetReportRemoveRequest.md +0 -22
  650. data/docs/AssetReportRemoveResponse.md +0 -20
  651. data/docs/AssetReportTransaction.md +0 -58
  652. data/docs/AssetReportTransactionAllOf.md +0 -20
  653. data/docs/AssetReportUser.md +0 -30
  654. data/docs/AssetsErrorWebhook.md +0 -24
  655. data/docs/AssetsProductReadyWebhook.md +0 -22
  656. data/docs/AuthGetNumbers.md +0 -24
  657. data/docs/AuthGetRequest.md +0 -24
  658. data/docs/AuthGetRequestOptions.md +0 -18
  659. data/docs/AuthGetResponse.md +0 -24
  660. data/docs/AutomaticallyVerifiedWebhook.md +0 -24
  661. data/docs/BankTransfer.md +0 -50
  662. data/docs/BankTransferBalance.md +0 -20
  663. data/docs/BankTransferBalanceGetRequest.md +0 -22
  664. data/docs/BankTransferBalanceGetResponse.md +0 -22
  665. data/docs/BankTransferCancelRequest.md +0 -22
  666. data/docs/BankTransferCancelResponse.md +0 -18
  667. data/docs/BankTransferCreateRequest.md +0 -46
  668. data/docs/BankTransferCreateResponse.md +0 -20
  669. data/docs/BankTransferDirection.md +0 -15
  670. data/docs/BankTransferEvent.md +0 -40
  671. data/docs/BankTransferEventListRequest.md +0 -40
  672. data/docs/BankTransferEventListResponse.md +0 -20
  673. data/docs/BankTransferEventSyncRequest.md +0 -24
  674. data/docs/BankTransferEventSyncResponse.md +0 -20
  675. data/docs/BankTransferEventType.md +0 -15
  676. data/docs/BankTransferFailure.md +0 -20
  677. data/docs/BankTransferGetRequest.md +0 -22
  678. data/docs/BankTransferGetResponse.md +0 -20
  679. data/docs/BankTransferListRequest.md +0 -32
  680. data/docs/BankTransferListResponse.md +0 -20
  681. data/docs/BankTransferMigrateAccountRequest.md +0 -26
  682. data/docs/BankTransferMigrateAccountResponse.md +0 -22
  683. data/docs/BankTransferNetwork.md +0 -15
  684. data/docs/BankTransferReceiverDetails.md +0 -18
  685. data/docs/BankTransferStatus.md +0 -15
  686. data/docs/BankTransferType.md +0 -15
  687. data/docs/BankTransferUser.md +0 -22
  688. data/docs/CategoriesGetResponse.md +0 -20
  689. data/docs/Category.md +0 -22
  690. data/docs/Cause.md +0 -20
  691. data/docs/CountryCode.md +0 -15
  692. data/docs/CreditCardLiability.md +0 -34
  693. data/docs/CreditFilter.md +0 -18
  694. data/docs/DefaultUpdateWebhook.md +0 -26
  695. data/docs/DepositSwitchAddressData.md +0 -26
  696. data/docs/DepositSwitchAltCreateRequest.md +0 -24
  697. data/docs/DepositSwitchAltCreateResponse.md +0 -20
  698. data/docs/DepositSwitchCreateRequest.md +0 -24
  699. data/docs/DepositSwitchCreateResponse.md +0 -20
  700. data/docs/DepositSwitchGetRequest.md +0 -22
  701. data/docs/DepositSwitchGetResponse.md +0 -38
  702. data/docs/DepositSwitchTargetAccount.md +0 -24
  703. data/docs/DepositSwitchTargetUser.md +0 -28
  704. data/docs/DepositSwitchTokenCreateRequest.md +0 -22
  705. data/docs/DepositSwitchTokenCreateResponse.md +0 -22
  706. data/docs/DepositoryFilter.md +0 -18
  707. data/docs/Email.md +0 -22
  708. data/docs/Employee.md +0 -22
  709. data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
  710. data/docs/Employer.md +0 -24
  711. data/docs/EmployerIncomeSummaryFieldString.md +0 -20
  712. data/docs/EmployersSearchRequest.md +0 -24
  713. data/docs/EmployersSearchResponse.md +0 -20
  714. data/docs/Error.md +0 -34
  715. data/docs/ExternalPaymentSchedule.md +0 -24
  716. data/docs/HealthIncident.md +0 -24
  717. data/docs/HistoricalBalance.md +0 -24
  718. data/docs/HistoricalUpdateWebhook.md +0 -26
  719. data/docs/Holding.md +0 -34
  720. data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
  721. data/docs/IdentityGetRequest.md +0 -24
  722. data/docs/IdentityGetRequestOptions.md +0 -18
  723. data/docs/IdentityGetResponse.md +0 -22
  724. data/docs/IncidentUpdate.md +0 -22
  725. data/docs/IncomeBreakdown.md +0 -24
  726. data/docs/IncomeSummary.md +0 -30
  727. data/docs/IncomeSummaryFieldNumber.md +0 -20
  728. data/docs/IncomeSummaryFieldString.md +0 -20
  729. data/docs/IncomeVerificationCreateRequest.md +0 -22
  730. data/docs/IncomeVerificationCreateResponse.md +0 -20
  731. data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
  732. data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
  733. data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
  734. data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
  735. data/docs/IncomeVerificationStatusWebhook.md +0 -24
  736. data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
  737. data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
  738. data/docs/IncomeVerificationWebhookStatus.md +0 -18
  739. data/docs/InflowModel.md +0 -26
  740. data/docs/InitialUpdateWebhook.md +0 -26
  741. data/docs/Institution.md +0 -36
  742. data/docs/InstitutionStatus.md +0 -30
  743. data/docs/InstitutionsGetByIdRequest.md +0 -26
  744. data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
  745. data/docs/InstitutionsGetByIdResponse.md +0 -20
  746. data/docs/InstitutionsGetRequest.md +0 -28
  747. data/docs/InstitutionsGetRequestOptions.md +0 -24
  748. data/docs/InstitutionsGetResponse.md +0 -22
  749. data/docs/InstitutionsSearchAccountFilter.md +0 -24
  750. data/docs/InstitutionsSearchRequest.md +0 -28
  751. data/docs/InstitutionsSearchRequestOptions.md +0 -22
  752. data/docs/InstitutionsSearchResponse.md +0 -20
  753. data/docs/InvestmentFilter.md +0 -18
  754. data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
  755. data/docs/InvestmentTransaction.md +0 -44
  756. data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
  757. data/docs/InvestmentsHoldingsGetRequest.md +0 -24
  758. data/docs/InvestmentsHoldingsGetResponse.md +0 -26
  759. data/docs/InvestmentsTransactionsGetRequest.md +0 -28
  760. data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
  761. data/docs/InvestmentsTransactionsGetResponse.md +0 -28
  762. data/docs/Item.md +0 -32
  763. data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
  764. data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
  765. data/docs/ItemErrorWebhook.md +0 -24
  766. data/docs/ItemGetRequest.md +0 -22
  767. data/docs/ItemGetResponse.md +0 -24
  768. data/docs/ItemImportRequest.md +0 -26
  769. data/docs/ItemImportRequestOptions.md +0 -18
  770. data/docs/ItemImportRequestUserAuth.md +0 -20
  771. data/docs/ItemImportResponse.md +0 -20
  772. data/docs/ItemProductReadyWebhook.md +0 -24
  773. data/docs/ItemPublicTokenCreateRequest.md +0 -22
  774. data/docs/ItemPublicTokenCreateResponse.md +0 -22
  775. data/docs/ItemPublicTokenExchangeRequest.md +0 -22
  776. data/docs/ItemPublicTokenExchangeResponse.md +0 -22
  777. data/docs/ItemRemoveRequest.md +0 -22
  778. data/docs/ItemRemoveResponse.md +0 -18
  779. data/docs/ItemStatus.md +0 -22
  780. data/docs/ItemStatusInvestments.md +0 -20
  781. data/docs/ItemStatusLastWebhook.md +0 -20
  782. data/docs/ItemStatusTransactions.md +0 -20
  783. data/docs/ItemWebhookUpdateRequest.md +0 -24
  784. data/docs/ItemWebhookUpdateResponse.md +0 -20
  785. data/docs/JWKPublicKey.md +0 -34
  786. data/docs/JWTHeader.md +0 -18
  787. data/docs/LiabilitiesGetRequest.md +0 -24
  788. data/docs/LiabilitiesGetRequestOptions.md +0 -18
  789. data/docs/LiabilitiesGetResponse.md +0 -24
  790. data/docs/LiabilitiesObject.md +0 -22
  791. data/docs/LiabilityOverride.md +0 -66
  792. data/docs/LinkTokenAccountFilters.md +0 -24
  793. data/docs/LinkTokenCreateRequest.md +0 -48
  794. data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
  795. data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
  796. data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
  797. data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
  798. data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
  799. data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
  800. data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
  801. data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
  802. data/docs/LinkTokenCreateRequestUser.md +0 -32
  803. data/docs/LinkTokenCreateResponse.md +0 -22
  804. data/docs/LinkTokenGetMetadataResponse.md +0 -30
  805. data/docs/LinkTokenGetRequest.md +0 -22
  806. data/docs/LinkTokenGetResponse.md +0 -26
  807. data/docs/LoanFilter.md +0 -18
  808. data/docs/Location.md +0 -32
  809. data/docs/MFA.md +0 -26
  810. data/docs/Meta.md +0 -22
  811. data/docs/MortgageInterestRate.md +0 -20
  812. data/docs/MortgageLiability.md +0 -56
  813. data/docs/MortgagePropertyAddress.md +0 -26
  814. data/docs/NullableAccessToken.md +0 -15
  815. data/docs/NullableAddress.md +0 -20
  816. data/docs/NullableAddressData.md +0 -26
  817. data/docs/NullableItemStatus.md +0 -22
  818. data/docs/NullableNumbersACH.md +0 -24
  819. data/docs/NullableNumbersBACS.md +0 -22
  820. data/docs/NullableNumbersEFT.md +0 -24
  821. data/docs/NullableNumbersInternational.md +0 -22
  822. data/docs/NullableRecipientBACS.md +0 -20
  823. data/docs/Numbers.md +0 -32
  824. data/docs/NumbersACH.md +0 -24
  825. data/docs/NumbersBACS.md +0 -22
  826. data/docs/NumbersEFT.md +0 -24
  827. data/docs/NumbersInternational.md +0 -22
  828. data/docs/OverrideAccounts.md +0 -38
  829. data/docs/Owner.md +0 -24
  830. data/docs/OwnerOverride.md +0 -24
  831. data/docs/PSLFStatus.md +0 -22
  832. data/docs/PayFrequency.md +0 -20
  833. data/docs/PayPeriodDetails.md +0 -26
  834. data/docs/PaymentAmount.md +0 -20
  835. data/docs/PaymentInitiationAddress.md +0 -24
  836. data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
  837. data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
  838. data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
  839. data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
  840. data/docs/PaymentInitiationPaymentListRequest.md +0 -24
  841. data/docs/PaymentInitiationPaymentListResponse.md +0 -22
  842. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
  843. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
  844. data/docs/PaymentInitiationRecipient.md +0 -26
  845. data/docs/PaymentInitiationRecipientBacs.md +0 -20
  846. data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
  847. data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
  848. data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
  849. data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
  850. data/docs/PaymentInitiationRecipientListRequest.md +0 -20
  851. data/docs/PaymentInitiationRecipientListResponse.md +0 -20
  852. data/docs/PaymentMeta.md +0 -32
  853. data/docs/PaymentStatusUpdateWebhook.md +0 -30
  854. data/docs/Paystub.md +0 -30
  855. data/docs/PaystubDeduction.md +0 -22
  856. data/docs/PaystubYTDDetails.md +0 -20
  857. data/docs/PendingExpirationWebhook.md +0 -24
  858. data/docs/PhoneNumber.md +0 -22
  859. data/docs/PlaidApi.md +0 -5580
  860. data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
  861. data/docs/ProcessorAuthGetRequest.md +0 -22
  862. data/docs/ProcessorAuthGetResponse.md +0 -22
  863. data/docs/ProcessorBalanceGetRequest.md +0 -22
  864. data/docs/ProcessorBalanceGetResponse.md +0 -20
  865. data/docs/ProcessorIdentityGetRequest.md +0 -22
  866. data/docs/ProcessorIdentityGetResponse.md +0 -20
  867. data/docs/ProcessorNumber.md +0 -24
  868. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
  869. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
  870. data/docs/ProcessorTokenCreateRequest.md +0 -26
  871. data/docs/ProcessorTokenCreateResponse.md +0 -20
  872. data/docs/ProductStatus.md +0 -22
  873. data/docs/ProductStatusBreakdown.md +0 -24
  874. data/docs/Products.md +0 -15
  875. data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
  876. data/docs/RecaptchaRequiredError.md +0 -30
  877. data/docs/RecipientBACS.md +0 -20
  878. data/docs/SandboxBankTransferSimulateRequest.md +0 -26
  879. data/docs/SandboxBankTransferSimulateResponse.md +0 -18
  880. data/docs/SandboxItemFireWebhookRequest.md +0 -24
  881. data/docs/SandboxItemFireWebhookResponse.md +0 -20
  882. data/docs/SandboxItemResetLoginRequest.md +0 -22
  883. data/docs/SandboxItemResetLoginResponse.md +0 -20
  884. data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
  885. data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
  886. data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
  887. data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
  888. data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
  889. data/docs/SandboxPublicTokenCreateRequest.md +0 -26
  890. data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
  891. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
  892. data/docs/SandboxPublicTokenCreateResponse.md +0 -20
  893. data/docs/Security.md +0 -46
  894. data/docs/ServicerAddressData.md +0 -26
  895. data/docs/StandaloneAccountType.md +0 -26
  896. data/docs/StandaloneCurrencyCodeList.md +0 -20
  897. data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
  898. data/docs/StandaloneInvestmentTransactionType.md +0 -28
  899. data/docs/StudentLoan.md +0 -66
  900. data/docs/StudentLoanRepaymentModel.md +0 -22
  901. data/docs/StudentLoanStatus.md +0 -20
  902. data/docs/StudentRepaymentPlan.md +0 -20
  903. data/docs/Transaction.md +0 -54
  904. data/docs/TransactionCode.md +0 -15
  905. data/docs/TransactionData.md +0 -26
  906. data/docs/TransactionOverride.md +0 -26
  907. data/docs/TransactionsGetRequest.md +0 -28
  908. data/docs/TransactionsGetRequestOptions.md +0 -22
  909. data/docs/TransactionsGetResponse.md +0 -26
  910. data/docs/TransactionsRefreshRequest.md +0 -22
  911. data/docs/TransactionsRefreshResponse.md +0 -18
  912. data/docs/TransactionsRemovedWebhook.md +0 -26
  913. data/docs/UserCustomPassword.md +0 -28
  914. data/docs/UserPermissionRevokedWebhook.md +0 -24
  915. data/docs/VerificationExpiredWebhook.md +0 -24
  916. data/docs/VerificationStatus.md +0 -15
  917. data/docs/Warning.md +0 -22
  918. data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
  919. data/docs/WebhookVerificationKeyGetRequest.md +0 -22
  920. data/docs/WebhookVerificationKeyGetResponse.md +0 -20
  921. data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
  922. data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
  923. data/lib/plaid/models/link_token_create_request_account_subtypes_depository.rb +0 -222
  924. data/pkg/plaid-14.0.0.beta.2.gem +0 -0
data/doc/rdoc/css/reset.css ADDED
@@ -0,0 +1,48 @@
1
+ /* http://meyerweb.com/eric/tools/css/reset/ */
2
+ /* v1.0 | 20080212 */
3
+
4
+ html, body, div, span, applet, object, iframe,
5
+ h1, h2, h3, h4, h5, h6, p, blockquote, pre,
6
+ a, abbr, acronym, address, big, cite, code,
7
+ del, dfn, em, font, img, ins, kbd, q, s, samp,
8
+ small, strike, strong, sub, sup, tt, var,
9
+ b, u, i, center,
10
+ dl, dt, dd, ol, ul, li,
11
+ fieldset, form, label, legend,
12
+ table, caption, tbody, tfoot, thead, tr, th, td {
13
+ margin: 0;
14
+ padding: 0;
15
+ border: 0;
16
+ outline: 0;
17
+ font-size: 100%;
18
+ vertical-align: baseline;
19
+ background: transparent;
20
+ }
21
+ body {
22
+ line-height: 1;
23
+ }
24
+ ol, ul {
25
+ list-style: none;
26
+ }
27
+ blockquote, q {
28
+ quotes: none;
29
+ }
30
+ blockquote:before, blockquote:after,
31
+ q:before, q:after {
32
+ content: '';
33
+ content: none;
34
+ }
35
+
36
+ /* remember to highlight inserts somehow! */
37
+ ins {
38
+ text-decoration: none;
39
+ }
40
+ del {
41
+ text-decoration: line-through;
42
+ }
43
+
44
+ /* tables still need 'cellspacing="0"' in the markup */
45
+ table {
46
+ border-collapse: collapse;
47
+ border-spacing: 0;
48
+ }
data/doc/rdoc/favicon.ico ADDED
Binary file
data/doc/rdoc/files/LICENSE_txt.html ADDED
@@ -0,0 +1,98 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <title>LICENSE.txt</title>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
8
+ <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
9
+ <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
10
+ <link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
11
+ <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
12
+ <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
13
+ <script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
14
+
15
+ </head>
16
+
17
+ <body>
18
+ <div class="banner">
19
+
20
+ <h1>
21
+ LICENSE.txt
22
+ </h1>
23
+ <ul class="files">
24
+ <li>LICENSE.txt</li>
25
+ <li>Last modified: 2021-05-14 13:48:06 -0700</li>
26
+ </ul>
27
+ </div>
28
+
29
+ <div id="bodyContent">
30
+ <div id="content">
31
+
32
+ <div class="description">
33
+
34
+ <p>The MIT License (MIT)</p>
35
+
36
+ <p>Copyright © 2017 <a href="../classes/Plaid.html">Plaid</a> Technologies,
37
+ Inc.</p>
38
+
39
+ <p>Permission is hereby granted, free of charge, to any person obtaining a
40
+ copy of this software and associated documentation files (the “Software”),
41
+ to deal in the Software without restriction, including without limitation
42
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
43
+ and/or sell copies of the Software, and to permit persons to whom the
44
+ Software is furnished to do so, subject to the following conditions:</p>
45
+
46
+ <p>The above copyright notice and this permission notice shall be included in
47
+ all copies or substantial portions of the Software.</p>
48
+
49
+ <p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
54
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
55
+ DEALINGS IN THE SOFTWARE.</p>
56
+
57
+ </div>
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <!-- Methods -->
90
+
91
+
92
+
93
+
94
+ </div>
95
+
96
+ </div>
97
+ </body>
98
+ </html>
data/doc/rdoc/files/README_md.html ADDED
@@ -0,0 +1,388 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <title>README.md</title>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
8
+ <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
9
+ <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
10
+ <link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
11
+ <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
12
+ <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
13
+ <script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
14
+
15
+ </head>
16
+
17
+ <body>
18
+ <div class="banner">
19
+
20
+ <h1>
21
+ README.md
22
+ </h1>
23
+ <ul class="files">
24
+ <li>README.md</li>
25
+ <li>Last modified: 2021-05-14 13:48:06 -0700</li>
26
+ </ul>
27
+ </div>
28
+
29
+ <div id="bodyContent">
30
+ <div id="content">
31
+
32
+ <div class="description">
33
+
34
+ <h1 id="label-plaid-ruby+rdoc-image-3Ahttps-3A-2F-2Fcircleci.com-2Fgh-2Fplaid-2Fplaid-ruby.svg-3Fstyle-3Dsvg-26circle-token-3D30ee002ac2021da5b5b5a701d45fe2888af124a5+rdoc-image-3Ahttps-3A-2F-2Fbadge.fury.io-2Frb-2Fplaid.svg">plaid-ruby <a href="https://circleci.com/gh/plaid/plaid-ruby"><img src="https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5"></a> <a href="http://badge.fury.io/rb/plaid"><img src="https://badge.fury.io/rb/plaid.svg"></a></h1>
35
+
36
+ <p>:warning: After 7/12/21, this major version of the library will only
37
+ receive critical security patches. Please consider trying out our new <a
38
+ href="https://github.com/plaid/plaid-ruby/tree/14.0.0-beta-release">beta
39
+ version</a>.</p>
40
+
41
+ <p>The official Ruby bindings for the <a href="https://plaid.com/docs">Plaid
42
+ API</a>.</p>
43
+
44
+ <h2 id="label-Installation">Installation</h2>
45
+
46
+ <p>Add this line to your application&#39;s Gemfile:</p>
47
+
48
+ <pre><code>gem &#39;plaid&#39;
49
+ </code></pre>
50
+
51
+ <p>And then execute:</p>
52
+
53
+ <pre><code>$ bundle
54
+ </code></pre>
55
+
56
+ <p>Or install it yourself as:</p>
57
+
58
+ <pre><code>$ gem install plaid
59
+ </code></pre>
60
+
61
+ <p>The gem supports Ruby 2.2+ only.</p>
62
+
63
+ <h3 id="label-Versioning">Versioning</h3>
64
+
65
+ <p>Each major version of <code>plaid-ruby</code> targets a specific version of
66
+ the <a href="../classes/Plaid.html">Plaid</a> API:</p>
67
+
68
+ <p>| API version | plaid-ruby release | | ———– | —————— | | <a
69
+ href="https://plaid.com/docs/api/versioning/#2020-09-14">2020-09-14</a>
70
+ (<strong>latest</strong>) | <code>12.x.x</code> | | <a
71
+ href="https://plaid.com/docs/api/versioning/#2019-05-29">2019-05-29</a>
72
+ (<strong>latest</strong>) | <code>11.x.x</code>, <code>10.x.x</code>,
73
+ <code>9.x.x</code>, <code>8.x.x</code>, <code>7.x.x</code> | | <a
74
+ href="https://plaid.com/docs/api/versioning/#2018-05-22">2018-05-22</a> |
75
+ <code>6.x.x</code> | | <code>2017-03-08</code> | <code>5.x.x</code> |</p>
76
+
77
+ <p>For information about what has changed between versions and how to update
78
+ your integration, head to the <a
79
+ href="https://plaid.com/docs/api/versioning/">version changelog</a>.</p>
80
+
81
+ <h2 id="label-Usage">Usage</h2>
82
+
83
+ <p>This gem wraps the <a href="../classes/Plaid.html">Plaid</a> API, which is
84
+ fully described in the <a
85
+ href="https://plaid.com/docs/api">documentation</a>.</p>
86
+
87
+ <p>The RubyDoc for the gem is available <a
88
+ href="http://plaid.github.io/plaid-ruby/">here</a>.</p>
89
+
90
+ <h3 id="label-Creating+a+Plaid+client">Creating a <a href="../classes/Plaid.html">Plaid</a> client</h3>
91
+
92
+ <p>Create an instance of the client using the <code>client_id</code> and
93
+ <code>secret</code> from your <a href="../classes/Plaid.html">Plaid</a>
94
+ dashboard along with your environment of choice:</p>
95
+
96
+ <pre><code>require &#39;plaid&#39;
97
+
98
+ client = Plaid::Client.new(env: :sandbox,
99
+ client_id: &#39;***&#39;,
100
+ secret: &#39;***&#39;)
101
+ </code></pre>
102
+
103
+ <p>The <code>env</code> field is the environment which the client will be
104
+ running in. Your choices for the <code>env</code> field include:</p>
105
+ <ul><li>
106
+ <p><code>:sandbox</code> allows you to do your initial integrations tests
107
+ against preloaded data without being billed or making expensive API calls.
108
+ More information about using the API sandbox can be found on the <a
109
+ href="https://plaid.com/docs/api#sandbox">API Sandbox documentation</a>.</p>
110
+ </li><li>
111
+ <p><code>:development</code> allows you to test against both real and test
112
+ accounts without being billed. More information about <a
113
+ href="../classes/Plaid.html">Plaid</a> test accounts can be found in our <a
114
+ href="https://plaid.com/docs/api/#sandbox">API documentation</a>.</p>
115
+ </li><li>
116
+ <p><code>:production</code> is the production environment where you can launch
117
+ your production ready application and be charged for your <a
118
+ href="../classes/Plaid.html">Plaid</a> usage.</p>
119
+ </li></ul>
120
+
121
+ <h3 id="label-Tuning+Faraday">Tuning Faraday</h3>
122
+
123
+ <p>The gem uses Faraday to wrap HTTPS connections, which allows you to tune
124
+ certain params:</p>
125
+
126
+ <pre><code>client = Plaid::Client.new(env: :sandbox, client_id: &#39;***&#39;, secret: &#39;***&#39;) do |builder|
127
+ Plaid::Client.build_default_connection(builder)
128
+
129
+ # Increase network timeout
130
+ builder.options[:timeout] = 60*20 # 20 minutes
131
+ end
132
+ </code></pre>
133
+
134
+ <h2 id="label-Examples">Examples</h2>
135
+
136
+ <h3 id="label-Create+a+new+link_token">Create a new link_token</h3>
137
+
138
+ <pre><code># Grab the client_user_id by searching for the current user in your database
139
+ user = User.find_by!(email: &#39;***&#39;)
140
+ client_user_id = user.id
141
+
142
+ # Create the link_token with all of your configurations
143
+ link_token_response = client.link_token.create(
144
+ user: { client_user_id: client_user_id.to_s },
145
+ client_name: &#39;My app&#39;,
146
+ products: %w[auth transactions],
147
+ country_codes: [&#39;US&#39;],
148
+ language: &#39;en&#39;
149
+ )
150
+
151
+ # Pass the result to your client-side app to initialize Link
152
+ # and retrieve a public_token
153
+ link_token = link_token_response.link_token
154
+ </code></pre>
155
+
156
+ <h3 id="label-Exchanging+a+Link+public_token+for+a+Plaid+access_token">Exchanging a Link public_token for a <a href="../classes/Plaid.html">Plaid</a> access_token</h3>
157
+
158
+ <p>If you have a <a href="https://github.com/plaid/link">Link</a> <code>public
159
+ token</code>, use this function to get an <code>access_token</code>:
160
+ <code>client.item.public_token.exchange(public_token)</code></p>
161
+
162
+ <p>An example of the function&#39;s usage if you have a
163
+ <code>public_token</code> in hand:</p>
164
+
165
+ <pre><code>response = client.item.public_token.exchange(public_token)
166
+ access_token = response.access_token
167
+ </code></pre>
168
+
169
+ <h3 id="label-Deleting+an+item">Deleting an item</h3>
170
+
171
+ <pre><code>require &#39;plaid&#39;
172
+
173
+ client = Plaid::Client.new(env: :sandbox,
174
+ client_id: &#39;***&#39;,
175
+ secret: &#39;***&#39;)
176
+
177
+ exchange_token_response = client.item.public_token.exchange(&#39;[Plaid Link public_token]&#39;)
178
+ access_token = exchange_token_response.access_token
179
+
180
+ # Provide the access_token for the Item you want to remove
181
+ client.item.remove(access_token)
182
+ </code></pre>
183
+
184
+ <h3 id="label-Get+paginated+transactions">Get paginated transactions</h3>
185
+
186
+ <pre><code>require &#39;plaid&#39;
187
+
188
+ client = Plaid::Client.new(env: :sandbox,
189
+ client_id: &#39;***&#39;,
190
+ secret: &#39;***&#39;)
191
+
192
+ exchange_token_response = client.item.public_token.exchange(&#39;[Plaid Link public_token]&#39;)
193
+ access_token = exchange_token_response.access_token
194
+
195
+ transaction_response = client.transactions.get(access_token, &#39;2016-07-12&#39;, &#39;2017-01-09&#39;)
196
+ transactions = transaction_response.transactions
197
+
198
+ # the transactions in the response are paginated, so make multiple calls while
199
+ # increasing the offset to retrieve all transactions
200
+ while transactions.length &lt; transaction_response[&#39;total_transactions&#39;]
201
+ transaction_response = client.transactions.get(access_token,
202
+ &#39;2016-07-12&#39;,
203
+ &#39;2017-01-09&#39;,
204
+ offset: transactions.length)
205
+ transactions += transaction_response.transactions
206
+ end
207
+ </code></pre>
208
+
209
+ <h3 id="label-Obtaining+Item-related+data">Obtaining Item-related data</h3>
210
+
211
+ <p>If you have an <code>access_token</code>, you can use following code to
212
+ retreive data: “`ruby require &#39;plaid&#39;</p>
213
+
214
+ <p>client = <a
215
+ href="../classes/Plaid/Client.html#method-c-new">Plaid::Client.new</a>(env:
216
+ :sandbox, client_id: &#39;<strong><em>&#39;, secret:
217
+ &#39;</em></strong>&#39;)</p>
218
+
219
+ <p>exchange_token_response = client.item.public_token.exchange(&#39;[Plaid
220
+ Link public_token]&#39;) access_token =
221
+ exchange_token_response.access_token</p>
222
+
223
+ <p>auth_response = client.auth.get(access_token) auth = auth_response.auth “`</p>
224
+
225
+ <h3 id="label-Create+a+Stripe+bank_account_token">Create a Stripe bank_account_token</h3>
226
+
227
+ <p>Exchange a <a href="../classes/Plaid.html">Plaid</a> Link
228
+ <code>public_token</code> for an API <code>access_token</code> and a Stripe
229
+ <code>bank_account_token</code>: “`ruby require &#39;plaid&#39;</p>
230
+
231
+ <p>client = <a
232
+ href="../classes/Plaid/Client.html#method-c-new">Plaid::Client.new</a>(env:
233
+ :sandbox, client_id: &#39;<strong><em>&#39;, secret:
234
+ &#39;</em></strong>&#39;)</p>
235
+
236
+ <p>exchange_token_response = client.item.public_token.exchange(&#39;[Plaid
237
+ Link public_token]&#39;) access_token =
238
+ exchange_token_response.access_token</p>
239
+
240
+ <p>stripe_response =
241
+ client.processor.stripe.bank_account_token.create(access_token,
242
+ &#39;[Account ID]&#39;) bank_account_token =
243
+ stripe_response.stripe_bank_account_token “`</p>
244
+
245
+ <p>There are also a number of other methods you can use to retrieve data:</p>
246
+ <ul><li>
247
+ <p><code>client.accounts.get(access_token, ...)</code>: accounts</p>
248
+ </li><li>
249
+ <p><code>client.accounts.balance.get(access_token, ...)</code>: real-time
250
+ balances</p>
251
+ </li><li>
252
+ <p><code>client.auth.get(access_token, ...)</code>: auth</p>
253
+ </li><li>
254
+ <p><code>client.identity.get(access_token, ...)</code>: identity</p>
255
+ </li><li>
256
+ <p><code>client.transactions.get(access_token, ...)</code>: transactions</p>
257
+ </li><li>
258
+ <p><code>client.credit_details.get(access_token, ...)</code>: credit details</p>
259
+ </li><li>
260
+ <p><code>client.investments.transactions.get(access_token, ...)</code>:
261
+ investment-account transactions</p>
262
+ </li><li>
263
+ <p><code>client.investments.holdings.get(access_token, ...)</code>:
264
+ investment-account holdings</p>
265
+ </li></ul>
266
+
267
+ <p>All of these methods return appropriate data. More information can be found
268
+ on the <a href="https://plaid.com/docs/api">API documentation</a>.</p>
269
+
270
+ <h3 id="label-Categories">Categories</h3>
271
+
272
+ <p>You can request category information:</p>
273
+
274
+ <pre><code>categories = client.categories.get # Array of all known categories
275
+ </code></pre>
276
+
277
+ <h3 id="label-Institutions">Institutions</h3>
278
+
279
+ <p>Financial institution information is available as shown below where the
280
+ function arguments represent count and offset:</p>
281
+
282
+ <pre><code>institutions = client.institutions.get(count: 3, offset: 1)
283
+ </code></pre>
284
+
285
+ <h2 id="label-Errors">Errors</h2>
286
+
287
+ <p>Any methods making API calls will result in an exception raised unless the
288
+ response code is “200: Success” or “210: MFA Required”.</p>
289
+
290
+ <p><code>Plaid::InvalidRequestError</code> is returned when the request is
291
+ malformed and cannot be processed.</p>
292
+
293
+ <p><code>Plaid::InvalidInputError</code> is returned when all fields are
294
+ provided and are in the correct format, but the values provided are
295
+ incorrect in some way.</p>
296
+
297
+ <p><code>Plaid::RateLimitExceededError</code> returned when the request is
298
+ valid but has exceeded established rate limits.</p>
299
+
300
+ <p><code>Plaid::APIError</code> is returned during planned maintenance windows
301
+ and in response to API internal server errors.</p>
302
+
303
+ <p><code>Plaid::ItemError</code> indicates that information provided for the
304
+ Item (such as credentials or MFA) may be invalid or that the Item is not
305
+ supported on Plaid&#39;s platform.</p>
306
+
307
+ <p><code>Plaid::InstitutionError</code> is returned when there are errors for
308
+ the requested financial institution.</p>
309
+
310
+ <p>Read more about response codes and their meaning in the <a
311
+ href="https://plaid.com/docs/api">Plaid documentation</a>.</p>
312
+
313
+ <h2 id="label-Response+Objects">Response Objects</h2>
314
+
315
+ <p>Any API call returns a response object which is accessible by dot notation
316
+ (<code>response.foo.bar</code>) or Symbols and Strings as keys:
317
+ <code>response[:foo][:bar]</code> and
318
+ <code>response['foo'][&#39;bar&#39;]</code>. Expected keys for all types of
319
+ responses are defined, and any attempt to access an unknown key will cause
320
+ <code>NoMethodError</code> exception.</p>
321
+
322
+ <h2 id="label-Network+Timeout">Network Timeout</h2>
323
+
324
+ <p>A network timeout value is currently defaulted at 600 seconds = 10 minutes.
325
+ Some requests from the <a href="../classes/Plaid.html">Plaid</a> API may
326
+ take longer than others and we want to make sure that all valid requests
327
+ have a chance to complete. Adjust this value if necessary (see “Tuning
328
+ Faraday”).</p>
329
+
330
+ <h2 id="label-Contributing">Contributing</h2>
331
+
332
+ <p>Bug reports and pull requests are welcome on GitHub at <a
333
+ href="https://github.com/plaid/plaid-ruby">github.com/plaid/plaid-ruby</a>.
334
+ See also <a href="CONTRIBUTING.md">contributing guidelines</a>.</p>
335
+
336
+ <h2 id="label-License">License</h2>
337
+
338
+ <p>The gem is available as open source under the terms of the <a
339
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
340
+
341
+ <h3 id="label-Legacy+API">Legacy API</h3>
342
+
343
+ <p>If you&#39;re looking for a Ruby client that works with the legacy <a
344
+ href="../classes/Plaid.html">Plaid</a> API, use the <a
345
+ href="https://github.com/plaid/plaid-ruby-legacy">plaid-legacy gem</a>.</p>
346
+
347
+ </div>
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+ <!-- Methods -->
380
+
381
+
382
+
383
+
384
+ </div>
385
+
386
+ </div>
387
+ </body>
388
+ </html>