plaid 13.2.0 → 14.0.0.beta.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (611) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +82 -8
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +43 -34
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +2 -0
  8. data/PUBLISH.md +6 -7
  9. data/README.md +99 -93
  10. data/Rakefile +8 -79
  11. data/UPGRADING.md +4 -0
  12. data/doc/rdoc/apple-touch-icon.png +0 -0
  13. data/doc/rdoc/classes/Object.html +118 -0
  14. data/doc/rdoc/classes/Plaid.html +772 -0
  15. data/doc/rdoc/classes/Plaid/APIError.html +97 -0
  16. data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
  17. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
  18. data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
  19. data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
  20. data/doc/rdoc/classes/Plaid/Apex.html +149 -0
  21. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
  22. data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
  23. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
  24. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
  25. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
  26. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
  27. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
  28. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
  29. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
  30. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
  31. data/doc/rdoc/classes/Plaid/Auth.html +206 -0
  32. data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
  33. data/doc/rdoc/classes/Plaid/Balance.html +206 -0
  34. data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
  35. data/doc/rdoc/classes/Plaid/Categories.html +191 -0
  36. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
  37. data/doc/rdoc/classes/Plaid/Client.html +802 -0
  38. data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
  39. data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
  40. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
  41. data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
  42. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
  43. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
  44. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
  45. data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
  46. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
  47. data/doc/rdoc/classes/Plaid/Error.html +214 -0
  48. data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
  49. data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
  50. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
  51. data/doc/rdoc/classes/Plaid/Identity.html +199 -0
  52. data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
  53. data/doc/rdoc/classes/Plaid/Income.html +198 -0
  54. data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
  55. data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
  56. data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
  57. data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
  58. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
  59. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
  60. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
  61. data/doc/rdoc/classes/Plaid/Investments.html +204 -0
  62. data/doc/rdoc/classes/Plaid/Item.html +382 -0
  63. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
  64. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
  65. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
  66. data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
  67. data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
  68. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
  69. data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
  70. data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
  71. data/doc/rdoc/classes/Plaid/Models.html +506 -0
  72. data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
  73. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
  74. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
  75. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
  76. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
  77. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
  78. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
  79. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
  80. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
  81. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
  82. data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
  83. data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
  84. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
  85. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
  86. data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
  87. data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
  88. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
  89. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
  90. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
  91. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
  92. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
  93. data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
  94. data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
  95. data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
  96. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
  97. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
  98. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
  99. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
  100. data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
  101. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
  102. data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
  103. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
  104. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
  105. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
  106. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
  107. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
  108. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
  109. data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
  110. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
  111. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
  112. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
  113. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
  114. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
  115. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
  116. data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
  117. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
  118. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
  119. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
  120. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
  121. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
  122. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
  123. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
  124. data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
  125. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
  126. data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
  127. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
  128. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
  129. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
  130. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
  131. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
  132. data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
  133. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
  134. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
  135. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
  136. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
  137. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
  138. data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
  139. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
  140. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
  141. data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
  142. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
  143. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
  144. data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
  145. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
  146. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
  147. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
  148. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
  149. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
  150. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
  151. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
  152. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
  153. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
  154. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
  155. data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
  156. data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
  157. data/doc/rdoc/classes/Plaid/Processor.html +143 -0
  158. data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
  159. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
  160. data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
  161. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
  162. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
  163. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
  164. data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
  165. data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
  166. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
  167. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
  168. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
  169. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
  170. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
  171. data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
  172. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
  173. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
  174. data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
  175. data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
  176. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
  177. data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
  178. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
  179. data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
  180. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
  181. data/doc/rdoc/created.rid +28 -0
  182. data/doc/rdoc/css/github.css +123 -0
  183. data/doc/rdoc/css/main.css +333 -0
  184. data/doc/rdoc/css/panel.css +383 -0
  185. data/doc/rdoc/css/reset.css +48 -0
  186. data/doc/rdoc/favicon.ico +0 -0
  187. data/doc/rdoc/files/LICENSE_txt.html +98 -0
  188. data/doc/rdoc/files/README_md.html +388 -0
  189. data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
  190. data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
  191. data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
  192. data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
  193. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
  194. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
  195. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
  196. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
  197. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
  198. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
  199. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
  200. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
  201. data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
  202. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
  203. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
  204. data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
  205. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
  206. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
  207. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
  208. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
  209. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
  210. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
  211. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
  212. data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
  213. data/doc/rdoc/files/lib/plaid_rb.html +120 -0
  214. data/doc/rdoc/i/arrows.png +0 -0
  215. data/doc/rdoc/i/results_bg.png +0 -0
  216. data/doc/rdoc/i/tree_bg.png +0 -0
  217. data/doc/rdoc/index.html +13 -0
  218. data/doc/rdoc/js/highlight.pack.js +1 -0
  219. data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
  220. data/doc/rdoc/js/main.js +29 -0
  221. data/doc/rdoc/js/navigation.js +142 -0
  222. data/doc/rdoc/js/navigation.js.gz +0 -0
  223. data/doc/rdoc/js/search_index.js +1 -0
  224. data/doc/rdoc/js/search_index.js.gz +0 -0
  225. data/doc/rdoc/js/searchdoc.js +468 -0
  226. data/doc/rdoc/js/searcher.js +229 -0
  227. data/doc/rdoc/js/searcher.js.gz +0 -0
  228. data/doc/rdoc/panel/index.html +74 -0
  229. data/doc/rdoc/panel/links.html +60 -0
  230. data/doc/rdoc/panel/tree.js +1 -0
  231. data/lib/plaid.rb +352 -61
  232. data/lib/plaid/api/plaid_api.rb +4572 -0
  233. data/lib/plaid/api_client.rb +383 -0
  234. data/lib/plaid/api_error.rb +57 -0
  235. data/lib/plaid/configuration.rb +297 -0
  236. data/lib/plaid/models/account_assets.rb +406 -0
  237. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  238. data/lib/plaid/models/account_balance.rb +280 -0
  239. data/lib/plaid/models/account_base.rb +345 -0
  240. data/lib/plaid/models/account_filters_response.rb +246 -0
  241. data/lib/plaid/models/account_identity.rb +369 -0
  242. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  243. data/lib/plaid/models/account_subtype.rb +102 -0
  244. data/lib/plaid/models/account_type.rb +41 -0
  245. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  246. data/lib/plaid/models/accounts_balance_get_request_options.rb +232 -0
  247. data/lib/plaid/models/accounts_get_request.rb +254 -0
  248. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  249. data/lib/plaid/models/accounts_get_response.rb +256 -0
  250. data/lib/plaid/models/ach_class.rb +50 -0
  251. data/lib/plaid/models/address.rb +235 -0
  252. data/lib/plaid/models/address_data.rb +277 -0
  253. data/lib/plaid/models/application.rb +273 -0
  254. data/lib/plaid/models/application_get_request.rb +255 -0
  255. data/lib/plaid/models/application_get_response.rb +239 -0
  256. data/lib/plaid/models/apr.rb +296 -0
  257. data/lib/plaid/models/asset_report.rb +301 -0
  258. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  259. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  260. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  261. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  262. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  263. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  264. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  265. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  266. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  267. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  268. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  269. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  270. data/lib/plaid/models/asset_report_item.rb +287 -0
  271. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  272. data/lib/plaid/models/asset_report_refresh_request.rb +290 -0
  273. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  274. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  275. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  276. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  277. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  278. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  279. data/lib/plaid/models/asset_report_user.rb +287 -0
  280. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  281. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  282. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  283. data/lib/plaid/models/auth_get_request.rb +254 -0
  284. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  285. data/lib/plaid/models/auth_get_response.rb +270 -0
  286. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  287. data/lib/plaid/models/bank_transfer.rb +453 -0
  288. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  289. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  290. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  291. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  292. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  293. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  294. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  295. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  296. data/lib/plaid/models/bank_transfer_event.rb +390 -0
  297. data/lib/plaid/models/bank_transfer_event_list_request.rb +422 -0
  298. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  299. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  300. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  301. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  302. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  303. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  304. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  305. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  306. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  307. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  308. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  309. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  310. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  311. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  312. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  313. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  314. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  315. data/lib/plaid/models/categories_get_response.rb +242 -0
  316. data/lib/plaid/models/category.rb +257 -0
  317. data/lib/plaid/models/cause.rb +235 -0
  318. data/lib/plaid/models/country_code.rb +42 -0
  319. data/lib/plaid/models/credit_card_liability.rb +324 -0
  320. data/lib/plaid/models/credit_filter.rb +227 -0
  321. data/lib/plaid/models/default_update_webhook.rb +280 -0
  322. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  323. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  324. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  325. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  326. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  327. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  328. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  329. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  330. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  331. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  332. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  333. data/lib/plaid/models/depository_filter.rb +227 -0
  334. data/lib/plaid/models/email.rb +289 -0
  335. data/lib/plaid/models/employee.rb +242 -0
  336. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  337. data/lib/plaid/models/employer.rb +261 -0
  338. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  339. data/lib/plaid/models/employers_search_request.rb +262 -0
  340. data/lib/plaid/models/employers_search_response.rb +242 -0
  341. data/lib/plaid/models/error.rb +360 -0
  342. data/lib/plaid/models/external_payment_options.rb +242 -0
  343. data/lib/plaid/models/external_payment_refund_details.rb +240 -0
  344. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  345. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  346. data/lib/plaid/models/health_incident.rb +253 -0
  347. data/lib/plaid/models/historical_balance.rb +262 -0
  348. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  349. data/lib/plaid/models/holding.rb +329 -0
  350. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  351. data/lib/plaid/models/identity_get_request.rb +254 -0
  352. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  353. data/lib/plaid/models/identity_get_response.rb +256 -0
  354. data/lib/plaid/models/incident_update.rb +273 -0
  355. data/lib/plaid/models/income_breakdown.rb +253 -0
  356. data/lib/plaid/models/income_summary.rb +275 -0
  357. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  358. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  359. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  360. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  361. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  362. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  363. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  364. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  365. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  366. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  367. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  368. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  369. data/lib/plaid/models/inflow_model.rb +285 -0
  370. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  371. data/lib/plaid/models/institution.rb +354 -0
  372. data/lib/plaid/models/institution_status.rb +307 -0
  373. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  374. data/lib/plaid/models/institutions_get_by_id_request_options.rb +246 -0
  375. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  376. data/lib/plaid/models/institutions_get_request.rb +328 -0
  377. data/lib/plaid/models/institutions_get_request_options.rb +266 -0
  378. data/lib/plaid/models/institutions_get_response.rb +257 -0
  379. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  380. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +220 -0
  381. data/lib/plaid/models/institutions_search_request.rb +309 -0
  382. data/lib/plaid/models/institutions_search_request_options.rb +252 -0
  383. data/lib/plaid/models/institutions_search_response.rb +242 -0
  384. data/lib/plaid/models/investment_filter.rb +227 -0
  385. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  386. data/lib/plaid/models/investment_transaction.rb +446 -0
  387. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  388. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  389. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  390. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  391. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  392. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  393. data/lib/plaid/models/item.rb +351 -0
  394. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  395. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  396. data/lib/plaid/models/item_error_webhook.rb +265 -0
  397. data/lib/plaid/models/item_get_request.rb +245 -0
  398. data/lib/plaid/models/item_get_response.rb +249 -0
  399. data/lib/plaid/models/item_import_request.rb +291 -0
  400. data/lib/plaid/models/item_import_request_options.rb +220 -0
  401. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  402. data/lib/plaid/models/item_import_response.rb +240 -0
  403. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  404. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  405. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  406. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  407. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  408. data/lib/plaid/models/item_remove_request.rb +245 -0
  409. data/lib/plaid/models/item_remove_response.rb +225 -0
  410. data/lib/plaid/models/item_status.rb +249 -0
  411. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  412. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  413. data/lib/plaid/models/jwk_public_key.rb +339 -0
  414. data/lib/plaid/models/jwt_header.rb +224 -0
  415. data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
  416. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  417. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  418. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  419. data/lib/plaid/models/liabilities_object.rb +249 -0
  420. data/lib/plaid/models/liability_override.rb +566 -0
  421. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  422. data/lib/plaid/models/link_token_create_request.rb +429 -0
  423. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  424. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  425. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  426. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  427. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  428. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  429. data/lib/plaid/models/link_token_create_response.rb +255 -0
  430. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  431. data/lib/plaid/models/link_token_get_request.rb +245 -0
  432. data/lib/plaid/models/link_token_get_response.rb +266 -0
  433. data/lib/plaid/models/loan_filter.rb +227 -0
  434. data/lib/plaid/models/location.rb +298 -0
  435. data/lib/plaid/models/meta.rb +255 -0
  436. data/lib/plaid/models/mfa.rb +285 -0
  437. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  438. data/lib/plaid/models/mortgage_liability.rb +430 -0
  439. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  440. data/lib/plaid/models/nullable_access_token.rb +209 -0
  441. data/lib/plaid/models/nullable_address.rb +241 -0
  442. data/lib/plaid/models/nullable_address_data.rb +283 -0
  443. data/lib/plaid/models/nullable_item_status.rb +255 -0
  444. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  445. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  446. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  447. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  448. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  449. data/lib/plaid/models/numbers.rb +330 -0
  450. data/lib/plaid/models/numbers_ach.rb +266 -0
  451. data/lib/plaid/models/numbers_bacs.rb +255 -0
  452. data/lib/plaid/models/numbers_eft.rb +270 -0
  453. data/lib/plaid/models/numbers_international.rb +255 -0
  454. data/lib/plaid/models/override_accounts.rb +366 -0
  455. data/lib/plaid/models/owner.rb +278 -0
  456. data/lib/plaid/models/owner_override.rb +278 -0
  457. data/lib/plaid/models/pay_frequency.rb +272 -0
  458. data/lib/plaid/models/pay_period_details.rb +265 -0
  459. data/lib/plaid/models/payment_amount.rb +274 -0
  460. data/lib/plaid/models/payment_initiation_address.rb +269 -0
  461. data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
  462. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +236 -0
  463. data/lib/plaid/models/payment_initiation_payment.rb +395 -0
  464. data/lib/plaid/models/payment_initiation_payment_create_request.rb +294 -0
  465. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  466. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  467. data/lib/plaid/models/payment_initiation_payment_get_response.rb +418 -0
  468. data/lib/plaid/models/payment_initiation_payment_list_request.rb +271 -0
  469. data/lib/plaid/models/payment_initiation_payment_list_response.rb +253 -0
  470. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  471. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  472. data/lib/plaid/models/payment_initiation_recipient.rb +282 -0
  473. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +276 -0
  474. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  475. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  476. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +305 -0
  477. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  478. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  479. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  480. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
  481. data/lib/plaid/models/payment_meta.rb +298 -0
  482. data/lib/plaid/models/payment_schedule_interval.rb +37 -0
  483. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  484. data/lib/plaid/models/paystub.rb +306 -0
  485. data/lib/plaid/models/paystub_deduction.rb +242 -0
  486. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  487. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  488. data/lib/plaid/models/phone_number.rb +281 -0
  489. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  490. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  491. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  492. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  493. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  494. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  495. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  496. data/lib/plaid/models/processor_number.rb +250 -0
  497. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  498. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  499. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  500. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  501. data/lib/plaid/models/product_status.rb +288 -0
  502. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  503. data/lib/plaid/models/products.rb +47 -0
  504. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  505. data/lib/plaid/models/pslf_status.rb +243 -0
  506. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  507. data/lib/plaid/models/recipient_bacs.rb +230 -0
  508. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  509. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  510. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  511. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  512. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +294 -0
  513. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  514. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  515. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  516. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  517. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  518. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  519. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  520. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  521. data/lib/plaid/models/sandbox_public_token_create_request.rb +292 -0
  522. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  523. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  524. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  525. data/lib/plaid/models/security.rb +379 -0
  526. data/lib/plaid/models/servicer_address_data.rb +265 -0
  527. data/lib/plaid/models/standalone_account_type.rb +285 -0
  528. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  529. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  530. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  531. data/lib/plaid/models/student_loan.rb +472 -0
  532. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  533. data/lib/plaid/models/student_loan_status.rb +266 -0
  534. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  535. data/lib/plaid/models/transaction.rb +500 -0
  536. data/lib/plaid/models/transaction_code.rb +48 -0
  537. data/lib/plaid/models/transaction_data.rb +285 -0
  538. data/lib/plaid/models/transaction_override.rb +280 -0
  539. data/lib/plaid/models/transactions_get_request.rb +284 -0
  540. data/lib/plaid/models/transactions_get_request_options.rb +289 -0
  541. data/lib/plaid/models/transactions_get_response.rb +288 -0
  542. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  543. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  544. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  545. data/lib/plaid/models/user_custom_password.rb +297 -0
  546. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  547. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  548. data/lib/plaid/models/verification_status.rb +40 -0
  549. data/lib/plaid/models/warning.rb +254 -0
  550. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  551. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  552. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  553. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  554. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  555. data/lib/plaid/version.rb +13 -2
  556. data/pkg/plaid-13.2.0.gem +0 -0
  557. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  558. data/plaid.gemspec +44 -49
  559. data/templates/ruby/api_client.mustache +266 -0
  560. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  561. data/templates/ruby/configuration.mustache +353 -0
  562. data/templates/ruby/gemspec.mustache +41 -0
  563. data/templates/ruby/partial_model_generic.mustache +362 -0
  564. data/test/test_accounts.rb +103 -0
  565. data/test/test_asset_report.rb +147 -0
  566. data/test/test_auth.rb +61 -0
  567. data/test/test_bank_transfers.rb +219 -0
  568. data/test/test_categories.rb +10 -0
  569. data/test/test_configuration.rb +26 -0
  570. data/test/test_deposit_switch.rb +73 -0
  571. data/test/test_helper.rb +109 -0
  572. data/test/test_identity.rb +38 -0
  573. data/test/test_institutions.rb +159 -0
  574. data/test/test_investments.rb +208 -0
  575. data/test/test_item.rb +285 -0
  576. data/test/test_liabilities.rb +45 -0
  577. data/test/test_link_token.rb +97 -0
  578. data/test/test_payment_initiation.rb +94 -0
  579. data/test/test_processor.rb +67 -0
  580. data/test/test_transactions.rb +168 -0
  581. data/test/test_webhooks.rb +22 -0
  582. metadata +606 -97
  583. data/.circleci/config.yml +0 -21
  584. data/.env.sample +0 -3
  585. data/.github/workflows/add_to_project.yml +0 -21
  586. data/.rubocop.yml +0 -18
  587. data/bin/console +0 -14
  588. data/bin/setup +0 -8
  589. data/lib/plaid/client.rb +0 -190
  590. data/lib/plaid/errors.rb +0 -89
  591. data/lib/plaid/middleware.rb +0 -31
  592. data/lib/plaid/models.rb +0 -2221
  593. data/lib/plaid/products/accounts.rb +0 -63
  594. data/lib/plaid/products/asset_report.rb +0 -199
  595. data/lib/plaid/products/auth.rb +0 -42
  596. data/lib/plaid/products/base_product.rb +0 -64
  597. data/lib/plaid/products/categories.rb +0 -21
  598. data/lib/plaid/products/credit_details.rb +0 -40
  599. data/lib/plaid/products/deposit_switch.rb +0 -99
  600. data/lib/plaid/products/identity.rb +0 -31
  601. data/lib/plaid/products/income.rb +0 -31
  602. data/lib/plaid/products/institutions.rb +0 -91
  603. data/lib/plaid/products/investments.rb +0 -127
  604. data/lib/plaid/products/item.rb +0 -209
  605. data/lib/plaid/products/liabilities.rb +0 -39
  606. data/lib/plaid/products/link_token.rb +0 -74
  607. data/lib/plaid/products/payment_initiation.rb +0 -251
  608. data/lib/plaid/products/processor.rb +0 -190
  609. data/lib/plaid/products/sandbox.rb +0 -148
  610. data/lib/plaid/products/transactions.rb +0 -81
  611. data/lib/plaid/products/webhooks.rb +0 -23
