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

Sign up to get free protection for your applications and to get access to all the features.
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/classes/Plaid/Client.html DELETED
@@ -1,802 +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>Plaid::Client</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
-
16
- <meta property="og:title" value="Plaid::Client">
17
-
18
-
19
-
20
- <meta name="description" content="The main interface to Plaid API.">
21
- <meta property="og:description" content="The main interface to Plaid API.">
22
-
23
-
24
- <meta name="keywords" content="Plaid::Client class">
25
-
26
- <meta name="keywords" content="new, link_token, post, post_with_auth, build_default_connection, client, api_host, create_connection">
27
-
28
- </head>
29
-
30
- <body>
31
- <div class="banner">
32
-
33
- <h1>
34
- <span class="type">Class</span>
35
- Plaid::Client
36
-
37
- <span class="parent">&lt;
38
-
39
- <a href="../Object.html">Object</a>
40
-
41
- </span>
42
-
43
- </h1>
44
- <ul class="files">
45
-
46
- <li><a href="../../files/lib/plaid/client_rb.html">lib/plaid/client.rb</a></li>
47
-
48
- </ul>
49
- </div>
50
- <div id="bodyContent">
51
- <div id="content">
52
-
53
- <div class="description">
54
-
55
- <p>The main interface to <a href="../Plaid.html">Plaid</a> API.</p>
56
-
57
- </div>
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
- <!-- Sections -->
67
- <div class="sectiontitle">Sections</div>
68
- <ul>
69
-
70
- <li><a href="#Internal">Internal</a></li>
71
-
72
- <li><a href="#Public">Public</a></li>
73
-
74
- </ul>
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
- <!-- Method ref -->
83
- <div class="sectiontitle">Methods</div>
84
- <dl class="methods">
85
-
86
- <dt>A</dt>
87
- <dd>
88
- <ul>
89
-
90
-
91
- <li>
92
- <a href="#method-i-api_host">api_host</a>
93
- </li>
94
-
95
- </ul>
96
- </dd>
97
-
98
- <dt>B</dt>
99
- <dd>
100
- <ul>
101
-
102
-
103
- <li>
104
- <a href="#method-c-build_default_connection">build_default_connection</a>
105
- </li>
106
-
107
- </ul>
108
- </dd>
109
-
110
- <dt>C</dt>
111
- <dd>
112
- <ul>
113
-
114
-
115
- <li>
116
- <a href="#method-i-client">client</a>,
117
- </li>
118
-
119
-
120
- <li>
121
- <a href="#method-i-create_connection">create_connection</a>
122
- </li>
123
-
124
- </ul>
125
- </dd>
126
-
127
- <dt>L</dt>
128
- <dd>
129
- <ul>
130
-
131
-
132
- <li>
133
- <a href="#method-i-link_token">link_token</a>
134
- </li>
135
-
136
- </ul>
137
- </dd>
138
-
139
- <dt>N</dt>
140
- <dd>
141
- <ul>
142
-
143
-
144
- <li>
145
- <a href="#method-c-new">new</a>
146
- </li>
147
-
148
- </ul>
149
- </dd>
150
-
151
- <dt>P</dt>
152
- <dd>
153
- <ul>
154
-
155
-
156
- <li>
157
- <a href="#method-i-post">post</a>,
158
- </li>
159
-
160
-
161
- <li>
162
- <a href="#method-i-post_with_auth">post_with_auth</a>
163
- </li>
164
-
165
- </ul>
166
- </dd>
167
-
168
- </dl>
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
- <!-- Section attributes -->
186
- <div class="sectiontitle">Attributes</div>
187
- <table border='0' cellpadding='5'>
188
-
189
- <tr valign='top'>
190
- <td class='attr-rw'>
191
- [R]
192
- </td>
193
- <td class='attr-name'>accounts</td>
194
- <td class='attr-desc'><p>The <a href="Accounts.html">Plaid::Accounts</a> product accessor.</p></td>
195
- </tr>
196
-
197
- <tr valign='top'>
198
- <td class='attr-rw'>
199
- [R]
200
- </td>
201
- <td class='attr-name'>asset_report</td>
202
- <td class='attr-desc'><p>The <a href="AssetReport.html">Plaid::AssetReport</a> product accessor.</p></td>
203
- </tr>
204
-
205
- <tr valign='top'>
206
- <td class='attr-rw'>
207
- [R]
208
- </td>
209
- <td class='attr-name'>auth</td>
210
- <td class='attr-desc'><p>The <a href="Auth.html">Plaid::Auth</a> product accessor.</p></td>
211
- </tr>
212
-
213
- <tr valign='top'>
214
- <td class='attr-rw'>
215
- [R]
216
- </td>
217
- <td class='attr-name'>categories</td>
218
- <td class='attr-desc'><p>The <a href="Categories.html">Plaid::Categories</a> product accessor.</p></td>
219
- </tr>
220
-
221
- <tr valign='top'>
222
- <td class='attr-rw'>
223
- [R]
224
- </td>
225
- <td class='attr-name'>credit_details</td>
226
- <td class='attr-desc'><p>The <a href="CreditDetails.html">Plaid::CreditDetails</a> product accessor.</p></td>
227
- </tr>
228
-
229
- <tr valign='top'>
230
- <td class='attr-rw'>
231
- [R]
232
- </td>
233
- <td class='attr-name'>deposit_switch</td>
234
- <td class='attr-desc'><p>The <a href="DepositSwitch.html">Plaid::DepositSwitch</a> product accessor.</p></td>
235
- </tr>
236
-
237
- <tr valign='top'>
238
- <td class='attr-rw'>
239
- [R]
240
- </td>
241
- <td class='attr-name'>identity</td>
242
- <td class='attr-desc'><p>The <a href="Identity.html">Plaid::Identity</a> product accessor.</p></td>
243
- </tr>
244
-
245
- <tr valign='top'>
246
- <td class='attr-rw'>
247
- [R]
248
- </td>
249
- <td class='attr-name'>income</td>
250
- <td class='attr-desc'><p>The <a href="Income.html">Plaid::Income</a> product accessor.</p></td>
251
- </tr>
252
-
253
- <tr valign='top'>
254
- <td class='attr-rw'>
255
- [R]
256
- </td>
257
- <td class='attr-name'>institutions</td>
258
- <td class='attr-desc'><p>The <a href="Institutions.html">Plaid::Institutions</a> product accessor.</p></td>
259
- </tr>
260
-
261
- <tr valign='top'>
262
- <td class='attr-rw'>
263
- [R]
264
- </td>
265
- <td class='attr-name'>investments</td>
266
- <td class='attr-desc'><p>The <a href="Investments.html">Plaid::Investments</a> product accessor.</p></td>
267
- </tr>
268
-
269
- <tr valign='top'>
270
- <td class='attr-rw'>
271
- [R]
272
- </td>
273
- <td class='attr-name'>item</td>
274
- <td class='attr-desc'><p>The <a href="Item.html">Plaid::Item</a> product accessor.</p></td>
275
- </tr>
276
-
277
- <tr valign='top'>
278
- <td class='attr-rw'>
279
- [R]
280
- </td>
281
- <td class='attr-name'>liabilities</td>
282
- <td class='attr-desc'><p>The <a href="Liabilities.html">Plaid::Liabilities</a> product accessor.</p></td>
283
- </tr>
284
-
285
- <tr valign='top'>
286
- <td class='attr-rw'>
287
- [R]
288
- </td>
289
- <td class='attr-name'>payment_initiation</td>
290
- <td class='attr-desc'><p>The <a href="PaymentInitiation.html">Plaid::PaymentInitiation</a> product
291
- accessor.</p></td>
292
- </tr>
293
-
294
- <tr valign='top'>
295
- <td class='attr-rw'>
296
- [R]
297
- </td>
298
- <td class='attr-name'>processor</td>
299
- <td class='attr-desc'><p>The <a href="Processor.html">Plaid::Processor</a> product accessor.</p></td>
300
- </tr>
301
-
302
- <tr valign='top'>
303
- <td class='attr-rw'>
304
- [R]
305
- </td>
306
- <td class='attr-name'>sandbox</td>
307
- <td class='attr-desc'><p>The <a href="Sandbox.html">Plaid::Sandbox</a> product accessor.</p></td>
308
- </tr>
309
-
310
- <tr valign='top'>
311
- <td class='attr-rw'>
312
- [R]
313
- </td>
314
- <td class='attr-name'>transactions</td>
315
- <td class='attr-desc'><p>The <a href="Transactions.html">Plaid::Transactions</a> product accessor.</p></td>
316
- </tr>
317
-
318
- <tr valign='top'>
319
- <td class='attr-rw'>
320
- [R]
321
- </td>
322
- <td class='attr-name'>webhooks</td>
323
- <td class='attr-desc'><p>The <a href="Webhooks.html">Plaid::Webhooks</a> endpoint accessor.</p></td>
324
- </tr>
325
-
326
- </table>
327
-
328
-
329
-
330
- <!-- Methods -->
331
-
332
-
333
- <div class="sectiontitle">Instance Public methods</div>
334
-
335
- <div class="method">
336
- <div class="title method-title" id="method-i-link_token">
337
-
338
- <b>link_token</b>
339
-
340
- <a href="../../classes/Plaid/Client.html#method-i-link_token" name="method-i-link_token" class="permalink">Link</a>
341
- </div>
342
-
343
-
344
- <div class="description">
345
- <p>:attr_reader: Public: The <a href="LinkToken.html">Plaid::LinkToken</a>
346
- endpoint accessor.</p>
347
- </div>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
- <div class="sourcecode">
357
-
358
- <p class="source-link">
359
- Source:
360
- <a href="javascript:toggleSource('method-i-link_token_source')" id="l_method-i-link_token_source">show</a>
361
-
362
- </p>
363
- <div id="method-i-link_token_source" class="dyn-source">
364
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 121</span>
365
- <span class="ruby-identifier">subproduct</span> <span class="ruby-value">:link_token</span>
366
- </pre>
367
- </div>
368
- </div>
369
-
370
- </div>
371
-
372
-
373
-
374
-
375
-
376
-
377
- <div class="contenttitle" id="Public">
378
- Public
379
- </div>
380
-
381
-
382
-
383
-
384
-
385
- <!-- Section constants -->
386
- <div class="sectiontitle">Constants</div>
387
- <table border='0' cellpadding='5'>
388
-
389
- <tr valign='top'>
390
- <td class="attr-name">ENVIRONMENTS</td>
391
- <td>=</td>
392
- <td class="attr-value">%i[sandbox development production].freeze</td>
393
- </tr>
394
-
395
- <tr valign='top'>
396
- <td>&nbsp;</td>
397
- <td colspan="2" class="attr-desc"><p>All possible environments for the client to use.</p></td>
398
- </tr>
399
-
400
-
401
- </table>
402
-
403
-
404
-
405
-
406
- <!-- Section attributes -->
407
- <div class="sectiontitle">Attributes</div>
408
- <table border='0' cellpadding='5'>
409
-
410
- <tr valign='top'>
411
- <td class='attr-rw'>
412
- [R]
413
- </td>
414
- <td class='attr-name'>client_id</td>
415
- <td class='attr-desc'><p>The client ID.</p></td>
416
- </tr>
417
-
418
- <tr valign='top'>
419
- <td class='attr-rw'>
420
- [R]
421
- </td>
422
- <td class='attr-name'>env</td>
423
- <td class='attr-desc'><p>The current environment in use (one of <a
424
- href="Client.html#ENVIRONMENTS">ENVIRONMENTS</a>).</p></td>
425
- </tr>
426
-
427
- </table>
428
-
429
-
430
-
431
- <!-- Methods -->
432
-
433
- <div class="sectiontitle">Class Public methods</div>
434
-
435
- <div class="method">
436
- <div class="title method-title" id="method-c-build_default_connection">
437
-
438
- <b>build_default_connection</b>(builder)
439
-
440
- <a href="../../classes/Plaid/Client.html#method-c-build_default_connection" name="method-c-build_default_connection" class="permalink">Link</a>
441
- </div>
442
-
443
-
444
- <div class="description">
445
- <p>Set <a href="../Plaid.html">Plaid</a> defaults on the Faraday connection.</p>
446
- <dl class="rdoc-list note-list"><dt>builder
447
- <dd>
448
- <p>The Faraday builder object.</p>
449
- </dd></dl>
450
- </div>
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
- <div class="sourcecode">
460
-
461
- <p class="source-link">
462
- Source:
463
- <a href="javascript:toggleSource('method-c-build_default_connection_source')" id="l_method-c-build_default_connection_source">show</a>
464
-
465
- </p>
466
- <div id="method-c-build_default_connection_source" class="dyn-source">
467
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 149</span>
468
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
469
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>] = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_TIMEOUT</span>
470
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">headers</span> = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_HEADERS</span>
471
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:json</span>
472
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">use</span> <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span>
473
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">response</span> <span class="ruby-value">:json</span>, <span class="ruby-value">content_type:</span> <span class="ruby-regexp">/\bjson$/</span>
474
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">adapter</span> <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">default_adapter</span>
475
- <span class="ruby-keyword">end</span></pre>
476
- </div>
477
- </div>
478
-
479
- </div>
480
-
481
- <div class="method">
482
- <div class="title method-title" id="method-c-new">
483
-
484
- <b>new</b>(env:, client_id:, secret:, &amp;block)
485
-
486
- <a href="../../classes/Plaid/Client.html#method-c-new" name="method-c-new" class="permalink">Link</a>
487
- </div>
488
-
489
-
490
- <div class="description">
491
- <p>Construct a <a href="Client.html">Client</a> instance</p>
492
-
493
- <p>Optionally takes a block to allow overriding the default Faraday connection
494
- options.</p>
495
- <dl class="rdoc-list note-list"><dt>env
496
- <dd>
497
- <p>The Symbol (:sandbox, :development, :production)</p>
498
- </dd><dt><a href="Client.html#attribute-i-client_id">#client_id</a>
499
- <dd>
500
- <p>The String <a href="../Plaid.html">Plaid</a> account client ID to
501
- authenticate requests</p>
502
- </dd><dt>secret
503
- <dd>
504
- <p>The String <a href="../Plaid.html">Plaid</a> account secret to authenticate
505
- requests</p>
506
- </dd></dl>
507
- </div>
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
- <div class="sourcecode">
517
-
518
- <p class="source-link">
519
- Source:
520
- <a href="javascript:toggleSource('method-c-new_source')" id="l_method-c-new_source">show</a>
521
-
522
- </p>
523
- <div id="method-c-new_source" class="dyn-source">
524
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 22</span>
525
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-value">env:</span>, <span class="ruby-value">client_id:</span>, <span class="ruby-value">secret:</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
526
- <span class="ruby-ivar">@env</span> = <span class="ruby-identifier">env</span>.<span class="ruby-identifier">to_sym</span>
527
- <span class="ruby-ivar">@api_host</span> = <span class="ruby-identifier">api_host</span>
528
- <span class="ruby-ivar">@client_id</span> = <span class="ruby-identifier">client_id</span>
529
- <span class="ruby-ivar">@secret</span> = <span class="ruby-identifier">secret</span>
530
-
531
- <span class="ruby-identifier">create_connection</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
532
- <span class="ruby-keyword">end</span></pre>
533
- </div>
534
- </div>
535
-
536
- </div>
537
-
538
-
539
-
540
- <div class="sectiontitle">Instance Public methods</div>
541
-
542
- <div class="method">
543
- <div class="title method-title" id="method-i-post">
544
-
545
- <b>post</b>(path, payload)
546
-
547
- <a href="../../classes/Plaid/Client.html#method-i-post" name="method-i-post" class="permalink">Link</a>
548
- </div>
549
-
550
-
551
- <div class="description">
552
- <p>Make a post request</p>
553
- <dl class="rdoc-list note-list"><dt>path
554
- <dd>
555
- <p>Path or URL to make the request to</p>
556
- </dd><dt>payload
557
- <dd>
558
- <p>The payload or data to post</p>
559
- </dd></dl>
560
-
561
- <h3 id="method-i-post-label-Returns">Returns</h3>
562
-
563
- <p>Returns the resulting parsed JSON of the request</p>
564
- </div>
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
- <div class="sourcecode">
574
-
575
- <p class="source-link">
576
- Source:
577
- <a href="javascript:toggleSource('method-i-post_source')" id="l_method-i-post_source">show</a>
578
-
579
- </p>
580
- <div id="method-i-post_source" class="dyn-source">
581
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 129</span>
582
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
583
- <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>).<span class="ruby-identifier">body</span>
584
- <span class="ruby-keyword">end</span></pre>
585
- </div>
586
- </div>
587
-
588
- </div>
589
-
590
- <div class="method">
591
- <div class="title method-title" id="method-i-post_with_auth">
592
-
593
- <b>post_with_auth</b>(path, payload)
594
-
595
- <a href="../../classes/Plaid/Client.html#method-i-post_with_auth" name="method-i-post_with_auth" class="permalink">Link</a>
596
- </div>
597
-
598
-
599
- <div class="description">
600
- <p>Make a post request with appended authentication fields</p>
601
- <dl class="rdoc-list note-list"><dt>path
602
- <dd>
603
- <p>Path or URL to make the request to</p>
604
- </dd><dt>payload
605
- <dd>
606
- <p>The payload or data to post</p>
607
- </dd></dl>
608
-
609
- <h3 id="method-i-post_with_auth-label-Returns">Returns</h3>
610
-
611
- <p>Returns the resulting parsed JSON of the request</p>
612
- </div>
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
- <div class="sourcecode">
622
-
623
- <p class="source-link">
624
- Source:
625
- <a href="javascript:toggleSource('method-i-post_with_auth_source')" id="l_method-i-post_with_auth_source">show</a>
626
-
627
- </p>
628
- <div id="method-i-post_with_auth_source" class="dyn-source">
629
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 139</span>
630
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post_with_auth</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
631
- <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(
632
- <span class="ruby-identifier">path</span>,
633
- <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">client_id:</span> <span class="ruby-ivar">@client_id</span>, <span class="ruby-value">secret:</span> <span class="ruby-ivar">@secret</span>)
634
- ).<span class="ruby-identifier">body</span>
635
- <span class="ruby-keyword">end</span></pre>
636
- </div>
637
- </div>
638
-
639
- </div>
640
-
641
-
642
-
643
-
644
-
645
-
646
- <div class="contenttitle" id="Internal">
647
- Internal
648
- </div>
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
- <!-- Methods -->
660
-
661
-
662
- <div class="sectiontitle">Instance Protected methods</div>
663
-
664
- <div class="method">
665
- <div class="title method-title" id="method-i-api_host">
666
-
667
- <b>api_host</b>()
668
-
669
- <a href="../../classes/Plaid/Client.html#method-i-api_host" name="method-i-api_host" class="permalink">Link</a>
670
- </div>
671
-
672
-
673
- <div class="description">
674
- <p>Gets the API hostname for given environment.</p>
675
- <dl class="rdoc-list note-list"><dt>env
676
- <dd>
677
- <p>The Symbol (:sandbox, :development, :production)</p>
678
- </dd></dl>
679
-
680
- <h3 id="method-i-api_host-label-Returns">Returns</h3>
681
-
682
- <p>Returns a String representing the environment URL. Raises ArgumentError if
683
- environment is unknown.</p>
684
- </div>
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
- <div class="sourcecode">
694
-
695
- <p class="source-link">
696
- Source:
697
- <a href="javascript:toggleSource('method-i-api_host_source')" id="l_method-i-api_host_source">show</a>
698
-
699
- </p>
700
- <div id="method-i-api_host_source" class="dyn-source">
701
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 171</span>
702
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">api_host</span>
703
- <span class="ruby-keyword">unless</span> <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@env</span>)
704
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
705
- <span class="ruby-node">&quot;Invalid value for env (#{@env.inspect}): must be one of &quot;</span> <span class="ruby-operator">+</span>
706
- <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:inspect</span>) <span class="ruby-operator">*</span> <span class="ruby-string">&#39;, &#39;</span>
707
- <span class="ruby-keyword">end</span>
708
-
709
- <span class="ruby-node">&quot;https://#{@env}.plaid.com&quot;</span>
710
- <span class="ruby-keyword">end</span></pre>
711
- </div>
712
- </div>
713
-
714
- </div>
715
-
716
- <div class="method">
717
- <div class="title method-title" id="method-i-client">
718
-
719
- <b>client</b>()
720
-
721
- <a href="../../classes/Plaid/Client.html#method-i-client" name="method-i-client" class="permalink">Link</a>
722
- </div>
723
-
724
-
725
- <div class="description">
726
- <p>subproduct-generated methods depend on client method.</p>
727
- </div>
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
- <div class="sourcecode">
737
-
738
- <p class="source-link">
739
- Source:
740
- <a href="javascript:toggleSource('method-i-client_source')" id="l_method-i-client_source">show</a>
741
-
742
- </p>
743
- <div id="method-i-client_source" class="dyn-source">
744
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 161</span>
745
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client</span>
746
- <span class="ruby-keyword">self</span>
747
- <span class="ruby-keyword">end</span></pre>
748
- </div>
749
- </div>
750
-
751
- </div>
752
-
753
- <div class="method">
754
- <div class="title method-title" id="method-i-create_connection">
755
-
756
- <b>create_connection</b>()
757
-
758
- <a href="../../classes/Plaid/Client.html#method-i-create_connection" name="method-i-create_connection" class="permalink">Link</a>
759
- </div>
760
-
761
-
762
- <div class="description">
763
- <p>Initializes a new <a href="../Plaid.html">Plaid</a> connection object via
764
- Faraday.</p>
765
-
766
- <p>Optionally takes a block to allow overriding the defaults.</p>
767
- </div>
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
- <div class="sourcecode">
777
-
778
- <p class="source-link">
779
- Source:
780
- <a href="javascript:toggleSource('method-i-create_connection_source')" id="l_method-i-create_connection_source">show</a>
781
-
782
- </p>
783
- <div id="method-i-create_connection_source" class="dyn-source">
784
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 184</span>
785
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_connection</span>
786
- <span class="ruby-ivar">@connection</span> = <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">url:</span> <span class="ruby-ivar">@api_host</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">builder</span><span class="ruby-operator">|</span>
787
- <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">builder</span>) <span class="ruby-operator">:</span> <span class="ruby-constant">Client</span>.<span class="ruby-identifier">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
788
- <span class="ruby-keyword">end</span>
789
- <span class="ruby-keyword">end</span></pre>
790
- </div>
791
- </div>
792
-
793
- </div>
794
-
795
-
796
-
797
-
798
- </div>
799
-
800
- </div>
801
- </body>
802
- </html>