plaid 14.0.0.beta.5 → 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/Gemfile.lock +15 -5
  4. data/Makefile +1 -1
  5. data/lib/plaid/models/paystub.rb +4 -2
  6. data/lib/plaid/version.rb +1 -1
  7. data/pkg/plaid-14.2.0.gem +0 -0
  8. metadata +10 -230
  9. data/doc/rdoc/apple-touch-icon.png +0 -0
  10. data/doc/rdoc/classes/Object.html +0 -118
  11. data/doc/rdoc/classes/Plaid/APIError.html +0 -97
  12. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +0 -110
  13. data/doc/rdoc/classes/Plaid/AccessToken.html +0 -211
  14. data/doc/rdoc/classes/Plaid/Accounts.html +0 -257
  15. data/doc/rdoc/classes/Plaid/AccountsResponse.html +0 -119
  16. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +0 -205
  17. data/doc/rdoc/classes/Plaid/Apex.html +0 -149
  18. data/doc/rdoc/classes/Plaid/AssetReport.html +0 -683
  19. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +0 -118
  20. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +0 -96
  21. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +0 -118
  22. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +0 -96
  23. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +0 -110
  24. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +0 -110
  25. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +0 -96
  26. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +0 -110
  27. data/doc/rdoc/classes/Plaid/Auth.html +0 -206
  28. data/doc/rdoc/classes/Plaid/AuthResponse.html +0 -127
  29. data/doc/rdoc/classes/Plaid/Balance.html +0 -206
  30. data/doc/rdoc/classes/Plaid/BaseProduct.html +0 -304
  31. data/doc/rdoc/classes/Plaid/Categories.html +0 -191
  32. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +0 -111
  33. data/doc/rdoc/classes/Plaid/Client.html +0 -802
  34. data/doc/rdoc/classes/Plaid/CreateResponse.html +0 -118
  35. data/doc/rdoc/classes/Plaid/CreditDetails.html +0 -203
  36. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +0 -128
  37. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +0 -110
  38. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +0 -118
  39. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +0 -150
  40. data/doc/rdoc/classes/Plaid/DepositSwitch.html +0 -339
  41. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +0 -205
  42. data/doc/rdoc/classes/Plaid/Dwolla.html +0 -150
  43. data/doc/rdoc/classes/Plaid/Error.html +0 -214
  44. data/doc/rdoc/classes/Plaid/GetResponse.html +0 -134
  45. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +0 -137
  46. data/doc/rdoc/classes/Plaid/Holdings.html +0 -218
  47. data/doc/rdoc/classes/Plaid/Identity.html +0 -199
  48. data/doc/rdoc/classes/Plaid/IdentityResponse.html +0 -119
  49. data/doc/rdoc/classes/Plaid/Income.html +0 -198
  50. data/doc/rdoc/classes/Plaid/IncomeResponse.html +0 -119
  51. data/doc/rdoc/classes/Plaid/InstitutionError.html +0 -96
  52. data/doc/rdoc/classes/Plaid/Institutions.html +0 -356
  53. data/doc/rdoc/classes/Plaid/InvalidInputError.html +0 -97
  54. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +0 -96
  55. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +0 -145
  56. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +0 -240
  57. data/doc/rdoc/classes/Plaid/Investments.html +0 -204
  58. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +0 -119
  59. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +0 -110
  60. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +0 -110
  61. data/doc/rdoc/classes/Plaid/Item.html +0 -382
  62. data/doc/rdoc/classes/Plaid/ItemError.html +0 -98
  63. data/doc/rdoc/classes/Plaid/Liabilities.html +0 -202
  64. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +0 -128
  65. data/doc/rdoc/classes/Plaid/LinkToken.html +0 -215
  66. data/doc/rdoc/classes/Plaid/Middleware.html +0 -225
  67. data/doc/rdoc/classes/Plaid/Models/Account.html +0 -166
  68. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +0 -110
  69. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +0 -153
  70. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +0 -198
  71. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +0 -142
  72. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +0 -142
  73. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +0 -145
  74. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +0 -139
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +0 -187
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +0 -159
  77. data/doc/rdoc/classes/Plaid/Models/Balances.html +0 -142
  78. data/doc/rdoc/classes/Plaid/Models/BaseError.html +0 -140
  79. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +0 -259
  80. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +0 -110
  81. data/doc/rdoc/classes/Plaid/Models/Category.html +0 -127
  82. data/doc/rdoc/classes/Plaid/Models/Cause.html +0 -110
  83. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +0 -175
  84. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +0 -137
  85. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +0 -166
  86. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +0 -126
  87. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +0 -126
  88. data/doc/rdoc/classes/Plaid/Models/Error.html +0 -110
  89. data/doc/rdoc/classes/Plaid/Models/Holding.html +0 -181
  90. data/doc/rdoc/classes/Plaid/Models/Identity.html +0 -135
  91. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +0 -118
  92. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +0 -142
  93. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +0 -127
  94. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +0 -126
  95. data/doc/rdoc/classes/Plaid/Models/Income.html +0 -173
  96. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +0 -136
  97. data/doc/rdoc/classes/Plaid/Models/Institution.html +0 -230
  98. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +0 -126
  99. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +0 -136
  100. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +0 -111
  101. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +0 -129
  102. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +0 -127
  103. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +0 -224
  104. data/doc/rdoc/classes/Plaid/Models/Item.html +0 -169
  105. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +0 -129
  106. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +0 -119
  107. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +0 -118
  108. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +0 -119
  109. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +0 -130
  110. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +0 -158
  111. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +0 -110
  112. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +0 -126
  113. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +0 -118
  114. data/doc/rdoc/classes/Plaid/Models/MFA.html +0 -129
  115. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +0 -134
  116. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +0 -126
  117. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +0 -134
  118. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +0 -127
  119. data/doc/rdoc/classes/Plaid/Models/Numbers.html +0 -135
  120. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +0 -128
  121. data/doc/rdoc/classes/Plaid/Models/Payment.html +0 -191
  122. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +0 -118
  123. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +0 -142
  124. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +0 -134
  125. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +0 -118
  126. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +0 -126
  127. data/doc/rdoc/classes/Plaid/Models/Security.html +0 -228
  128. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +0 -129
  129. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +0 -305
  130. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +0 -118
  131. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +0 -142
  132. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +0 -118
  133. data/doc/rdoc/classes/Plaid/Models/Transaction.html +0 -265
  134. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +0 -166
  135. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +0 -167
  136. data/doc/rdoc/classes/Plaid/Models/Warning.html +0 -126
  137. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +0 -174
  138. data/doc/rdoc/classes/Plaid/Models.html +0 -506
  139. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +0 -119
  140. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +0 -205
  141. data/doc/rdoc/classes/Plaid/Ocrolus.html +0 -151
  142. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +0 -118
  143. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +0 -191
  144. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +0 -570
  145. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +0 -119
  146. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +0 -110
  147. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +0 -142
  148. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +0 -110
  149. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +0 -118
  150. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +0 -260
  151. data/doc/rdoc/classes/Plaid/PlaidError.html +0 -96
  152. data/doc/rdoc/classes/Plaid/PlaidServerError.html +0 -96
  153. data/doc/rdoc/classes/Plaid/Processor.html +0 -143
  154. data/doc/rdoc/classes/Plaid/ProcessorToken.html +0 -219
  155. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +0 -110
  156. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +0 -118
  157. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +0 -118
  158. data/doc/rdoc/classes/Plaid/PublicToken.html +0 -283
  159. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +0 -97
  160. data/doc/rdoc/classes/Plaid/Sandbox.html +0 -119
  161. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +0 -110
  162. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +0 -110
  163. data/doc/rdoc/classes/Plaid/SandboxItem.html +0 -351
  164. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +0 -118
  165. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +0 -249
  166. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +0 -111
  167. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +0 -110
  168. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +0 -215
  169. data/doc/rdoc/classes/Plaid/Stripe.html +0 -151
  170. data/doc/rdoc/classes/Plaid/SubproductMixin.html +0 -179
  171. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +0 -144
  172. data/doc/rdoc/classes/Plaid/Transactions.html +0 -302
  173. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +0 -110
  174. data/doc/rdoc/classes/Plaid/Webhook.html +0 -214
  175. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +0 -110
  176. data/doc/rdoc/classes/Plaid/Webhooks.html +0 -207
  177. data/doc/rdoc/classes/Plaid.html +0 -772
  178. data/doc/rdoc/created.rid +0 -28
  179. data/doc/rdoc/css/github.css +0 -123
  180. data/doc/rdoc/css/main.css +0 -333
  181. data/doc/rdoc/css/panel.css +0 -383
  182. data/doc/rdoc/css/reset.css +0 -48
  183. data/doc/rdoc/favicon.ico +0 -0
  184. data/doc/rdoc/files/LICENSE_txt.html +0 -98
  185. data/doc/rdoc/files/README_md.html +0 -388
  186. data/doc/rdoc/files/lib/plaid/client_rb.html +0 -121
  187. data/doc/rdoc/files/lib/plaid/errors_rb.html +0 -132
  188. data/doc/rdoc/files/lib/plaid/middleware_rb.html +0 -99
  189. data/doc/rdoc/files/lib/plaid/models_rb.html +0 -450
  190. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +0 -102
  191. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +0 -132
  192. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +0 -97
  193. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +0 -92
  194. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +0 -92
  195. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +0 -97
  196. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +0 -102
  197. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +0 -97
  198. data/doc/rdoc/files/lib/plaid/products/income_rb.html +0 -97
  199. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +0 -102
  200. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +0 -120
  201. data/doc/rdoc/files/lib/plaid/products/item_rb.html +0 -142
  202. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +0 -97
  203. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +0 -102
  204. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +0 -127
  205. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +0 -142
  206. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +0 -117
  207. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +0 -105
  208. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +0 -97
  209. data/doc/rdoc/files/lib/plaid/version_rb.html +0 -82
  210. data/doc/rdoc/files/lib/plaid_rb.html +0 -120
  211. data/doc/rdoc/i/arrows.png +0 -0
  212. data/doc/rdoc/i/results_bg.png +0 -0
  213. data/doc/rdoc/i/tree_bg.png +0 -0
  214. data/doc/rdoc/index.html +0 -13
  215. data/doc/rdoc/js/highlight.pack.js +0 -1
  216. data/doc/rdoc/js/jquery-1.3.2.min.js +0 -19
  217. data/doc/rdoc/js/main.js +0 -29
  218. data/doc/rdoc/js/navigation.js +0 -142
  219. data/doc/rdoc/js/navigation.js.gz +0 -0
  220. data/doc/rdoc/js/search_index.js +0 -1
  221. data/doc/rdoc/js/search_index.js.gz +0 -0
  222. data/doc/rdoc/js/searchdoc.js +0 -468
  223. data/doc/rdoc/js/searcher.js +0 -229
  224. data/doc/rdoc/js/searcher.js.gz +0 -0
  225. data/doc/rdoc/panel/index.html +0 -74
  226. data/doc/rdoc/panel/links.html +0 -60
  227. data/doc/rdoc/panel/tree.js +0 -1
  228. data/pkg/plaid-13.2.0.gem +0 -0
  229. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