data/.circleci/config.yml DELETED
@@ -1,21 +0,0 @@
1
- version: 2
2
- jobs:
3
- build:
4
- docker:
5
- - image: circleci/ruby:2.4
6
- steps:
7
- - checkout
8
- - run:
9
- name: Bundle Install
10
- command: bundle check || bundle install
11
- - run:
12
- name: Stubbed API test
13
- command: bundle exec rake test
14
- environment:
15
- STUB_API: true
16
- - run:
17
- name: Live API test
18
- command: bundle exec rake test
19
- - run:
20
- name: Rubocop test
21
- command: bundle exec rubocop
data/.env.sample DELETED
@@ -1,3 +0,0 @@
1
- PLAID_RUBY_CLIENT_ID=the_real_client_id
2
- PLAID_RUBY_SECRET=the_real_secret
3
- PLAID_RUBY_PUBLIC_KEY=the_real_public_key
@@ -1,21 +0,0 @@
1
- name: Auto Assign to CLIB Project
2
-
3
- on:
4
- issues:
5
- types: [opened]
6
- pull_request:
7
- types: [opened]
8
- env:
9
- MY_GITHUB_TOKEN: ${{ secrets.CLIB_AUTOMATION_TOKEN }
10
-
11
- jobs:
12
- assign_one_project:
13
- runs-on: ubuntu-latest
14
- name: Assign to One Project
15
- steps:
16
- - name: Assign NEW issues and NEW pull requests to project 1
17
- uses: srggrs/assign-one-project-github-action@1.2.0
18
- if: github.event.action == 'opened'
19
- with:
20
- project: 'https://github.com/orgs/plaid/projects/1'
21
- column_name: 'Needs Investigation'
data/.rubocop.yml DELETED
@@ -1,18 +0,0 @@
1
- AllCops:
2
- TargetRubyVersion: 2.4
3
-
4
- Style/FrozenStringLiteralComment:
5
- Enabled: false
6
-
7
- Layout/IndentHeredoc:
8
- Enabled: false
9
-
10
- Metrics/AbcSize:
11
- Enabled: false
12
-
13
- Metrics/MethodLength:
14
- Max: 20
15
-
16
- Metrics/ParameterLists:
17
- Max: 5
18
- CountKeywordArgs: false
data/bin/console DELETED
@@ -1,14 +0,0 @@
1
- #!/usr/bin/env ruby
2
-
3
- require 'bundler/setup'
4
- require 'plaid'
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require 'irb'
14
- IRB.start(__FILE__)
data/bin/setup DELETED
@@ -1,8 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
data/lib/plaid/client.rb DELETED
@@ -1,190 +0,0 @@
1
- # Public: The Plaid namespace.
2
- module Plaid
3
- # Public: The main interface to Plaid API.
4
- class Client
5
- # Public: All possible environments for the client to use.
6
- ENVIRONMENTS = %i[sandbox development production].freeze
7
-
8
- # Public: The current environment in use (one of ENVIRONMENTS).
9
- attr_reader :env
10
-
11
- # Public: The client ID.
12
- attr_reader :client_id
13
-
14
- # Public: Construct a Client instance
15
- #
16
- # Optionally takes a block to allow overriding the default Faraday
17
- # connection options.
18
- #
19
- # env - The Symbol (:sandbox, :development, :production)
20
- # client_id - The String Plaid account client ID to authenticate requests
21
- # secret - The String Plaid account secret to authenticate requests
22
- def initialize(env:, client_id:, secret:, &block)
23
- @env = env.to_sym
24
- @api_host = api_host
25
- @client_id = client_id
26
- @secret = secret
27
-
28
- create_connection(&block)
29
- end
30
-
31
- extend SubproductMixin
32
-
33
- ##
34
- # :attr_reader:
35
- # Public: The Plaid::Accounts product accessor.
36
- subproduct :accounts
37
-
38
- ##
39
- # :attr_reader:
40
- # Public: The Plaid::Auth product accessor.
41
- subproduct :auth
42
-
43
- ##
44
- # :attr_reader:
45
- # Public: The Plaid::AssetReport product accessor.
46
- subproduct :asset_report
47
-
48
- ##
49
- # :attr_reader:
50
- # Public: The Plaid::Categories product accessor.
51
- subproduct :categories
52
-
53
- ##
54
- # :attr_reader:
55
- # Public: The Plaid::CreditDetails product accessor.
56
- subproduct :credit_details
57
-
58
- ##
59
- # :attr_reader:
60
- # Public: The Plaid::DepositSwitch product accessor.
61
- subproduct :deposit_switch
62
-
63
- ##
64
- # :attr_reader:
65
- # Public: The Plaid::Identity product accessor.
66
- subproduct :identity
67
-
68
- ##
69
- # :attr_reader:
70
- # Public: The Plaid::Income product accessor.
71
- subproduct :income
72
-
73
- ##
74
- # :attr_reader:
75
- # Public: The Plaid::Institutions product accessor.
76
- subproduct :institutions
77
-
78
- ##
79
- # :attr_reader:
80
- # Public: The Plaid::Item product accessor.
81
- subproduct :item
82
-
83
- ##
84
- # :attr_reader:
85
- # Public: The Plaid::Liabilities product accessor.
86
- subproduct :liabilities
87
-
88
- ##
89
- # :attr_reader:
90
- # Public: The Plaid::Processor product accessor.
91
- subproduct :processor
92
-
93
- ##
94
- # :attr_reader:
95
- # Public: The Plaid::Sandbox product accessor.
96
- subproduct :sandbox
97
-
98
- ##
99
- # :attr_reader:
100
- # Public: The Plaid::Transactions product accessor.
101
- subproduct :transactions
102
-
103
- ##
104
- # :attr_reader:
105
- # Public: The Plaid::Investments product accessor.
106
- subproduct :investments
107
-
108
- ##
109
- # :attr_reader:
110
- # Public: The Plaid::PaymentInitiation product accessor.
111
- subproduct :payment_initiation
112
-
113
- ##
114
- # :attr_reader:
115
- # Public: The Plaid::Webhooks endpoint accessor.
116
- subproduct :webhooks
117
-
118
- ##
119
- ## :attr_reader:
120
- ## Public: The Plaid::LinkToken endpoint accessor.
121
- subproduct :link_token
122
-
123
- # Public: Make a post request
124
- #
125
- # path - Path or URL to make the request to
126
- # payload - The payload or data to post
127
- #
128
- # Returns the resulting parsed JSON of the request
129
- def post(path, payload)
130
- @connection.post(path, payload).body
131
- end
132
-
133
- # Public: Make a post request with appended authentication fields
134
- #
135
- # path - Path or URL to make the request to
136
- # payload - The payload or data to post
137
- #
138
- # Returns the resulting parsed JSON of the request
139
- def post_with_auth(path, payload)
140
- @connection.post(
141
- path,
142
- payload.merge(client_id: @client_id, secret: @secret)
143
- ).body
144
- end
145
-
146
- # Public: Set Plaid defaults on the Faraday connection.
147
- #
148
- # builder - The Faraday builder object.
149
- def self.build_default_connection(builder)
150
- builder.options[:timeout] = Plaid::Middleware::NETWORK_TIMEOUT
151
- builder.headers = Plaid::Middleware::NETWORK_HEADERS
152
- builder.request :json
153
- builder.use Plaid::Middleware
154
- builder.response :json, content_type: /\bjson$/
155
- builder.adapter Faraday.default_adapter
156
- end
157
-
158
- protected
159
-
160
- # Internal: subproduct-generated methods depend on client method.
161
- def client
162
- self
163
- end
164
-
165
- # Internal: Gets the API hostname for given environment.
166
- #
167
- # env - The Symbol (:sandbox, :development, :production)
168
- #
169
- # Returns a String representing the environment URL.
170
- # Raises ArgumentError if environment is unknown.
171
- def api_host
172
- unless ENVIRONMENTS.include?(@env)
173
- raise ArgumentError,
174
- "Invalid value for env (#{@env.inspect}): must be one of " +
175
- ENVIRONMENTS.map(&:inspect) * ', '
176
- end
177
-
178
- "https://#{@env}.plaid.com"
179
- end
180
-
181
- # Internal: Initializes a new Plaid connection object via Faraday.
182
- #
183
- # Optionally takes a block to allow overriding the defaults.
184
- def create_connection
185
- @connection = Faraday.new(url: @api_host) do |builder|
186
- block_given? ? yield(builder) : Client.build_default_connection(builder)
187
- end
188
- end
189
- end
190
- end
data/lib/plaid/errors.rb DELETED
@@ -1,89 +0,0 @@
1
- module Plaid
2
- # Public: Base class for Plaid SDK errors
3
- class PlaidError < StandardError; end
4
-
5
- # Public: Returned on Plaid server or network issues
6
- class PlaidServerError < PlaidError; end
7
-
8
- # Public: Base class for any error returned by the API
9
- class PlaidAPIError < PlaidError
10
- attr_reader :error_type, :error_code, :error_message,
11
- :display_message, :request_id
12
-
13
- # Internal: Initialize an error with proper attributes.
14
- #
15
- # error_type - A broad categorization of the error.
16
- # error_code - The particular error code.
17
- # error_message - A developer-friendly representation of the error
18
- # message.
19
- # display_message - A user-friendly representation of the error message.
20
- # request_id - The ID of the request you made, can be used to
21
- # escalate problems.
22
- def initialize(error_type, error_code, error_message, display_message,
23
- request_id)
24
- @error_type = error_type
25
- @error_code = error_code
26
- @error_message = error_message
27
- @display_message = display_message
28
- @request_id = request_id
29
-
30
- super <<-TEXT
31
-
32
- Error Type : #{error_type}
33
- Error Code : #{error_code}
34
- Error Message : #{error_message}
35
- Display Message : #{display_message}
36
- Request ID : #{request_id}
37
- TEXT
38
- end
39
- end
40
-
41
- # Public: Returned when the request is malformed and cannot be processed.
42
- class InvalidRequestError < PlaidAPIError; end
43
-
44
- # Public: Returned when all fields are provided and are in the correct
45
- # format, but the values provided are incorrect in some way.
46
- class InvalidInputError < PlaidAPIError; end
47
-
48
- # Public: Returned when the request is valid but has exceeded established
49
- # rate limits.
50
- class RateLimitExceededError < PlaidAPIError; end
51
-
52
- # Public: Returned during planned maintenance windows and in response to API
53
- # internal server errors.
54
- class APIError < PlaidAPIError; end
55
-
56
- # Public: Indicates that information provided for the item (such as
57
- # credentials or MFA) may be invalid or that the item is not supported on
58
- # Plaid's platform.
59
- class ItemError < PlaidAPIError; end
60
-
61
- # Public: Returned when there are errors for the requested financial
62
- # institution.
63
- class InstitutionError < PlaidAPIError; end
64
-
65
- # Internal: A module that provides utilities for errors.
66
- module Error
67
- ERROR_TYPE_MAP = {
68
- 'INVALID_REQUEST' => Plaid::InvalidRequestError,
69
- 'INVALID_INPUT' => Plaid::InvalidInputError,
70
- 'RATE_LIMIT_EXCEEDED' => Plaid::RateLimitExceededError,
71
- 'API_ERROR' => Plaid::APIError,
72
- 'ITEM_ERROR' => Plaid::ItemError,
73
- 'INSTITUTION_ERROR' => Plaid::InstitutionError
74
- }.freeze
75
-
76
- # Internal: Map error_type to PlaidAPIError.
77
- #
78
- # Maps an error_type from an error HTTP response to an actual
79
- # PlaidAPIError class instance.
80
- #
81
- # error_type - The type of the error as indicated by the error response
82
- # body.
83
- #
84
- # Returns an error class mapped from error_type.
85
- def self.error_from_type(error_type)
86
- ERROR_TYPE_MAP[error_type] || Plaid::PlaidAPIError
87
- end
88
- end
89
- end
@@ -1,31 +0,0 @@
1
- require 'json'
2
- require 'net/http'
3
- require 'uri'
4
-
5
- require_relative 'version'
6
-
7
- module Plaid
8
- # Internal: The Faraday middleware used to catch errors.
9
- class Middleware < ::Faraday::Response::Middleware
10
- # Internal: Headers used for correct request and SDK tracking.
11
- NETWORK_HEADERS = { 'User-Agent' => "Plaid Ruby v#{Plaid::VERSION}",
12
- 'Content-Type' => 'application/json',
13
- 'Plaid-Version' => Plaid::API_VERSION }.freeze
14
-
15
- # Internal: Default read timeout for HTTP calls in seconds.
16
- NETWORK_TIMEOUT = 600
17
-
18
- def on_complete(env)
19
- return unless Faraday::Response::RaiseError::ClientErrorStatuses
20
- .include?(env[:status])
21
-
22
- error_class = Plaid::Error.error_from_type(env.body['error_type'])
23
-
24
- raise error_class.new(env.body['error_type'],
25
- env.body['error_code'],
26
- env.body['error_message'],
27
- env.body['display_message'],
28
- env.body['request_id'])
29
- end
30
- end
31
- end
data/lib/plaid/models.rb DELETED
@@ -1,2221 +0,0 @@
1
- require 'hashie'
2
-
3
- module Plaid
4
- module Models
5
- # Internal: Base model for all other models.
6
- class BaseModel < Hashie::Dash
7
- include Hashie::Extensions::Dash::IndifferentAccess
8
- include Hashie::Extensions::Dash::Coercion
9
-
10
- @ignored_properties = []
11
-
12
- def self.property_ignored?(property)
13
- if defined? @ignored_properties
14
- @ignored_properties.include?(property)
15
- else
16
- false
17
- end
18
- end
19
-
20
- # Internal: Be strict or forgiving depending on Plaid.relaxed_models
21
- # value.
22
- def assert_property_exists!(property)
23
- super unless Plaid.relaxed_models? ||
24
- self.class.property_ignored?(property)
25
- end
26
- end
27
-
28
- # Internal: Base API response.
29
- class BaseResponse < BaseModel
30
- ##
31
- # :attr_reader:
32
- # Public: The String request ID assigned by the API.
33
- property :request_id
34
- end
35
-
36
- # Internal: Base error.
37
- class BaseError < BaseModel
38
- ##
39
- # :attr_reader:
40
- # Public: The String broad categorization of the error. One of:
41
- # 'INVALID_REQUEST', 'INVALID_INPUT', 'RATE_LIMIT_EXCEEDED', 'API_ERROR',
42
- # or 'ITEM_ERROR'.
43
- property :error_type
44
-
45
- ##
46
- # :attr_reader:
47
- # Public: The particular String error code. Each error_type has a
48
- # specific set of error_codes.
49
- property :error_code
50
-
51
- ##
52
- # :attr_reader:
53
- # Public: A developer-friendly representation of the error message.
54
- property :error_message
55
-
56
- ##
57
- # :attr_reader:
58
- # Public: A user-friendly representation of the error message. nil if the
59
- # error is not related to user action.
60
- property :display_message
61
- end
62
-
63
- # Public: A representation of a cause.
64
- class Cause < BaseError
65
- ##
66
- # :attr_reader:
67
- # Public: The item ID.
68
- property :item_id
69
- end
70
-
71
- # Public: A representation of an error.
72
- class Error < BaseError
73
- ##
74
- # :attr_reader:
75
- # Public: A list of reasons explaining why the error happened.
76
- property :causes, coerce: Array[Cause]
77
- end
78
-
79
- # Public: A representation of a warning.
80
- class Warning < BaseModel
81
- ##
82
- # :attr_reader:
83
- # Public: The type of warning.
84
- property :warning_type
85
-
86
- ##
87
- # :attr_reader:
88
- # Public: The warning code.
89
- property :warning_code
90
-
91
- ##
92
- # :attr_reader:
93
- # Public: The underlying cause.
94
- property :cause, coerce: Cause
95
- end
96
-
97
- # Public: A representation of an item.
98
- class Item < BaseModel
99
- ##
100
- # :attr_reader:
101
- # Public: The Array with String products available for this item
102
- # (e.g. ["balance", "auth"]).
103
- property :available_products
104
-
105
- ##
106
- # :attr_reader:
107
- # Public: The Array with String products billed for this item
108
- # (e.g. ["identity", "transactions"]).
109
- property :billed_products
110
-
111
- ##
112
- # :attr_reader:
113
- # Public: The String error related to
114
- property :error, coerce: Error
115
-
116
- ##
117
- # :attr_reader:
118
- # Public: The String institution ID for this item.
119
- property :institution_id
120
-
121
- ##
122
- # :attr_reader:
123
- # Public: The String item ID.
124
- property :item_id
125
-
126
- ##
127
- # :attr_reader:
128
- # Public: The String update type.
129
- property :update_type
130
-
131
- ##
132
- # :attr_reader:
133
- # Public: The String webhook URL.
134
- property :webhook
135
-
136
- ##
137
- # :attr_reader:
138
- # Public: The String consent expiration timestamp (or nil)
139
- # (e.g. "2019-04-22T00:00:00Z").
140
- property :consent_expiration_time
141
-
142
- ##
143
- # :attr_reader:
144
- # Public: The String update type.
145
- property :update_type
146
- end
147
-
148
- # Public: A representation of Item webhook status
149
- class ItemStatusLastWebhook < BaseModel
150
- ##
151
- # :attr_reader:
152
- # Public: The String last code sent (or nil).
153
- # (e.g. "HISTORICAL_UPDATE").
154
- property :code_sent
155
-
156
- ##
157
- # :attr_reader:
158
- # Public: the String sent at date (or nil).
159
- # (e.g. "2019-04-22T00:00:00Z").
160
- property :sent_at
161
- end
162
-
163
- # Public: A representation of Item transaction update status
164
- class ItemStatusTransactions < BaseModel
165
- ##
166
- # :attr_reader:
167
- # Public: the String last failed update date (or nil).
168
- # (e.g. "2019-04-22T00:00:00Z").
169
- property :last_failed_update
170
-
171
- ##
172
- # :attr_reader:
173
- # Public: the String last successful update date (or nil).
174
- # (e.g. "2019-04-22T00:00:00Z").
175
- property :last_successful_update
176
- end
177
-
178
- # Public: A representation of Item investments update status
179
- class ItemStatusInvestments < BaseModel
180
- ##
181
- # :attr_reader:
182
- # Public: the String last failed update date (or nil).
183
- # (e.g. "2019-04-22T00:00:00Z").
184
- property :last_failed_update
185
-
186
- ##
187
- # :attr_reader:
188
- # Public: the String last successful update date (or nil).
189
- # (e.g. "2019-04-22T00:00:00Z").
190
- property :last_successful_update
191
- end
192
-
193
- # Public: A representation of Item status
194
- class ItemStatus < BaseModel
195
- ##
196
- # :attr_reader:
197
- # Public: The ItemStatusLastWebhook for this ItemStatus.
198
- property :last_webhook, coerce: ItemStatusLastWebhook
199
-
200
- ##
201
- # :attr_reader:
202
- # Public: The ItemStatusTransactions for this ItemStatus.
203
- property :transactions, coerce: ItemStatusTransactions
204
-
205
- ##
206
- # :attr_reader:
207
- # Public: The ItemStatusInvestments for this ItemStatus.
208
- property :investments, coerce: ItemStatusInvestments
209
- end
210
-
211
- # Public: A representation of account balances.
212
- class Balances < BaseModel
213
- ##
214
- # :attr_reader:
215
- # Public: The Numeric available balance (or nil).
216
- property :available
217
-
218
- ##
219
- # :attr_reader:
220
- # Public: The Numeric current balance (or nil).
221
- property :current
222
-
223
- ##
224
- # :attr_reader:
225
- # Public: The Numeric limit (or nil).
226
- property :limit
227
-
228
- ##
229
- # :attr_reader:
230
- # Public: The String ISO currency code for the amount
231
- property :iso_currency_code
232
-
233
- ##
234
- # :attr_reader:
235
- # Public: The String unofficial currency code for the amount
236
- property :unofficial_currency_code
237
- end
238
-
239
- # Public: A representation of an account.
240
- class Account < BaseModel
241
- ##
242
- # :attr_reader:
243
- # Public: The String account ID, e.g.
244
- # "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv".
245
- property :account_id
246
-
247
- ##
248
- # :attr_reader:
249
- # Public: Balances for this account.
250
- property :balances, coerce: Balances
251
-
252
- ##
253
- # :attr_reader:
254
- # Public: The String mask, e.g. "0000".
255
- property :mask
256
-
257
- ##
258
- # :attr_reader:
259
- # Public: The String account name, e.g. "Plaid Checking".
260
- property :name
261
-
262
- ##
263
- # :attr_reader:
264
- # Public: The String official account name, e.g. "Plaid Gold Checking".
265
- property :official_name
266
-
267
- ##
268
- # :attr_reader:
269
- # Public: The String type, e.g. "depository".
270
- property :type
271
-
272
- ##
273
- # :attr_reader:
274
- # Public: The String subtype, e.g. "checking".
275
- property :subtype
276
-
277
- ##
278
- # :attr_reader:
279
- # Public: The String verification status,
280
- # e.g "manually_verified" (optional).
281
- property :verification_status
282
- end
283
-
284
- # Public: A representation of an ACH account number.
285
- class NumberACH < BaseModel
286
- ##
287
- # :attr_reader:
288
- # Public: The String account number. E.g. "1111222233330000".
289
- property :account
290
-
291
- ##
292
- # :attr_reader:
293
- # Public: The String account ID. E.g.
294
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
295
- property :account_id
296
-
297
- ##
298
- # :attr_reader:
299
- # Public: The String routing number. E.g. "011401533".
300
- property :routing
301
-
302
- ##
303
- # :attr_reader:
304
- # Public: The String wire routing number. E.g. "021000021".
305
- property :wire_routing
306
- end
307
-
308
- # Public: A representation of an EFT (Canadian) account number.
309
- class NumberEFT < BaseModel
310
- ##
311
- # :attr_reader:
312
- # Public: The String account number. E.g. "1111222233330000".
313
- property :account
314
-
315
- ##
316
- # :attr_reader:
317
- # Public: The String account ID. E.g.
318
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
319
- property :account_id
320
-
321
- ##
322
- # :attr_reader:
323
- # Public: The String branch number. E.g. "021".
324
- property :branch
325
-
326
- ##
327
- # :attr_reader:
328
- # Public: The String institution number. E.g. "01140".
329
- property :institution
330
- end
331
-
332
- # Public: A representation of an International account number.
333
- class NumberInternational < BaseModel
334
- ##
335
- # :attr_reader:
336
- # Public: The String account ID. E.g.
337
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
338
- property :account_id
339
-
340
- ##
341
- # :attr_reader:
342
- # Public: The String International Bank Account Number (IBAN). E.g.
343
- # "GB33BUKB20201555555555".
344
- property :iban
345
-
346
- ##
347
- # :attr_reader:
348
- # Public: The String Bank Identifier Code (BIC). E.g. "BUKBGB22".
349
- property :bic
350
- end
351
-
352
- # Public: A representation of a BACS (British) account number.
353
- class NumberBACS < BaseModel
354
- ##
355
- # :attr_reader:
356
- # Public: The String account ID. E.g.
357
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
358
- property :account_id
359
-
360
- ##
361
- # :attr_reader:
362
- # Public: The String account number. E.g. "66374958".
363
- property :account
364
-
365
- ##
366
- # :attr_reader:
367
- # Public: The String sort code. E.g. "089999".
368
- property :sort_code
369
- end
370
-
371
- # Public: A representation of a Auth Numbers response
372
- class Numbers < BaseModel
373
- ##
374
- # :attr_reader:
375
- # Public: The Array of NumberACH.
376
- property :ach, coerce: Array[NumberACH]
377
-
378
- ##
379
- # :attr_reader:
380
- # Public: The Array of NumberEFT.
381
- property :eft, coerce: Array[NumberEFT]
382
-
383
- ##
384
- # :attr_reader:
385
- # Public: The Array of NumberInternational.
386
- property :international, coerce: Array[NumberInternational]
387
-
388
- ##
389
- # :attr_reader:
390
- # Public: The Array of NumberBACS.
391
- property :bacs, coerce: Array[NumberBACS]
392
- end
393
-
394
- # Public: A representation of a transaction category.
395
- class Category < BaseModel
396
- ##
397
- # :attr_reader:
398
- # Public: The String category ID. E.g. "10000000".
399
- property :category_id
400
-
401
- ##
402
- # :attr_reader:
403
- # Public: The Array of Strings category hierarchy.
404
- # E.g. ["Recreation", "Arts & Entertainment", "Circuses and Carnivals"].
405
- property :hierarchy
406
-
407
- ##
408
- # :attr_reader:
409
- # Public: The String category group. E.g. "place".
410
- property :group
411
- end
412
-
413
- # Public: A representation of a single Credit Details APR.
414
- class CreditDetailsAPR < BaseModel
415
- ##
416
- # :attr_reader:
417
- # Public: The Numeric APR (e.g. 0.125).
418
- property :apr
419
-
420
- ##
421
- # :attr_reader:
422
- # Public: The Numeric balance subject to APR (e.g. 1200).
423
- property :balance_subject_to_apr
424
-
425
- ##
426
- # :attr_reader:
427
- # Public: The Numeric interest charge amount (e.g. 150).
428
- property :interest_charge_amount
429
- end
430
-
431
- # Public: A representation of Credit Details APRs data.
432
- class CreditDetailsAPRs < BaseModel
433
- ##
434
- # :attr_reader:
435
- # Public: Balance transfers APR
436
- property :balance_transfers, coerce: CreditDetailsAPR
437
-
438
- ##
439
- # :attr_reader:
440
- # Public: Cash advances APR
441
- property :cash_advances, coerce: CreditDetailsAPR
442
-
443
- ##
444
- # :attr_reader:
445
- # Public: Purchases APR
446
- property :purchases, coerce: CreditDetailsAPR
447
- end
448
-
449
- # Public: A representation of Credit Details data.
450
- class CreditDetails < BaseModel
451
- ##
452
- # :attr_reader:
453
- # Public: The String account ID. E.g.
454
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
455
- property :account_id
456
-
457
- ##
458
- # :attr_reader:
459
- # Public: The APRs.
460
- property :aprs, coerce: CreditDetailsAPRs
461
-
462
- ##
463
- # :attr_reader:
464
- # Public: The Numeric last payment amount (e.g. 875).
465
- property :last_payment_amount
466
-
467
- ##
468
- # :attr_reader:
469
- # Public: The String last payment date. E.g. "2016-09-13T00:00:00Z".
470
- property :last_payment_date
471
-
472
- ##
473
- # :attr_reader:
474
- # Public: The Numeric last statement balance (e.g. 3450).
475
- property :last_statement_balance
476
-
477
- ##
478
- # :attr_reader:
479
- # Public: The String last statement date. E.g. "2016-10-01T00:00:00Z".
480
- property :last_statement_date
481
-
482
- ##
483
- # :attr_reader:
484
- # Public: The Numeric minimum payment amount (e.g. 800).
485
- property :minimum_payment_amount
486
-
487
- ##
488
- # :attr_reader:
489
- # Public: The String next bill due date. E.g. "2016-10-15T00:00:00Z".
490
- property :next_bill_due_date
491
- end
492
-
493
- # Public: A representation of Identity address details.
494
- class IdentityAddressData < BaseModel
495
- ##
496
- # :attr_reader:
497
- # Public: The String street name.
498
- property :street
499
-
500
- ##
501
- # :attr_reader:
502
- # Public: The String name.
503
- property :city
504
-
505
- ##
506
- # :attr_reader:
507
- # Public: The String region or state name.
508
- property :region
509
-
510
- ##
511
- # :attr_reader:
512
- # Public: The String postal code.
513
- property :postal_code
514
-
515
- ##
516
- # :attr_reader:
517
- # Public: The String country code.
518
- property :country
519
- end
520
-
521
- # Public: A representation of Identity address data.
522
- class IdentityAddress < BaseModel
523
- ##
524
- # :attr_reader:
525
- # Public: The Boolean primary flag (true if it's the primary address).
526
- property :primary
527
-
528
- ##
529
- # :attr_reader:
530
- # Public: The address data.
531
- property :data, coerce: IdentityAddressData
532
- end
533
-
534
- # Public: A representation of Identity email data.
535
- class IdentityEmail < BaseModel
536
- ##
537
- # :attr_reader:
538
- # Public: The String data, i.e. the address itself. E.g.
539
- # "accountholder0@example.com".
540
- property :data
541
-
542
- ##
543
- # :attr_reader:
544
- # Public: The Boolean primary flag.
545
- property :primary
546
-
547
- ##
548
- # :attr_reader:
549
- # Public: The String type. E.g. "primary", or "secondary", or "other".
550
- property :type
551
- end
552
-
553
- # Public: A representation of Identity phone number data.
554
- class IdentityPhoneNumber < BaseModel
555
- ##
556
- # :attr_reader:
557
- # Public: The String data, i.e. the number itself. E.g.
558
- # "4673956022".
559
- property :data
560
-
561
- ##
562
- # :attr_reader:
563
- # Public: The Boolean primary flag.
564
- property :primary
565
-
566
- ##
567
- # :attr_reader:
568
- # Public: The String type. E.g. "home", or "work", or "mobile1".
569
- property :type
570
- end
571
-
572
- # Public: A representation of Identity data.
573
- class Identity < BaseModel
574
- ##
575
- # :attr_reader:
576
- # Public: Addresses: Array of IdentityAddress.
577
- property :addresses, coerce: Array[IdentityAddress]
578
-
579
- ##
580
- # :attr_reader:
581
- # Public: Emails: Array of IdentityEmail.
582
- property :emails, coerce: Array[IdentityEmail]
583
-
584
- ##
585
- # :attr_reader:
586
- # Public: The Array of String names. E.g. ["John Doe", "Ronald McDonald"].
587
- property :names
588
-
589
- ##
590
- # :attr_reader:
591
- # Public: Phone numbers: Array of IdentityPhoneNumber.
592
- property :phone_numbers, coerce: Array[IdentityPhoneNumber]
593
- end
594
-
595
- # Public: A representation of Income Stream data.
596
- class IncomeStream < BaseModel
597
- ##
598
- # :attr_reader:
599
- # Public: The Numeric monthly income associated with the income stream.
600
- property :monthly_income
601
-
602
- ##
603
- # :attr_reader:
604
- # Public: The Numeric representation of our confidence in the income data
605
- # associated with this particular income stream, with 0 being the lowest
606
- # confidence and 1 being the highest.
607
- property :confidence
608
-
609
- ##
610
- # :attr_reader:
611
- # Public: The Numeric extent of data found for this income stream.
612
- property :days
613
-
614
- ##
615
- # :attr_reader:
616
- # Public: The String name of the entity associated with this income
617
- # stream.
618
- property :name
619
- end
620
-
621
- # Public: A representation of an account with owners
622
- class AccountWithOwners < Account
623
- ##
624
- # :attr_reader:
625
- # Public: The Array of owners.
626
- property :owners, coerce: Array[Identity]
627
- end
628
-
629
- # Public: A representation of Income data.
630
- class Income < BaseModel
631
- ##
632
- # :attr_reader:
633
- # Public: An Array of IncomeStream with detailed information.
634
- property :income_streams, coerce: Array[IncomeStream]
635
-
636
- ##
637
- # :attr_reader:
638
- # Public: The Numeric last year income, i.e. the sum of the Item's
639
- # income over the past 365 days. If Plaid has less than 365 days of data
640
- # this will be less than a full year's income.
641
- property :last_year_income
642
-
643
- ##
644
- # :attr_reader:
645
- # Public: The Numeric last_year_income interpolated to value before
646
- # taxes. This is the minimum pre-tax salary that assumes a filing status
647
- # of single with zero dependents.
648
- property :last_year_income_before_tax
649
-
650
- ##
651
- # :attr_reader:
652
- # Public: The Numeric income extrapolated over a year based on current,
653
- # active income streams. Income streams become inactive if they have not
654
- # recurred for more than two cycles. For example, if a weekly paycheck
655
- # hasn't been seen for the past two weeks, it is no longer active.
656
- property :projected_yearly_income
657
-
658
- ##
659
- # :attr_reader:
660
- # Public: The Numeric projected_yearly_income interpolated to value
661
- # before taxes. This is the minimum pre-tax salary that assumes a filing
662
- # status of single with zero dependents.
663
- property :projected_yearly_income_before_tax
664
-
665
- ##
666
- # :attr_reader:
667
- # Public: The Numeric max number of income streams present at the same
668
- # time over the past 365 days.
669
- property :max_number_of_overlapping_income_streams
670
-
671
- ##
672
- # :attr_reader:
673
- # Public: The Numeric total number of distinct income streams received
674
- # over the past 365 days.
675
- property :number_of_income_streams
676
- end
677
-
678
- # Public: A representation of an institution login credential.
679
- class InstitutionCredential < BaseModel
680
- @ignored_properties = ['flexible_input_spec']
681
-
682
- ##
683
- # :attr_reader:
684
- # Public: The String label. E.g. "User ID".
685
- property :label
686
-
687
- ##
688
- # :attr_reader:
689
- # Public: The String name. E.g. "username".
690
- property :name
691
-
692
- ##
693
- # :attr_reader:
694
- # Public: The String type. E.g. "text", or "password".
695
- property :type
696
- end
697
-
698
- # Public: A representation of Institution status breakdown.
699
- class InstitutionStatusBreakdown < BaseModel
700
- ##
701
- # :attr_reader:
702
- # Public: The Numeric success percentage.
703
- # (e.g. 0.970)
704
- property :success
705
-
706
- ##
707
- # :attr_reader:
708
- # Public: The Numeric Plaid error percentage.
709
- # (e.g. 0.010)
710
- property :error_plaid
711
-
712
- ##
713
- # :attr_reader:
714
- # Public: The Numeric Institution error percentage.
715
- # (e.g. 0.020)
716
- property :error_institution
717
- end
718
-
719
- # Public: A representation of Institution item logins status.
720
- class InstitutionStatusItemLogins < BaseModel
721
- ##
722
- # :attr_reader:
723
- # Public: The String last status change date.
724
- # (e.g. "2019-04-22T20:52:00Z")
725
- property :last_status_change
726
-
727
- ##
728
- # :attr_reader:
729
- # Public: The String status.
730
- # (e.g. one of "HEALTHY"|"DEGRADED"|"DOWN")
731
- property :status
732
-
733
- ##
734
- # :attr_reader:
735
- # Public: The breakdown for this Institution status.
736
- property :breakdown, coerce: InstitutionStatusBreakdown
737
- end
738
-
739
- # Public: A representation of Institution status.
740
- class InstitutionStatus < BaseModel
741
- ##
742
- # :attr_reader:
743
- # Public: The Item logins status for this InstitutionStatus.
744
- property :item_logins, coerce: InstitutionStatusItemLogins
745
- end
746
-
747
- # Public: A representation of standing order metadata for an institution.
748
- class StandingOrderMetadata < BaseModel
749
- ##
750
- # :attr_reader:
751
- # Public: The Boolean flag indicating if the institution supports
752
- # end date for standing orders.
753
- property :supports_standing_order_end_date
754
-
755
- ##
756
- # :attr_reader:
757
- # Public: The Boolean flag indicating if the institution supports
758
- # negative execution days for standing orders.
759
- property :supports_standing_order_negative_execution_days
760
-
761
- ##
762
- # :attr_reader:
763
- # Public: The Array of valid standing order intervals for
764
- # this institution.
765
- # E.g. ["WEEKLY", "MONTHLY"].
766
- property :valid_standing_order_intervals
767
- end
768
-
769
- # Public: A representation of an institution's payment initiation metadata.
770
- class InstitutionPaymentInitiationMetadata < BaseModel
771
- ##
772
- # :attr_reader:
773
- # Public: The map of maximum payment amount per currency for this
774
- # institution.
775
- # E.g. {"GBP"=>"1000000"}.
776
- property :maximum_payment_amount
777
-
778
- ##
779
- # :attr_reader:
780
- # Public: The standing order metadata for this institution.
781
- property :standing_order_metadata, coerce: StandingOrderMetadata
782
-
783
- ##
784
- # :attr_reader:
785
- # Public: The Boolean flag indicating if the institution supports
786
- # international payments.
787
- property :supports_international_payments
788
-
789
- ##
790
- # :attr_reader:
791
- # Public: The Boolean flag indicating if the institution supports
792
- # refund details.
793
- property :supports_refund_details
794
- end
795
-
796
- # Public: A representation of Institution.
797
- class Institution < BaseModel
798
- @ignored_properties = ['input_spec']
799
-
800
- ##
801
- # :attr_reader:
802
- # Public: The Array of InstitutionCredential, presenting information on
803
- # login credentials used for the institution.
804
- property :credentials, coerce: Array[InstitutionCredential]
805
-
806
- ##
807
- # :attr_reader:
808
- # Public: The Boolean flag indicating if the institution uses MFA.
809
- property :has_mfa
810
-
811
- ##
812
- # :attr_reader:
813
- # Public: The String reflecting the MFA code type ("numeric" /
814
- # "alphanumeric")
815
- property :mfa_code_type
816
-
817
- ##
818
- # :attr_reader:
819
- # Public: The String institution ID (e.g. "ins_109512").
820
- property :institution_id
821
-
822
- ##
823
- # :attr_reader:
824
- # Public: The String institution name (e.g. "Houndstooth Bank").
825
- property :name
826
-
827
- ##
828
- # :attr_reader:
829
- # Public: The Array of String MFA types.
830
- # E.g. ["code", "list", "questions", "selections"].
831
- property :mfa
832
-
833
- ##
834
- # :attr_reader:
835
- # Public: The Array of String product names supported by this institution.
836
- # E.g. ["auth", "balance", "identity", "transactions"].
837
- property :products
838
-
839
- ##
840
- # :attr_reader:
841
- # Public: The Array of String country codes supported by this institution.
842
- # E.g. ["US", "GB"].
843
- property :country_codes
844
-
845
- ##
846
- # :attr_reader:
847
- # Public: The String primary color for this institution (e.g. "#095aa6").
848
- property :primary_color
849
-
850
- ##
851
- # :attr_reader:
852
- # Public: The String base 64 encoded logo for this institution.
853
- property :logo
854
-
855
- ##
856
- # :attr_reader:
857
- # Public: The String base 64 encoded url for this institution
858
- # E.g. "https://www.plaid.com").
859
- property :url
860
-
861
- ##
862
- # :attr_reader:
863
- # Public: The Status for this Institution (or nil).
864
- property :status, coerce: InstitutionStatus
865
-
866
- ##
867
- # :attr_reader:
868
- # Public: The Array of String country codes supported by this institution.
869
- property :country_codes
870
-
871
- ##
872
- # :attr_reader:
873
- # Public: The array of routing numbers associated with this institution.
874
- property :routing_numbers
875
-
876
- ##
877
- # :attr_reader:
878
- # Public: Indicates that the institution has an OAuth login flow.
879
- property :oauth
880
-
881
- ##
882
- # :attr_reader:
883
- # Public: Specifies metadata related to the payment_initiation product
884
- # (or nil).
885
- property :payment_initiation_metadata,
886
- coerce: InstitutionPaymentInitiationMetadata
887
- end
888
-
889
- module MFA
890
- # Public: A representation of an MFA device.
891
- class Device < BaseModel
892
- ##
893
- # :attr_reader:
894
- # Public: The String message related to sending code to the device.
895
- property :display_message
896
- end
897
-
898
- # Public: A representation of a single element in a device list.
899
- class DeviceListElement < BaseModel
900
- ##
901
- # :attr_reader:
902
- # Public: The String device ID.
903
- property :device_id
904
-
905
- ##
906
- # :attr_reader:
907
- # Public: The String device mask.
908
- property :mask
909
-
910
- ##
911
- # :attr_reader:
912
- # Public: The String device type.
913
- property :type
914
- end
915
-
916
- # Public: A representation of MFA selection.
917
- class Selection < BaseModel
918
- ##
919
- # :attr_reader:
920
- # Public: The String question.
921
- property :question
922
-
923
- ##
924
- # :attr_reader:
925
- # Public: The Array of String answers.
926
- property :answers
927
- end
928
- end
929
-
930
- # Public: A representation of Transaction location.
931
- class TransactionLocation < BaseModel
932
- ##
933
- # :attr_reader:
934
- # Public: The String address (or nil).
935
- property :address
936
-
937
- ##
938
- # :attr_reader:
939
- # Public: The String city name (or nil).
940
- property :city
941
-
942
- ##
943
- # :attr_reader:
944
- # Public: The Numeric latitude of the place (or nil).
945
- property :lat
946
-
947
- ##
948
- # :attr_reader:
949
- # Public: The Numeric longitude of the place (or nil).
950
- property :lon
951
-
952
- ##
953
- # :attr_reader:
954
- # Public: The String region or state name (or nil).
955
- property :region
956
-
957
- ##
958
- # :attr_reader:
959
- # Public: The String store number (or nil).
960
- property :store_number
961
-
962
- ##
963
- # :attr_reader:
964
- # Public: The String postal code (or nil).
965
- property :postal_code
966
-
967
- ##
968
- # :attr_reader:
969
- # Public: The country code (or nil).
970
- property :country
971
- end
972
-
973
- # Public: A representation of Transaction Payment meta information.
974
- class TransactionPaymentMeta < BaseModel
975
- ##
976
- # :attr_reader:
977
- property :by_order_of
978
- ##
979
- # :attr_reader:
980
- property :ppd_id
981
- ##
982
- # :attr_reader:
983
- property :payee
984
- ##
985
- # :attr_reader:
986
- property :payer
987
- ##
988
- # :attr_reader:
989
- property :payment_method
990
- ##
991
- # :attr_reader:
992
- property :payment_processor
993
- ##
994
- # :attr_reader:
995
- property :reason
996
- ##
997
- # :attr_reader:
998
- property :reference_number
999
- end
1000
-
1001
- # Public: A representation of Transaction.
1002
- class Transaction < BaseModel
1003
- ##
1004
- # :attr_reader:
1005
- # Public: The String transaction ID.
1006
- property :transaction_id
1007
-
1008
- ##
1009
- # :attr_reader:
1010
- # Public: The String account ID.
1011
- property :account_id
1012
-
1013
- ##
1014
- # :attr_reader:
1015
- # Public: The String account owner (or nil).
1016
- property :account_owner
1017
-
1018
- ##
1019
- # :attr_reader:
1020
- # Public: The Numeric amount (or nil).
1021
- property :amount
1022
-
1023
- ##
1024
- # :attr_reader:
1025
- # Public: The Array of String category (or nil).
1026
- # E.g. ["Payment", "Credit Card"].
1027
- property :category
1028
-
1029
- ##
1030
- # :attr_reader:
1031
- # Public: The String category_id (or nil).
1032
- # E.g. "16001000".
1033
- property :category_id
1034
-
1035
- ##
1036
- # :attr_reader:
1037
- # Public: The String transaction date. E.g. "2017-01-01".
1038
- property :date
1039
-
1040
- ##
1041
- # :attr_reader:
1042
- # Public: The location where transaction occurred (TransactionLocation).
1043
- property :location, coerce: TransactionLocation
1044
-
1045
- ##
1046
- # :attr_reader:
1047
- # Public: The String merchant name (or nil).
1048
- # E.g. "Burger King".
1049
- property :merchant_name
1050
-
1051
- ##
1052
- # :attr_reader:
1053
- # Public: The String transaction name (or nil).
1054
- # E.g. "CREDIT CARD 3333 PAYMENT *//".
1055
- property :name
1056
-
1057
- ##
1058
- # :attr_reader:
1059
- # Public: The String original description (or nil).
1060
- property :original_description
1061
-
1062
- ##
1063
- # :attr_reader:
1064
- # Public: The payment meta information (TransactionPaymentMeta).
1065
- property :payment_meta, coerce: TransactionPaymentMeta
1066
-
1067
- ##
1068
- # :attr_reader:
1069
- # Public: The Boolean pending flag (or nil).
1070
- property :pending
1071
-
1072
- ##
1073
- # :attr_reader:
1074
- # Public: The String pending transaction ID (or nil).
1075
- property :pending_transaction_id
1076
-
1077
- ##
1078
- # :attr_reader:
1079
- # Public: The String transaction type (or nil). E.g. "special", or
1080
- # "place".
1081
- property :transaction_type
1082
-
1083
- ##
1084
- # :attr_reader:
1085
- # Public: The String ISO currency code for the amount
1086
- property :iso_currency_code
1087
-
1088
- ##
1089
- # :attr_reader:
1090
- # Public: The String unofficial currency code for the amount
1091
- property :unofficial_currency_code
1092
-
1093
- ##
1094
- # :attr_reader:
1095
- # Public: The String channel used to make a payment, e.g.
1096
- # "online", "in store", or "other".
1097
- property :payment_channel
1098
-
1099
- ##
1100
- # :attr_reader:
1101
- # Public: The String date that the transaction was authorized,
1102
- # e.g. "2017-01-01".
1103
- property :authorized_date
1104
-
1105
- ##
1106
- # :attr_reader:
1107
- # Public: The String transaction code, e.g. "direct debit".
1108
- property :transaction_code
1109
- end
1110
-
1111
- # Public: A representation of an InvestmentTransaction in an investment
1112
- # account.
1113
- class InvestmentTransaction < BaseModel
1114
- ##
1115
- # :attr_reader:
1116
- # Public: The String investment transaction ID.
1117
- property :investment_transaction_id
1118
-
1119
- ##
1120
- # :attr_reader:
1121
- # Public: The String account ID.
1122
- property :account_id
1123
-
1124
- ##
1125
- # :attr_reader:
1126
- # Public: The String security ID.
1127
- property :security_id
1128
-
1129
- ##
1130
- # :attr_reader:
1131
- # Public: The String transaction date. E.g. "2017-01-01".
1132
- property :date
1133
-
1134
- ##
1135
- # :attr_reader:
1136
- # Public: The String transaction name (or nil).
1137
- # E.g. "CREDIT CARD 3333 PAYMENT *//".
1138
- property :name
1139
-
1140
- ##
1141
- # :attr_reader:
1142
- # Public: The Numeric quantity of the security involved (if applicable).
1143
- property :quantity
1144
-
1145
- ##
1146
- # :attr_reader:
1147
- # Public: The Numeric amount (or nil).
1148
- property :amount
1149
-
1150
- ##
1151
- # :attr_reader:
1152
- # Public: The Numeric price of the security that was used for the trade
1153
- # (if applicable).
1154
- property :price
1155
-
1156
- ##
1157
- # :attr_reader:
1158
- # Public: The Numeric fee amount.
1159
- property :fees
1160
-
1161
- ##
1162
- # :attr_reader:
1163
- # Public: The String transaction type (or nil). E.g. "buy" or "sell".
1164
- property :type
1165
-
1166
- ##
1167
- # :attr_reader:
1168
- # Public: The String transaction type (or nil). E.g. "buy" or "sell".
1169
- property :subtype
1170
-
1171
- ##
1172
- # :attr_reader:
1173
- # Public: The ISO currency code of the transaction, either USD or CAD.
1174
- # Always nil if unofficial_currency_code is non-nil.
1175
- property :iso_currency_code
1176
-
1177
- ##
1178
- # :attr_reader:
1179
- # Public: The unofficial currency code associated with the transaction.
1180
- # Always nil if iso_currency_code is non-nil.
1181
- property :unofficial_currency_code
1182
-
1183
- ##
1184
- # :attr_reader:
1185
- # Public: Present if the transaction class is cancel, and indicates the
1186
- # ID of the transaction which was cancelled.
1187
- property :cancel_transaction_id
1188
- end
1189
-
1190
- # Public: A representation of a Holding in an investment account.
1191
- class Holding < BaseModel
1192
- ##
1193
- # :attr_reader:
1194
- # Public: The String account ID.
1195
- property :account_id
1196
-
1197
- ##
1198
- # :attr_reader:
1199
- # Public: The String security ID.
1200
- property :security_id
1201
-
1202
- ##
1203
- # :attr_reader:
1204
- # Public: The Numeric value of the holding (price * quantity) as reported
1205
- # by the institution.
1206
- property :institution_value
1207
-
1208
- ##
1209
- # :attr_reader:
1210
- # Public: The Numeric price of the holding as reported by the institution.
1211
- property :institution_price
1212
-
1213
- ##
1214
- # :attr_reader:
1215
- # Public: The Numeric quantity.
1216
- property :quantity
1217
-
1218
- ##
1219
- # :attr_reader:
1220
- # Public: The String date when the price reported by the institution was
1221
- # current. E.g. "2017-01-01".
1222
- property :institution_price_as_of
1223
-
1224
- ##
1225
- # :attr_reader:
1226
- # Public: The Numeric cost basis.
1227
- property :cost_basis
1228
-
1229
- ##
1230
- # :attr_reader:
1231
- # Public: The ISO currency code of the holding, either USD or CAD.
1232
- # Always nil if unofficial_currency_code is non-nil.
1233
- property :iso_currency_code
1234
-
1235
- ##
1236
- # :attr_reader:
1237
- # Public: The unofficial currency code associated with the holding.
1238
- # Always nil if iso_currency_code is non-nil.
1239
- property :unofficial_currency_code
1240
- end
1241
-
1242
- # Public: A representation of a Security.
1243
- class Security < BaseModel
1244
- ##
1245
- # :attr_reader:
1246
- # Public: The String security ID.
1247
- property :security_id
1248
-
1249
- ##
1250
- # :attr_reader:
1251
- # Public: The String CUSIP identitfier of this security.
1252
- property :cusip
1253
-
1254
- ##
1255
- # :attr_reader:
1256
- # Public: The String SEDOL identifier of this security.
1257
- property :sedol
1258
-
1259
- ##
1260
- # :attr_reader:
1261
- # Public: The String ISIN identifier of this security.
1262
- property :isin
1263
-
1264
- ##
1265
- # :attr_reader:
1266
- # Public: The String ID of this security as reported by the institution.
1267
- property :institution_security_id
1268
-
1269
- ##
1270
- # :attr_reader:
1271
- # Public: The String institution ID (if institution_security_id is set).
1272
- property :institution_id
1273
-
1274
- ##
1275
- # :attr_reader:
1276
- # Public: The String security ID of the proxied security.
1277
- property :proxy_security_id
1278
-
1279
- ##
1280
- # :attr_reader:
1281
- # Public: The String security name.
1282
- property :name
1283
-
1284
- ##
1285
- # :attr_reader:
1286
- # Public: The String ticker symbol.
1287
- property :ticker_symbol
1288
-
1289
- ##
1290
- # :attr_reader:
1291
- # Public: The Boolean flag indicating whether this security is
1292
- # cash-equivalent.
1293
- property :is_cash_equivalent
1294
-
1295
- ##
1296
- # :attr_reader:
1297
- # Public: The String Type.
1298
- property :type
1299
-
1300
- ##
1301
- # :attr_reader:
1302
- # Public: The Numeric close price.
1303
- property :close_price
1304
-
1305
- ##
1306
- # :attr_reader:
1307
- # Public: The String date when the close price was current.
1308
- property :close_price_as_of
1309
-
1310
- ##
1311
- # :attr_reader:
1312
- # Public: The ISO currency code of the security, either USD or CAD.
1313
- # Always nil if unofficial_currency_code is non-nil.
1314
- property :iso_currency_code
1315
-
1316
- ##
1317
- # :attr_reader:
1318
- # Public: The unofficial currency code associated with the security.
1319
- # Always nil if iso_currency_code is non-nil.
1320
- property :unofficial_currency_code
1321
- end
1322
-
1323
- # Public: A representation of an asset report owner.
1324
- class AssetReportOwner < BaseModel
1325
- ##
1326
- # :attr_reader:
1327
- # Public: A list of names associated with the account by the financial
1328
- # institution.
1329
- property :names, coerce: Array[String]
1330
-
1331
- ##
1332
- # :attr_reader:
1333
- # Public: A list of phone numbers associated with the account by the
1334
- # financial institution; see IdentityPhoneNumber number object for
1335
- # fields.
1336
- property :phone_numbers, coerce: Array[IdentityPhoneNumber]
1337
-
1338
- ##
1339
- # :attr_reader:
1340
- # Public: A list of emails associated with the account by the financial
1341
- # institution; see IdentityEmail object for fields.
1342
- property :emails, coerce: Array[IdentityEmail]
1343
-
1344
- ##
1345
- # :attr_reader:
1346
- # Public: Data about the various addresses associated with the account
1347
- # by the financial institution; see IdentityAddress object for fields.
1348
- property :addresses, coerce: Array[IdentityAddress]
1349
- end
1350
-
1351
- # Public: A representation of an asset report balance.
1352
- class AssetReportBalance < BaseModel
1353
- ##
1354
- # :attr_reader:
1355
- # Public: The available balance as reported by the financial institution.
1356
- # This is usually, but not always, the current balance less any
1357
- # outstanding holds or debits that have not yet posted to the account.
1358
- property :available
1359
-
1360
- ##
1361
- # :attr_reader:
1362
- # Public: The total amount of funds in the account.
1363
- property :current
1364
-
1365
- ##
1366
- # :attr_reader:
1367
- # Public: The ISO currency code of the transaction, either USD or CAD.
1368
- # Always nil if unofficial_currency_code is non-nil.
1369
- property :iso_currency_code
1370
-
1371
- ##
1372
- # :attr_reader:
1373
- # Public: The unofficial currency code associated with the transaction.
1374
- # Always nil if iso_currency_code is non-nil.
1375
- property :unofficial_currency_code
1376
- end
1377
-
1378
- # Public: A representation of an asset report historical balance.
1379
- class AssetReportHistoricalBalance < BaseModel
1380
- ##
1381
- # :attr_reader:
1382
- # Public: The date of the calculated historical balance.
1383
- property :date
1384
-
1385
- ##
1386
- # :attr_reader:
1387
- # Public: The total amount of funds in the account, calculated from the
1388
- # current balance in the balance object by subtracting inflows and adding
1389
- # back outflows according to the posted date of each.
1390
- property :current
1391
-
1392
- ##
1393
- # :attr_reader:
1394
- # Public: The ISO currency code of the transaction, either USD or CAD.
1395
- # Always nil if unofficial_currency_code is non-nil.
1396
- property :iso_currency_code
1397
-
1398
- ##
1399
- # :attr_reader:
1400
- # Public: The unofficial currency code associated with the transaction.
1401
- # Always nil if iso_currency_code is non-nil.
1402
- property :unofficial_currency_code
1403
- end
1404
-
1405
- # Public: A representation of an asset report transaction.
1406
- class AssetReportTransaction < BaseModel
1407
- ##
1408
- # :attr_reader:
1409
- # Public: Plaid's unique identifier for the account.
1410
- property :account_id
1411
-
1412
- ##
1413
- # :attr_reader:
1414
- # Public: Plaid's unique identifier for the transaction.
1415
- property :transaction_id
1416
-
1417
- ##
1418
- # :attr_reader:
1419
- # Public: For pending transactions, Plaid returns the date the
1420
- # transaction occurred; for posted transactions, Plaid returns the date
1421
- # the transaction posts; both dates are returned in an ISO 8601 format
1422
- # (YYYY-MM-DD).
1423
- property :date
1424
-
1425
- ##
1426
- # :attr_reader:
1427
- # Public: The string returned by the financial institution to describe
1428
- # the transaction.
1429
- property :original_description
1430
-
1431
- ##
1432
- # :attr_reader:
1433
- # Public: When true, identifies the transaction as pending or unsettled;
1434
- # pending transaction details (description, amount) may change before
1435
- # they are settled.
1436
- property :pending
1437
-
1438
- ##
1439
- # :attr_reader:
1440
- # Public: The settled dollar value; positive values when money moves out
1441
- # of the account, negative values when money moves in.
1442
- property :amount
1443
-
1444
- ##
1445
- # :attr_reader:
1446
- # Public: The ISO currency code of the transaction, either USD or CAD.
1447
- # Always nil if unofficial_currency_code is non-nil.
1448
- property :iso_currency_code
1449
-
1450
- ##
1451
- # :attr_reader:
1452
- # Public: The unofficial currency code associated with the transaction.
1453
- # Always nil if iso_currency_code is non-nil.
1454
- property :unofficial_currency_code
1455
-
1456
- ##
1457
- # :attr_reader: Public: The String account owner (or nil). This field
1458
- # only appears in an Asset Report with Insights.
1459
- property :account_owner
1460
-
1461
- ##
1462
- # :attr_reader: Public: The Array of String category (or nil). This field
1463
- # only appears in an Asset Report with Insights. E.g. ["Payment", "Credit
1464
- # Card"].
1465
- property :category
1466
-
1467
- ##
1468
- # :attr_reader: Public: The String category_id (or nil). This field only
1469
- # appears in an Asset Report with Insights. E.g. "16001000".
1470
- property :category_id
1471
-
1472
- ##
1473
- # :attr_reader: Public: The String date of the transaction (or nil). This
1474
- # field only appears in an Asset Report with Insights.
1475
- property :date_transacted
1476
-
1477
- ##
1478
- # :attr_reader: Public: The location where transaction occurred
1479
- # (TransactionLocation). This field only appears in an Asset Report with
1480
- # Insights.
1481
- property :location, coerce: TransactionLocation
1482
-
1483
- ##
1484
- # :attr_reader: Public: The String transaction name (or nil). This field
1485
- # only appears in an Asset Report with Insights. E.g. "CREDIT CARD 3333
1486
- # PAYMENT *//".
1487
- property :name
1488
-
1489
- ##
1490
- # :attr_reader: Public: The payment meta information
1491
- # (TransactionPaymentMeta). This field only appears in an Asset Report
1492
- # with Insights.
1493
- property :payment_meta, coerce: TransactionPaymentMeta
1494
-
1495
- ##
1496
- # :attr_reader: Public: The String pending transaction ID (or nil). This
1497
- # field only appears in an Asset Report with Insights.
1498
- property :pending_transaction_id
1499
-
1500
- ##
1501
- # :attr_reader: Public: The String transaction type (or nil). E.g.
1502
- # "special", or "place". This field only appears in an Asset Report with
1503
- # Insights.
1504
- property :transaction_type
1505
- end
1506
-
1507
- # Public: A representation of an asset report account.
1508
- class AssetReportAccount < BaseModel
1509
- ##
1510
- # :attr_reader:
1511
- # Public: Plaid's unique identifier for the account.
1512
- property :account_id
1513
-
1514
- ##
1515
- # :attr_reader:
1516
- # Public: The last 2-5 digits of the account's number.
1517
- property :mask
1518
-
1519
- ##
1520
- # :attr_reader:
1521
- # Public: The name of the account, either assigned by the user or by the
1522
- # financial institution itself.
1523
- property :name
1524
-
1525
- ##
1526
- # :attr_reader:
1527
- # Public: The official name of the account as given by the financial
1528
- # institution.
1529
- property :official_name
1530
-
1531
- ##
1532
- # :attr_reader:
1533
- # Public: The primary type of the account (e.g., "depository").
1534
- property :type
1535
-
1536
- ##
1537
- # :attr_reader:
1538
- # Public: The secondary type of the account (e.g., "checking").
1539
- property :subtype
1540
-
1541
- ##
1542
- # :attr_reader:
1543
- # Public: Data returned by the financial institution about the account
1544
- # owner or owners; see AssetReportOwner object for fields.
1545
- property :owners, coerce: Array[AssetReportOwner]
1546
-
1547
- ##
1548
- # :attr_reader:
1549
- # Public: Data about the various balances on the account; see
1550
- # AssetReportBalance object for fields.
1551
- property :balances, coerce: AssetReportBalance
1552
-
1553
- ##
1554
- # :attr_reader:
1555
- # Public: Calculated data about the historical balances on the account;
1556
- # see AssetReportHistoricalBalance object for fields.
1557
- property :historical_balances, coerce: Array[AssetReportHistoricalBalance]
1558
-
1559
- ##
1560
- # :attr_reader:
1561
- # Public: Data about the transactions.
1562
- property :transactions, coerce: Array[AssetReportTransaction]
1563
-
1564
- ##
1565
- # :attr_reader:
1566
- # Public: The duration of transaction history available for this Item,
1567
- # typically defined as the time since the date of the earliest
1568
- # transaction in that account.
1569
- property :days_available
1570
- end
1571
-
1572
- # Public: A representation of an asset report item.
1573
- class AssetReportItem < BaseModel
1574
- ##
1575
- # :attr_reader:
1576
- # Public: Plaid's unique identifier for the Item.
1577
- property :item_id
1578
-
1579
- ##
1580
- # :attr_reader:
1581
- # Public: The full financial institution name associated with the Item.
1582
- property :institution_name
1583
-
1584
- ##
1585
- # :attr_reader:
1586
- # Public: The financial institution associated with the Item.
1587
- property :institution_id
1588
-
1589
- ##
1590
- # :attr_reader:
1591
- # Public: The date and time when this Item's data was retrieved from the
1592
- # financial institution.
1593
- property :date_last_updated
1594
-
1595
- ##
1596
- # :attr_reader:
1597
- # Public: Data about each of the accounts open on the Item; see Account
1598
- # object for fields.
1599
- property :accounts, coerce: Array[AssetReportAccount]
1600
- end
1601
-
1602
- # Public: A representation of an asset report user.
1603
- class AssetReportUser < BaseModel
1604
- ##
1605
- # :attr_reader:
1606
- # Public: An identifier you determine and submit for the user.
1607
- property :client_user_id
1608
-
1609
- ##
1610
- # :attr_reader:
1611
- # Public: The user's first name.
1612
- property :first_name
1613
-
1614
- ##
1615
- # :attr_reader:
1616
- # Public: The user's middle name.
1617
- property :middle_name
1618
-
1619
- ##
1620
- # :attr_reader:
1621
- # Public: The user's last name.
1622
- property :last_name
1623
-
1624
- ##
1625
- # :attr_reader:
1626
- # Public: The user's social security number. Format:
1627
- # "\d\d\d-\d\d-\d\d\d\d".
1628
- property :ssn
1629
-
1630
- ##
1631
- # :attr_reader:
1632
- # Public: The user's phone number Format:
1633
- # "+{country_code}{area code and subscriber number}", e.g.
1634
- # "+14155555555" (known as E.164 format)
1635
- property :phone_number
1636
-
1637
- ##
1638
- # :attr_reader:
1639
- # Public: The user's email address.
1640
- property :email
1641
- end
1642
-
1643
- # Public: A representation of an asset report.
1644
- class AssetReport < BaseModel
1645
- ##
1646
- # :attr_reader:
1647
- # Public: Plaid's unique identifier for this asset report.
1648
- property :asset_report_id
1649
-
1650
- ##
1651
- # :attr_reader:
1652
- # Public: An identifier you determine and submit for the Asset Report.
1653
- property :client_report_id
1654
-
1655
- ##
1656
- # :attr_reader:
1657
- # Public: The date and time when the Asset Report was created.
1658
- property :date_generated
1659
-
1660
- ##
1661
- # :attr_reader:
1662
- # Public: The duration of transaction history you requested.
1663
- property :days_requested
1664
-
1665
- ##
1666
- # :attr_reader:
1667
- # Public: Data submitted by you about the user whose Asset Report is
1668
- # being compiled; see AssetReportUser object for fields.
1669
- property :user, coerce: AssetReportUser
1670
-
1671
- ##
1672
- # :attr_reader:
1673
- # Public: Data returned by Plaid about each of the Items included in the
1674
- # Asset Report; see AssetReportItem object for fields.
1675
- property :items, coerce: Array[AssetReportItem]
1676
- end
1677
-
1678
- # Public: A representation of an eligibility for the Public Service Loan
1679
- # Forgiveness program.
1680
- class PSLFStatus < BaseModel
1681
- ##
1682
- # :attr_reader:
1683
- # Public: The estimated date borrower will have completed 120 qualifying
1684
- # monthly payments.
1685
- property :estimated_eligibility_date
1686
-
1687
- ##
1688
- # :attr_reader:
1689
- # Public: The number of qualifying payments that have been made.
1690
- property :payments_made
1691
-
1692
- ##
1693
- # :attr_reader:
1694
- # Public: The number of qualifying payments that are remaining.
1695
- property :payments_remaining
1696
- end
1697
-
1698
- # Public: A representation of the status of a student loan.
1699
- class StudentLoanStatus < BaseModel
1700
- ##
1701
- # :attr_reader:
1702
- # Public: The status of the loan, e.g. "repayment", "deferment",
1703
- # "forbearance".
1704
- property :type
1705
-
1706
- ##
1707
- # :attr_reader:
1708
- # Public: The date the status expires.
1709
- property :end_date
1710
- end
1711
-
1712
- # Public: A representation of a student loan repayment plan.
1713
- class StudentLoanRepaymentPlan < BaseModel
1714
- ##
1715
- # :attr_reader:
1716
- # Public: The type of repayment plan, e.g., "standard", "income".
1717
- property :type
1718
-
1719
- ##
1720
- # :attr_reader:
1721
- # Public: The full name of the repayment plan, e.g. "Standard Repayment".
1722
- property :description
1723
- end
1724
-
1725
- # Public: A representation of a student loan servicer address.
1726
- class StudentLoanServicerAddress < BaseModel
1727
- ##
1728
- # :attr_reader:
1729
- # Public: The full city name
1730
- property :city
1731
-
1732
- ##
1733
- # :attr_reader:
1734
- # Public: The ISO 3166-1 alpha-2 country code
1735
- property :country
1736
-
1737
- ##
1738
- # :attr_reader:
1739
- # Public: The postal code.
1740
- property :postal_code
1741
-
1742
- ##
1743
- # :attr_reader:
1744
- # Public: The region or state.
1745
- property :region
1746
-
1747
- ##
1748
- # :attr_reader:
1749
- # Public: The full street address.
1750
- property :street
1751
- end
1752
-
1753
- # Public: A representation of a student loan liability.
1754
- class StudentLoanLiability < BaseModel
1755
- ##
1756
- # :attr_reader:
1757
- # Public: The String account ID. E.g.
1758
- # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
1759
- property :account_id
1760
-
1761
- ##
1762
- # :attr_reader:
1763
- # Public: The account number of the loan.
1764
- property :account_number
1765
-
1766
- ##
1767
- # :attr_reader:
1768
- # Public: The dates on which loaned funds were disbursed or will be
1769
- # disbursed. These are often in the past.
1770
- property :disbursement_dates
1771
-
1772
- ##
1773
- # :attr_reader:
1774
- # Public: The date when the student loan is expected to be paid off.
1775
- property :expected_payoff_date
1776
-
1777
- ##
1778
- # :attr_reader:
1779
- # Public: The guarantor of the student loan.
1780
- property :guarantor
1781
-
1782
- ##
1783
- # :attr_reader:
1784
- # Public: The interest rate on loans shown as a percentage.
1785
- property :interest_rate_percentage
1786
-
1787
- ##
1788
- # :attr_reader:
1789
- # Public: True if a payment is currently overdue.
1790
- property :is_overdue
1791
-
1792
- ##
1793
- # :attr_reader:
1794
- # Public: The amount of the last payment.
1795
- property :last_payment_amount
1796
-
1797
- ##
1798
- # :attr_reader:
1799
- # Public: The date of the last payment.
1800
- property :last_payment_date
1801
-
1802
- ##
1803
- # :attr_reader:
1804
- # Public: The outstanding balance on the last statement.
1805
- property :last_statement_balance
1806
-
1807
- ##
1808
- # :attr_reader:
1809
- # Public: The date the last statement was issued.
1810
- property :last_statement_issue_date
1811
-
1812
- ##
1813
- # :attr_reader:
1814
- # Public: The status of the loan, e.g. "Repayment", "Deferment",
1815
- # "Forbearance".
1816
- property :loan_status, coerce: StudentLoanStatus
1817
-
1818
- ##
1819
- # :attr_reader:
1820
- # Public: The type of loan, e.g., "Consolidation Loans".
1821
- property :loan_name
1822
-
1823
- ##
1824
- # :attr_reader:
1825
- # Public: The minimum payment due for the next billing cycle.
1826
- property :minimum_payment_amount
1827
-
1828
- ##
1829
- # :attr_reader:
1830
- # Public: The due date for the next payment.
1831
- property :next_payment_due_date
1832
-
1833
- ##
1834
- # :attr_reader:
1835
- # Public: The date on which the loan was initially lent.
1836
- property :origination_date
1837
-
1838
- ##
1839
- # :attr_reader:
1840
- # Public: The original principal balance of the loan.
1841
- property :origination_principal_amount
1842
-
1843
- ##
1844
- # :attr_reader:
1845
- # Public: The dollar amount of the accrued interest balance.
1846
- property :outstanding_interest_amount
1847
-
1848
- ##
1849
- # :attr_reader:
1850
- # Public: The relevant account number that should be used to reference
1851
- # this loan for payments. This is sometimes different from
1852
- # account_number.
1853
- property :payment_reference_number
1854
-
1855
- ##
1856
- # :attr_reader:
1857
- # Public: Information about the student's eligibility in the Public
1858
- # Service Loan Forgiveness program.
1859
- property :pslf_status, coerce: PSLFStatus
1860
-
1861
- ##
1862
- # :attr_reader:
1863
- # Public: Information about the repayment plan.
1864
- property :repayment_plan, coerce: StudentLoanRepaymentPlan
1865
-
1866
- ##
1867
- # :attr_reader:
1868
- # Public: The sequence number of the student loan.
1869
- property :sequence_number
1870
-
1871
- ##
1872
- # :attr_reader:
1873
- # Public: The servicer address for which payments should be sent.
1874
- property :servicer_address, coerce: StudentLoanServicerAddress
1875
-
1876
- ##
1877
- # :attr_reader:
1878
- # Public: The year to date (YTD) interest paid.
1879
- property :ytd_interest_paid
1880
-
1881
- ##
1882
- # :attr_reader:
1883
- # Public: The year to date (YTD) principal paid.
1884
- property :ytd_principal_paid
1885
- end
1886
-
1887
- # Public: A representation of a credit card liability APR
1888
- class CreditCardLiabilityAPRs < BaseModel
1889
- ##
1890
- # :attr_reader:
1891
- # Public: Annual Percentage Rate applied.
1892
- property :apr_percentage
1893
-
1894
- ##
1895
- # :attr_reader:
1896
- # Public: Enumerated response from the following options:
1897
- # "balance_transfer_apr", "cash_apr", "purchase_apr", or
1898
- # "special".
1899
- property :apr_type
1900
-
1901
- ##
1902
- # :attr_reader:
1903
- # Public: Amount of money that is subjected to the APR if a
1904
- # balance was carried beyond payment due date. How it is
1905
- # calculated can vary by card issuer. It is often calculated as
1906
- # an average daily balance.
1907
- property :balance_subject_to_apr
1908
-
1909
- ##
1910
- # :attr_reader:
1911
- # Public: Amount of money charged due to interest from last
1912
- # statement.
1913
- property :interest_charge_amount
1914
- end
1915
-
1916
- # Public: A representation of a credit card liability
1917
- class CreditCardLiability < BaseModel
1918
- ##
1919
- # :attr_reader:
1920
- # Public: The ID of the account that this liability belongs to.
1921
- property :account_id
1922
-
1923
- ##
1924
- # :attr_reader:
1925
- # Public: See the APR object schema
1926
- property :aprs, coerce: Array[CreditCardLiabilityAPRs]
1927
-
1928
- ##
1929
- # :attr_reader:
1930
- # Public: true if a payment is currently overdue.
1931
- property :is_overdue
1932
-
1933
- ##
1934
- # :attr_reader:
1935
- # Public: The amount of the last payment.
1936
- property :last_payment_amount
1937
-
1938
- ##
1939
- # :attr_reader:
1940
- # Public: The date of the last payment.
1941
- property :last_payment_date
1942
-
1943
- ##
1944
- # :attr_reader:
1945
- # Public: The outstanding balance on the last statement.
1946
- property :last_statement_balance
1947
-
1948
- ##
1949
- # :attr_reader:
1950
- # Public: The date of the last statement.
1951
- property :last_statement_issue_date
1952
-
1953
- ##
1954
- # :attr_reader:
1955
- # Public: The minimum payment due for the next billing cycle.
1956
- property :minimum_payment_amount
1957
-
1958
- ##
1959
- # :attr_reader:
1960
- # Public: The due date for the next payment. The due date is null
1961
- # if a payment is not expected.
1962
- property :next_payment_due_date
1963
- end
1964
-
1965
- # Public: A representation of someone's liabilities of all types.
1966
- class Liabilities < BaseModel
1967
- include Hashie::Extensions::IgnoreUndeclared
1968
-
1969
- ##
1970
- # :attr_reader:
1971
- # Public: Student loan liabilities associated with the item.
1972
- property :student, coerce: Array[StudentLoanLiability]
1973
-
1974
- ##
1975
- # :attr_reader:
1976
- # Public: Credit card liabilities associated with the item.
1977
- property :credit, coerce: Array[CreditCardLiability]
1978
- end
1979
-
1980
- # Public: A representation of a payment amount.
1981
- class PaymentAmount < BaseModel
1982
- ##
1983
- # :attr_reader:
1984
- # Public: Currency for the payment amount.
1985
- property :currency
1986
-
1987
- ##
1988
- # :attr_reader:
1989
- # Public: Value of the payment amount.
1990
- property :value
1991
- end
1992
-
1993
- # Public: A representation of a payment amount.
1994
- class PaymentSchedule < BaseModel
1995
- ##
1996
- # :attr_reader:
1997
- # Public: Interval for the standing order.
1998
- property :interval
1999
-
2000
- ##
2001
- # :attr_reader:
2002
- # Public: Day or the week or day of the month to execute
2003
- # the standing order.
2004
- property :interval_execution_day
2005
-
2006
- ##
2007
- # :attr_reader:
2008
- # Public: Start date for the standing order.
2009
- property :start_date
2010
- end
2011
-
2012
- # Public: A representation of a payment amount.
2013
- class PaymentRecipientAddress < BaseModel
2014
- ##
2015
- # :attr_reader:
2016
- # Public: Street name.
2017
- property :street
2018
-
2019
- ##
2020
- # :attr_reader:
2021
- # Public: City.
2022
- property :city
2023
-
2024
- ##
2025
- # :attr_reader:
2026
- # Public: Postal code.
2027
- property :postal_code
2028
-
2029
- ##
2030
- # :attr_reader:
2031
- # Public: Country.
2032
- property :country
2033
- end
2034
-
2035
- # Public: A representation of a payment recipient BACS number.
2036
- class PaymentRecipientBACS < BaseModel
2037
- ##
2038
- # :attr_reader:
2039
- # Public: The String account number. E.g. "66374958".
2040
- property :account
2041
-
2042
- ##
2043
- # :attr_reader:
2044
- # Public: The String sort code. E.g. "089999".
2045
- property :sort_code
2046
- end
2047
-
2048
- # Public: A representation of a payment recipient.
2049
- class PaymentRecipient < BaseModel
2050
- ##
2051
- # :attr_reader:
2052
- # Public: The recipient ID.
2053
- property :recipient_id
2054
-
2055
- ##
2056
- # :attr_reader:
2057
- # Public: The recipient name.
2058
- property :name
2059
-
2060
- ##
2061
- # :attr_reader:
2062
- # Public: The recipient IBAN.
2063
- property :iban
2064
-
2065
- ##
2066
- # :attr_reader:
2067
- # Public: The recipient BACS number .
2068
- property :bacs, coerce: PaymentRecipientBACS
2069
-
2070
- ##
2071
- # :attr_reader:
2072
- # Public: The recipient address.
2073
- property :address, coerce: PaymentRecipientAddress
2074
- end
2075
-
2076
- # Public: A representation of a payment.
2077
- class Payment < BaseModel
2078
- ##
2079
- # :attr_reader:
2080
- # Public: The payment ID.
2081
- property :payment_id
2082
-
2083
- ##
2084
- # :attr_reader:
2085
- # Public: The payment token.
2086
- property :payment_token
2087
-
2088
- ##
2089
- # :attr_reader:
2090
- # Public: The payment reference.
2091
- property :reference
2092
-
2093
- ##
2094
- # :attr_reader:
2095
- # Public: The payment amount.
2096
- property :amount, coerce: PaymentAmount
2097
-
2098
- ##
2099
- # :attr_reader:
2100
- # Public: The payment schedule.
2101
- property :schedule, coerce: PaymentSchedule
2102
-
2103
- ##
2104
- # :attr_reader:
2105
- # Public: The payment's status.
2106
- property :status
2107
-
2108
- ##
2109
- # :attr_reader:
2110
- # Public: The last status update time for payment.
2111
- property :last_status_update
2112
-
2113
- ##
2114
- # :attr_reader:
2115
- # Public: The payment token's expiration time.
2116
- property :payment_token_expiration_time
2117
-
2118
- ##
2119
- # :attr_reader:
2120
- # Public: The recipient ID for payment.
2121
- property :recipient_id
2122
-
2123
- ##
2124
- # :attr_reader:
2125
- # Public: An object containing a BACS account number and sort code
2126
- # for the payer's account.
2127
- property :bacs
2128
-
2129
- ##
2130
- # :attr_reader:
2131
- # Public: A string containing the IBAN for the payer's account.
2132
- property :iban
2133
- end
2134
-
2135
- # Public: Metadata associated with a link token.
2136
- class LinkTokenMetadata < BaseModel
2137
- ##
2138
- # :attr_reader:
2139
- # Public: List of products associated with the link token.
2140
- property :initial_products
2141
-
2142
- ##
2143
- # :attr_reader:
2144
- # Public: The webhook associated with the link token.
2145
- property :webhook
2146
-
2147
- ##
2148
- # :attr_reader:
2149
- # Public: The country codes associated with the link token.
2150
- property :country_codes
2151
-
2152
- ##
2153
- # :attr_reader:
2154
- # Public: The language associated with the link token.
2155
- property :language
2156
-
2157
- ##
2158
- # :attr_reader:
2159
- # Public: The account filters associated with the link token.
2160
- property :account_filters
2161
-
2162
- ##
2163
- # :attr_reader:
2164
- # Public: The redirect URI associated with the link token.
2165
- property :redirect_uri
2166
-
2167
- ##
2168
- # :attr_reader:
2169
- # Public: The client name associated with the link token.
2170
- property :client_name
2171
- end
2172
-
2173
- # Public: A representation of a payment amount.
2174
- class WebhookVerificationKey < BaseModel
2175
- ##
2176
- # :attr_reader:
2177
- # Public: alg.
2178
- property :alg
2179
-
2180
- ##
2181
- # :attr_reader:
2182
- # Public: created_at.
2183
- property :created_at
2184
-
2185
- ##
2186
- # :attr_reader:
2187
- # Public: crv.
2188
- property :crv
2189
-
2190
- ##
2191
- # :attr_reader:
2192
- # Public: expired_at.
2193
- property :expired_at
2194
-
2195
- ##
2196
- # :attr_reader:
2197
- # Public: kid.
2198
- property :kid
2199
-
2200
- ##
2201
- # :attr_reader:
2202
- # Public: kty.
2203
- property :kty
2204
-
2205
- ##
2206
- # :attr_reader:
2207
- # Public: use.
2208
- property :use
2209
-
2210
- ##
2211
- # :attr_reader:
2212
- # Public: x.
2213
- property :x
2214
-
2215
- ##
2216
- # :attr_reader:
2217
- # Public: y.
2218
- property :y
2219
- end
2220
- end
2221
- end