data/doc/rdoc/files/README_md.html DELETED
@@ -1,388 +0,0 @@
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>
data/doc/rdoc/files/lib/plaid/client_rb.html DELETED
@@ -1,121 +0,0 @@
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>client.rb</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
- client.rb
22
- </h1>
23
- <ul class="files">
24
- <li>lib/plaid/client.rb</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 <a href="../../../classes/Plaid.html">Plaid</a> namespace.</p>
35
-
36
- </div>
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
- <!-- Sections -->
46
- <div class="sectiontitle">Sections</div>
47
- <ul>
48
-
49
- <li><a href="#Public">Public</a></li>
50
-
51
- </ul>
52
-
53
-
54
-
55
-
56
- <!-- Namespace -->
57
- <div class="sectiontitle">Namespace</div>
58
- <ul>
59
-
60
- <li>
61
- <span class="type">MODULE</span>
62
- <a href="../../../classes/Plaid.html">Plaid</a>
63
- </li>
64
-
65
- <li>
66
- <span class="type">CLASS</span>
67
- <a href="../../../classes/Plaid/Client.html">Plaid::Client</a>
68
- </li>
69
-
70
- </ul>
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
- <!-- Methods -->
93
-
94
-
95
-
96
-
97
-
98
-
99
- <div class="contenttitle" id="Public">
100
- Public
101
- </div>
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
- <!-- Methods -->
113
-
114
-
115
-
116
-
117
- </div>
118
-
119
- </div>
120
- </body>
121
- </html>
data/doc/rdoc/files/lib/plaid/errors_rb.html DELETED
@@ -1,132 +0,0 @@
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>errors.rb</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
- errors.rb
22
- </h1>
23
- <ul class="files">
24
- <li>lib/plaid/errors.rb</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
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
- <!-- Namespace -->
43
- <div class="sectiontitle">Namespace</div>
44
- <ul>
45
-
46
- <li>
47
- <span class="type">MODULE</span>
48
- <a href="../../../classes/Plaid.html">Plaid</a>
49
- </li>
50
-
51
- <li>
52
- <span class="type">MODULE</span>
53
- <a href="../../../classes/Plaid/Error.html">Plaid::Error</a>
54
- </li>
55
-
56
- <li>
57
- <span class="type">CLASS</span>
58
- <a href="../../../classes/Plaid/APIError.html">Plaid::APIError</a>
59
- </li>
60
-
61
- <li>
62
- <span class="type">CLASS</span>
63
- <a href="../../../classes/Plaid/InstitutionError.html">Plaid::InstitutionError</a>
64
- </li>
65
-
66
- <li>
67
- <span class="type">CLASS</span>
68
- <a href="../../../classes/Plaid/InvalidInputError.html">Plaid::InvalidInputError</a>
69
- </li>
70
-
71
- <li>
72
- <span class="type">CLASS</span>
73
- <a href="../../../classes/Plaid/InvalidRequestError.html">Plaid::InvalidRequestError</a>
74
- </li>
75
-
76
- <li>
77
- <span class="type">CLASS</span>
78
- <a href="../../../classes/Plaid/ItemError.html">Plaid::ItemError</a>
79
- </li>
80
-
81
- <li>
82
- <span class="type">CLASS</span>
83
- <a href="../../../classes/Plaid/PlaidAPIError.html">Plaid::PlaidAPIError</a>
84
- </li>
85
-
86
- <li>
87
- <span class="type">CLASS</span>
88
- <a href="../../../classes/Plaid/PlaidError.html">Plaid::PlaidError</a>
89
- </li>
90
-
91
- <li>
92
- <span class="type">CLASS</span>
93
- <a href="../../../classes/Plaid/PlaidServerError.html">Plaid::PlaidServerError</a>
94
- </li>
95
-
96
- <li>
97
- <span class="type">CLASS</span>
98
- <a href="../../../classes/Plaid/RateLimitExceededError.html">Plaid::RateLimitExceededError</a>
99
- </li>
100
-
101
- </ul>
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
- <!-- Methods -->
124
-
125
-
126
-
127
-
128
- </div>
129
-
130
- </div>
131
- </body>
132
- </html>