increase 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (554) hide show
  1. package/.prettierignore +1 -0
  2. package/.release-please-manifest.json +3 -0
  3. package/.stats.yml +1 -1
  4. package/CHANGELOG.md +130 -0
  5. package/README.md +19 -5
  6. package/api.md +99 -0
  7. package/bin/check-release-environment +25 -0
  8. package/bin/publish-npm +6 -0
  9. package/check-version.ts +4 -1
  10. package/core.ts +32 -126
  11. package/dist/cjs/check-version.d.ts +1 -0
  12. package/dist/cjs/check-version.d.ts.map +1 -0
  13. package/dist/cjs/check-version.js +3 -1
  14. package/dist/cjs/check-version.js.map +1 -1
  15. package/dist/cjs/core.d.ts +25 -55
  16. package/dist/cjs/core.d.ts.map +1 -0
  17. package/dist/cjs/core.js +43 -168
  18. package/dist/cjs/core.js.map +1 -1
  19. package/dist/cjs/error.d.ts +208 -0
  20. package/dist/cjs/error.d.ts.map +1 -0
  21. package/dist/cjs/error.js +326 -0
  22. package/dist/cjs/error.js.map +1 -0
  23. package/dist/cjs/examples/api-error.d.ts +3 -0
  24. package/dist/cjs/examples/api-error.d.ts.map +1 -0
  25. package/dist/cjs/examples/api-error.js +92 -0
  26. package/dist/cjs/examples/api-error.js.map +1 -0
  27. package/dist/cjs/fetch-polyfill.d.ts +1 -0
  28. package/dist/cjs/fetch-polyfill.d.ts.map +1 -0
  29. package/dist/cjs/fetch-polyfill.js +2 -2
  30. package/dist/cjs/fetch-polyfill.js.map +1 -1
  31. package/dist/cjs/index.d.ts +81 -22
  32. package/dist/cjs/index.d.ts.map +1 -0
  33. package/dist/cjs/index.js +80 -26
  34. package/dist/cjs/index.js.map +1 -1
  35. package/dist/cjs/pagination.d.ts +4 -0
  36. package/dist/cjs/pagination.d.ts.map +1 -0
  37. package/dist/cjs/pagination.js.map +1 -1
  38. package/dist/cjs/resource.d.ts +1 -0
  39. package/dist/cjs/resource.d.ts.map +1 -0
  40. package/dist/cjs/resources/account-numbers.d.ts +26 -0
  41. package/dist/cjs/resources/account-numbers.d.ts.map +1 -0
  42. package/dist/cjs/resources/account-numbers.js.map +1 -1
  43. package/dist/cjs/resources/account-statements.d.ts +1 -0
  44. package/dist/cjs/resources/account-statements.d.ts.map +1 -0
  45. package/dist/cjs/resources/account-statements.js.map +1 -1
  46. package/dist/cjs/resources/account-transfers.d.ts +20 -11
  47. package/dist/cjs/resources/account-transfers.d.ts.map +1 -0
  48. package/dist/cjs/resources/account-transfers.js.map +1 -1
  49. package/dist/cjs/resources/accounts.d.ts +41 -19
  50. package/dist/cjs/resources/accounts.d.ts.map +1 -0
  51. package/dist/cjs/resources/accounts.js.map +1 -1
  52. package/dist/cjs/resources/ach-prenotifications.d.ts +4 -0
  53. package/dist/cjs/resources/ach-prenotifications.d.ts.map +1 -0
  54. package/dist/cjs/resources/ach-prenotifications.js.map +1 -1
  55. package/dist/cjs/resources/ach-transfers.d.ts +89 -9
  56. package/dist/cjs/resources/ach-transfers.d.ts.map +1 -0
  57. package/dist/cjs/resources/ach-transfers.js.map +1 -1
  58. package/dist/cjs/resources/balance-lookups.d.ts +47 -0
  59. package/dist/cjs/resources/balance-lookups.d.ts.map +1 -0
  60. package/dist/cjs/resources/balance-lookups.js +15 -0
  61. package/dist/cjs/resources/balance-lookups.js.map +1 -0
  62. package/dist/cjs/resources/bookkeeping-accounts.d.ts +71 -0
  63. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +1 -0
  64. package/dist/cjs/resources/bookkeeping-accounts.js +29 -0
  65. package/dist/cjs/resources/bookkeeping-accounts.js.map +1 -0
  66. package/dist/cjs/resources/bookkeeping-entries.d.ts +43 -0
  67. package/dist/cjs/resources/bookkeeping-entries.d.ts.map +1 -0
  68. package/dist/cjs/resources/bookkeeping-entries.js +19 -0
  69. package/dist/cjs/resources/bookkeeping-entries.js.map +1 -0
  70. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +83 -0
  71. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +1 -0
  72. package/dist/cjs/resources/bookkeeping-entry-sets.js +15 -0
  73. package/dist/cjs/resources/bookkeeping-entry-sets.js.map +1 -0
  74. package/dist/cjs/resources/card-disputes.d.ts +13 -3
  75. package/dist/cjs/resources/card-disputes.d.ts.map +1 -0
  76. package/dist/cjs/resources/card-disputes.js.map +1 -1
  77. package/dist/cjs/resources/card-profiles.d.ts +18 -2
  78. package/dist/cjs/resources/card-profiles.d.ts.map +1 -0
  79. package/dist/cjs/resources/card-profiles.js.map +1 -1
  80. package/dist/cjs/resources/cards.d.ts +31 -2
  81. package/dist/cjs/resources/cards.d.ts.map +1 -0
  82. package/dist/cjs/resources/cards.js.map +1 -1
  83. package/dist/cjs/resources/check-deposits.d.ts +16 -1
  84. package/dist/cjs/resources/check-deposits.d.ts.map +1 -0
  85. package/dist/cjs/resources/check-deposits.js.map +1 -1
  86. package/dist/cjs/resources/check-transfers.d.ts +104 -5
  87. package/dist/cjs/resources/check-transfers.d.ts.map +1 -0
  88. package/dist/cjs/resources/check-transfers.js.map +1 -1
  89. package/dist/cjs/resources/declined-transactions.d.ts +85 -23
  90. package/dist/cjs/resources/declined-transactions.d.ts.map +1 -0
  91. package/dist/cjs/resources/declined-transactions.js.map +1 -1
  92. package/dist/cjs/resources/digital-wallet-tokens.d.ts +1 -0
  93. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +1 -0
  94. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -1
  95. package/dist/cjs/resources/documents.d.ts +105 -4
  96. package/dist/cjs/resources/documents.d.ts.map +1 -0
  97. package/dist/cjs/resources/documents.js.map +1 -1
  98. package/dist/cjs/resources/entities/entities.d.ts +363 -136
  99. package/dist/cjs/resources/entities/entities.d.ts.map +1 -0
  100. package/dist/cjs/resources/entities/entities.js +1 -1
  101. package/dist/cjs/resources/entities/entities.js.map +1 -1
  102. package/dist/cjs/resources/entities/index.d.ts +7 -1
  103. package/dist/cjs/resources/entities/index.d.ts.map +1 -0
  104. package/dist/cjs/resources/entities/index.js +8 -1
  105. package/dist/cjs/resources/entities/index.js.map +1 -1
  106. package/dist/cjs/resources/entities/supplemental-documents.d.ts +36 -0
  107. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +1 -0
  108. package/dist/cjs/resources/entities/supplemental-documents.js +14 -1
  109. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -1
  110. package/dist/cjs/resources/event-subscriptions.d.ts +5 -0
  111. package/dist/cjs/resources/event-subscriptions.d.ts.map +1 -0
  112. package/dist/cjs/resources/event-subscriptions.js.map +1 -1
  113. package/dist/cjs/resources/events.d.ts +30 -24
  114. package/dist/cjs/resources/events.d.ts.map +1 -0
  115. package/dist/cjs/resources/events.js.map +1 -1
  116. package/dist/cjs/resources/exports.d.ts +162 -0
  117. package/dist/cjs/resources/exports.d.ts.map +1 -0
  118. package/dist/cjs/resources/exports.js +31 -0
  119. package/dist/cjs/resources/exports.js.map +1 -0
  120. package/dist/cjs/resources/external-accounts.d.ts +4 -2
  121. package/dist/cjs/resources/external-accounts.d.ts.map +1 -0
  122. package/dist/cjs/resources/external-accounts.js.map +1 -1
  123. package/dist/cjs/resources/files.d.ts +10 -4
  124. package/dist/cjs/resources/files.d.ts.map +1 -0
  125. package/dist/cjs/resources/files.js.map +1 -1
  126. package/dist/cjs/resources/groups.d.ts +1 -0
  127. package/dist/cjs/resources/groups.d.ts.map +1 -0
  128. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +4 -0
  129. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts.map +1 -0
  130. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -1
  131. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +1 -0
  132. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts.map +1 -0
  133. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -1
  134. package/dist/cjs/resources/index.d.ts +29 -0
  135. package/dist/cjs/resources/index.d.ts.map +1 -0
  136. package/dist/cjs/resources/index.js +100 -9
  137. package/dist/cjs/resources/index.js.map +1 -1
  138. package/dist/cjs/resources/limits.d.ts +1 -0
  139. package/dist/cjs/resources/limits.d.ts.map +1 -0
  140. package/dist/cjs/resources/limits.js.map +1 -1
  141. package/dist/cjs/resources/oauth-connections.d.ts +1 -0
  142. package/dist/cjs/resources/oauth-connections.d.ts.map +1 -0
  143. package/dist/cjs/resources/oauth-connections.js.map +1 -1
  144. package/dist/cjs/resources/pending-transactions.d.ts +115 -36
  145. package/dist/cjs/resources/pending-transactions.d.ts.map +1 -0
  146. package/dist/cjs/resources/pending-transactions.js.map +1 -1
  147. package/dist/cjs/resources/programs.d.ts +48 -0
  148. package/dist/cjs/resources/programs.d.ts.map +1 -0
  149. package/dist/cjs/resources/programs.js +25 -0
  150. package/dist/cjs/resources/programs.js.map +1 -0
  151. package/dist/cjs/resources/real-time-decisions.d.ts +43 -7
  152. package/dist/cjs/resources/real-time-decisions.d.ts.map +1 -0
  153. package/dist/cjs/resources/real-time-payments-transfers.d.ts +287 -0
  154. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +1 -0
  155. package/dist/cjs/resources/real-time-payments-transfers.js +35 -0
  156. package/dist/cjs/resources/real-time-payments-transfers.js.map +1 -0
  157. package/dist/cjs/resources/routing-numbers.d.ts +1 -0
  158. package/dist/cjs/resources/routing-numbers.d.ts.map +1 -0
  159. package/dist/cjs/resources/shared.d.ts +1 -0
  160. package/dist/cjs/resources/shared.d.ts.map +1 -0
  161. package/dist/cjs/resources/simulations/account-statements.d.ts +1 -0
  162. package/dist/cjs/resources/simulations/account-statements.d.ts.map +1 -0
  163. package/dist/cjs/resources/simulations/account-transfers.d.ts +1 -0
  164. package/dist/cjs/resources/simulations/account-transfers.d.ts.map +1 -0
  165. package/dist/cjs/resources/simulations/ach-transfers.d.ts +470 -157
  166. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +1 -0
  167. package/dist/cjs/resources/simulations/card-disputes.d.ts +1 -0
  168. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +1 -0
  169. package/dist/cjs/resources/simulations/card-refunds.d.ts +1 -0
  170. package/dist/cjs/resources/simulations/card-refunds.d.ts.map +1 -0
  171. package/dist/cjs/resources/simulations/cards.d.ts +188 -56
  172. package/dist/cjs/resources/simulations/cards.d.ts.map +1 -0
  173. package/dist/cjs/resources/simulations/check-deposits.d.ts +1 -0
  174. package/dist/cjs/resources/simulations/check-deposits.d.ts.map +1 -0
  175. package/dist/cjs/resources/simulations/check-transfers.d.ts +16 -0
  176. package/dist/cjs/resources/simulations/check-transfers.d.ts.map +1 -0
  177. package/dist/cjs/resources/simulations/check-transfers.js +10 -0
  178. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -1
  179. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +1 -0
  180. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -0
  181. package/dist/cjs/resources/simulations/documents.d.ts +1 -0
  182. package/dist/cjs/resources/simulations/documents.d.ts.map +1 -0
  183. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -0
  184. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -0
  185. package/dist/cjs/resources/simulations/index.d.ts +5 -0
  186. package/dist/cjs/resources/simulations/index.d.ts.map +1 -0
  187. package/dist/cjs/resources/simulations/interest-payments.d.ts +1237 -0
  188. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +1 -0
  189. package/dist/cjs/resources/simulations/interest-payments.js +16 -0
  190. package/dist/cjs/resources/simulations/interest-payments.js.map +1 -0
  191. package/dist/cjs/resources/simulations/programs.d.ts +21 -0
  192. package/dist/cjs/resources/simulations/programs.d.ts.map +1 -0
  193. package/dist/cjs/resources/simulations/programs.js +17 -0
  194. package/dist/cjs/resources/simulations/programs.js.map +1 -0
  195. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +470 -155
  196. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +1 -0
  197. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +11 -0
  198. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -1
  199. package/dist/cjs/resources/simulations/simulations.d.ts +5 -0
  200. package/dist/cjs/resources/simulations/simulations.d.ts.map +1 -0
  201. package/dist/cjs/resources/simulations/simulations.js +4 -0
  202. package/dist/cjs/resources/simulations/simulations.js.map +1 -1
  203. package/dist/cjs/resources/simulations/wire-transfers.d.ts +332 -133
  204. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +1 -0
  205. package/dist/cjs/resources/transactions.d.ts +353 -165
  206. package/dist/cjs/resources/transactions.d.ts.map +1 -0
  207. package/dist/cjs/resources/transactions.js.map +1 -1
  208. package/dist/cjs/resources/wire-drawdown-requests.d.ts +5 -0
  209. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +1 -0
  210. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -1
  211. package/dist/cjs/resources/wire-transfers.d.ts +39 -4
  212. package/dist/cjs/resources/wire-transfers.d.ts.map +1 -0
  213. package/dist/cjs/resources/wire-transfers.js.map +1 -1
  214. package/dist/cjs/streaming.d.ts +13 -0
  215. package/dist/cjs/streaming.d.ts.map +1 -0
  216. package/dist/cjs/streaming.js +282 -0
  217. package/dist/cjs/streaming.js.map +1 -0
  218. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +1 -0
  219. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts.map +1 -0
  220. package/dist/cjs/tests/api-resources/account-numbers.test.js +25 -28
  221. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -1
  222. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +1 -0
  223. package/dist/cjs/tests/api-resources/account-statements.test.d.ts.map +1 -0
  224. package/dist/cjs/tests/api-resources/account-statements.test.js +7 -20
  225. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -1
  226. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +1 -0
  227. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts.map +1 -0
  228. package/dist/cjs/tests/api-resources/account-transfers.test.js +16 -29
  229. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -1
  230. package/dist/cjs/tests/api-resources/accounts.test.d.ts +1 -0
  231. package/dist/cjs/tests/api-resources/accounts.test.d.ts.map +1 -0
  232. package/dist/cjs/tests/api-resources/accounts.test.js +22 -23
  233. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -1
  234. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +1 -0
  235. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts.map +1 -0
  236. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +12 -24
  237. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -1
  238. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +1 -0
  239. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts.map +1 -0
  240. package/dist/cjs/tests/api-resources/ach-transfers.test.js +17 -31
  241. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -1
  242. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts +2 -0
  243. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts.map +1 -0
  244. package/dist/cjs/tests/api-resources/balance-lookups.test.js +55 -0
  245. package/dist/cjs/tests/api-resources/balance-lookups.test.js.map +1 -0
  246. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts +2 -0
  247. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts.map +1 -0
  248. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js +78 -0
  249. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js.map +1 -0
  250. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts +2 -0
  251. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts.map +1 -0
  252. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js +65 -0
  253. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js.map +1 -0
  254. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts +2 -0
  255. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts.map +1 -0
  256. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js +66 -0
  257. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js.map +1 -0
  258. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +1 -0
  259. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts.map +1 -0
  260. package/dist/cjs/tests/api-resources/card-disputes.test.js +18 -24
  261. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -1
  262. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +1 -0
  263. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts.map +1 -0
  264. package/dist/cjs/tests/api-resources/card-profiles.test.js +28 -19
  265. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -1
  266. package/dist/cjs/tests/api-resources/cards.test.d.ts +1 -0
  267. package/dist/cjs/tests/api-resources/cards.test.d.ts.map +1 -0
  268. package/dist/cjs/tests/api-resources/cards.test.js +13 -35
  269. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -1
  270. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +1 -0
  271. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts.map +1 -0
  272. package/dist/cjs/tests/api-resources/check-deposits.test.js +24 -27
  273. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -1
  274. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +1 -0
  275. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts.map +1 -0
  276. package/dist/cjs/tests/api-resources/check-transfers.test.js +27 -40
  277. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -1
  278. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +1 -0
  279. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts.map +1 -0
  280. package/dist/cjs/tests/api-resources/declined-transactions.test.js +9 -23
  281. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -1
  282. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +1 -0
  283. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts.map +1 -0
  284. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +8 -21
  285. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -1
  286. package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
  287. package/dist/cjs/tests/api-resources/documents.test.d.ts.map +1 -0
  288. package/dist/cjs/tests/api-resources/documents.test.js +15 -23
  289. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -1
  290. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +1 -0
  291. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts.map +1 -0
  292. package/dist/cjs/tests/api-resources/entities/entities.test.js +40 -31
  293. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -1
  294. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +1 -0
  295. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts.map +1 -0
  296. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +25 -6
  297. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -1
  298. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +1 -0
  299. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts.map +1 -0
  300. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +10 -20
  301. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -1
  302. package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
  303. package/dist/cjs/tests/api-resources/events.test.d.ts.map +1 -0
  304. package/dist/cjs/tests/api-resources/events.test.js +8 -22
  305. package/dist/cjs/tests/api-resources/events.test.js.map +1 -1
  306. package/dist/cjs/tests/api-resources/exports.test.d.ts +2 -0
  307. package/dist/cjs/tests/api-resources/exports.test.d.ts.map +1 -0
  308. package/dist/cjs/tests/api-resources/exports.test.js +101 -0
  309. package/dist/cjs/tests/api-resources/exports.test.js.map +1 -0
  310. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
  311. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts.map +1 -0
  312. package/dist/cjs/tests/api-resources/external-accounts.test.js +13 -27
  313. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -1
  314. package/dist/cjs/tests/api-resources/files.test.d.ts +1 -0
  315. package/dist/cjs/tests/api-resources/files.test.d.ts.map +1 -0
  316. package/dist/cjs/tests/api-resources/files.test.js +8 -21
  317. package/dist/cjs/tests/api-resources/files.test.js.map +1 -1
  318. package/dist/cjs/tests/api-resources/groups.test.d.ts +1 -0
  319. package/dist/cjs/tests/api-resources/groups.test.d.ts.map +1 -0
  320. package/dist/cjs/tests/api-resources/groups.test.js +6 -5
  321. package/dist/cjs/tests/api-resources/groups.test.js.map +1 -1
  322. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +1 -0
  323. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts.map +1 -0
  324. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +16 -12
  325. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +1 -1
  326. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +1 -0
  327. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  328. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +6 -9
  329. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +1 -1
  330. package/dist/cjs/tests/api-resources/limits.test.d.ts +1 -0
  331. package/dist/cjs/tests/api-resources/limits.test.d.ts.map +1 -0
  332. package/dist/cjs/tests/api-resources/limits.test.js +14 -17
  333. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -1
  334. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +1 -0
  335. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts.map +1 -0
  336. package/dist/cjs/tests/api-resources/oauth-connections.test.js +6 -9
  337. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +1 -1
  338. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +1 -0
  339. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts.map +1 -0
  340. package/dist/cjs/tests/api-resources/pending-transactions.test.js +13 -17
  341. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -1
  342. package/dist/cjs/tests/api-resources/programs.test.d.ts +2 -0
  343. package/dist/cjs/tests/api-resources/programs.test.d.ts.map +1 -0
  344. package/dist/cjs/tests/api-resources/programs.test.js +73 -0
  345. package/dist/cjs/tests/api-resources/programs.test.js.map +1 -0
  346. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +1 -0
  347. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts.map +1 -0
  348. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +6 -16
  349. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -1
  350. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts +2 -0
  351. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts.map +1 -0
  352. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js +113 -0
  353. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js.map +1 -0
  354. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +1 -0
  355. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts.map +1 -0
  356. package/dist/cjs/tests/api-resources/routing-numbers.test.js +6 -5
  357. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -1
  358. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +1 -0
  359. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts.map +1 -0
  360. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +11 -8
  361. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +1 -1
  362. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +1 -0
  363. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts.map +1 -0
  364. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +5 -4
  365. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +1 -1
  366. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +1 -0
  367. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts.map +1 -0
  368. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +13 -19
  369. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -1
  370. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +1 -0
  371. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts.map +1 -0
  372. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +8 -7
  373. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -1
  374. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +1 -0
  375. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts.map +1 -0
  376. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js +11 -8
  377. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +1 -1
  378. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +1 -0
  379. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts.map +1 -0
  380. package/dist/cjs/tests/api-resources/simulations/cards.test.js +12 -10
  381. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -1
  382. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +1 -0
  383. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts.map +1 -0
  384. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +5 -4
  385. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +1 -1
  386. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +1 -0
  387. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts.map +1 -0
  388. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +23 -4
  389. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +1 -1
  390. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +1 -0
  391. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts.map +1 -0
  392. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +11 -8
  393. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +1 -1
  394. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +1 -0
  395. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts.map +1 -0
  396. package/dist/cjs/tests/api-resources/simulations/documents.test.js +10 -7
  397. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +1 -1
  398. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +1 -0
  399. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  400. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +29 -28
  401. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -1
  402. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts +2 -0
  403. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts.map +1 -0
  404. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js +58 -0
  405. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js.map +1 -0
  406. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts +2 -0
  407. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts.map +1 -0
  408. package/dist/cjs/tests/api-resources/simulations/programs.test.js +52 -0
  409. package/dist/cjs/tests/api-resources/simulations/programs.test.js.map +1 -0
  410. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +1 -0
  411. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts.map +1 -0
  412. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +20 -12
  413. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -1
  414. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +1 -0
  415. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts.map +1 -0
  416. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +11 -10
  417. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -1
  418. package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
  419. package/dist/cjs/tests/api-resources/transactions.test.d.ts.map +1 -0
  420. package/dist/cjs/tests/api-resources/transactions.test.js +11 -28
  421. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -1
  422. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +1 -0
  423. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts.map +1 -0
  424. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +20 -23
  425. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -1
  426. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +1 -0
  427. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts.map +1 -0
  428. package/dist/cjs/tests/api-resources/wire-transfers.test.js +22 -36
  429. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -1
  430. package/dist/cjs/tests/form.test.d.ts +1 -0
  431. package/dist/cjs/tests/form.test.d.ts.map +1 -0
  432. package/dist/cjs/tests/form.test.js +4 -3
  433. package/dist/cjs/tests/index.test.d.ts +1 -0
  434. package/dist/cjs/tests/index.test.d.ts.map +1 -0
  435. package/dist/cjs/tests/index.test.js +36 -4
  436. package/dist/cjs/tests/index.test.js.map +1 -1
  437. package/dist/cjs/tests/responses.test.d.ts +1 -0
  438. package/dist/cjs/tests/responses.test.d.ts.map +1 -0
  439. package/dist/cjs/tests/responses.test.js +4 -3
  440. package/dist/cjs/version.d.ts +2 -1
  441. package/dist/cjs/version.d.ts.map +1 -0
  442. package/dist/cjs/version.js +1 -1
  443. package/dist/cjs/version.js.map +1 -1
  444. package/error.ts +505 -0
  445. package/examples/api-error.ts +21 -0
  446. package/fetch-polyfill.ts +2 -2
  447. package/index.ts +90 -20
  448. package/package.json +2 -2
  449. package/pagination.ts +3 -0
  450. package/release-please-config.json +61 -0
  451. package/resources/account-numbers.ts +30 -1
  452. package/resources/account-statements.ts +0 -1
  453. package/resources/account-transfers.ts +21 -13
  454. package/resources/accounts.ts +48 -23
  455. package/resources/ach-prenotifications.ts +3 -1
  456. package/resources/ach-transfers.ts +92 -11
  457. package/resources/balance-lookups.ts +57 -0
  458. package/resources/bookkeeping-accounts.ts +98 -0
  459. package/resources/bookkeeping-entries.ts +62 -0
  460. package/resources/bookkeeping-entry-sets.ts +100 -0
  461. package/resources/card-disputes.ts +12 -4
  462. package/resources/card-profiles.ts +17 -3
  463. package/resources/cards.ts +30 -3
  464. package/resources/check-deposits.ts +15 -2
  465. package/resources/check-transfers.ts +117 -7
  466. package/resources/declined-transactions.ts +96 -27
  467. package/resources/digital-wallet-tokens.ts +0 -1
  468. package/resources/documents.ts +104 -5
  469. package/resources/entities/entities.ts +443 -212
  470. package/resources/entities/index.ts +6 -1
  471. package/resources/entities/supplemental-documents.ts +46 -0
  472. package/resources/event-subscriptions.ts +4 -1
  473. package/resources/events.ts +33 -29
  474. package/resources/exports.ts +204 -0
  475. package/resources/external-accounts.ts +3 -3
  476. package/resources/files.ts +9 -5
  477. package/resources/inbound-ach-transfer-returns.ts +3 -1
  478. package/resources/inbound-wire-drawdown-requests.ts +0 -1
  479. package/resources/index.ts +28 -0
  480. package/resources/limits.ts +0 -1
  481. package/resources/oauth-connections.ts +0 -1
  482. package/resources/pending-transactions.ts +126 -48
  483. package/resources/programs.ts +70 -0
  484. package/resources/real-time-decisions.ts +43 -8
  485. package/resources/real-time-payments-transfers.ts +351 -0
  486. package/resources/simulations/ach-transfers.ts +504 -192
  487. package/resources/simulations/cards.ts +206 -69
  488. package/resources/simulations/check-transfers.ts +19 -0
  489. package/resources/simulations/index.ts +4 -0
  490. package/resources/simulations/interest-payments.ts +1501 -0
  491. package/resources/simulations/programs.ts +26 -0
  492. package/resources/simulations/real-time-payments-transfers.ts +512 -190
  493. package/resources/simulations/simulations.ts +4 -0
  494. package/resources/simulations/wire-transfers.ts +354 -165
  495. package/resources/transactions.ts +379 -202
  496. package/resources/wire-drawdown-requests.ts +4 -1
  497. package/resources/wire-transfers.ts +43 -6
  498. package/streaming.ts +199 -0
  499. package/tests/api-resources/account-numbers.test.ts +22 -25
  500. package/tests/api-resources/account-statements.test.ts +4 -17
  501. package/tests/api-resources/account-transfers.test.ts +13 -26
  502. package/tests/api-resources/accounts.test.ts +19 -20
  503. package/tests/api-resources/ach-prenotifications.test.ts +9 -21
  504. package/tests/api-resources/ach-transfers.test.ts +14 -28
  505. package/tests/api-resources/balance-lookups.test.ts +18 -0
  506. package/tests/api-resources/bookkeeping-accounts.test.ts +38 -0
  507. package/tests/api-resources/bookkeeping-entries.test.ts +25 -0
  508. package/tests/api-resources/bookkeeping-entry-sets.test.ts +29 -0
  509. package/tests/api-resources/card-disputes.test.ts +15 -21
  510. package/tests/api-resources/card-profiles.test.ts +25 -16
  511. package/tests/api-resources/cards.test.ts +10 -32
  512. package/tests/api-resources/check-deposits.test.ts +21 -24
  513. package/tests/api-resources/check-transfers.test.ts +24 -37
  514. package/tests/api-resources/declined-transactions.test.ts +6 -20
  515. package/tests/api-resources/digital-wallet-tokens.test.ts +5 -18
  516. package/tests/api-resources/documents.test.ts +8 -20
  517. package/tests/api-resources/entities/entities.test.ts +37 -31
  518. package/tests/api-resources/entities/supplemental-documents.test.ts +22 -3
  519. package/tests/api-resources/event-subscriptions.test.ts +7 -17
  520. package/tests/api-resources/events.test.ts +5 -19
  521. package/tests/api-resources/exports.test.ts +64 -0
  522. package/tests/api-resources/external-accounts.test.ts +10 -24
  523. package/tests/api-resources/files.test.ts +5 -19
  524. package/tests/api-resources/groups.test.ts +3 -2
  525. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +13 -9
  526. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +3 -6
  527. package/tests/api-resources/limits.test.ts +11 -14
  528. package/tests/api-resources/oauth-connections.test.ts +3 -6
  529. package/tests/api-resources/pending-transactions.test.ts +10 -14
  530. package/tests/api-resources/programs.test.ts +36 -0
  531. package/tests/api-resources/real-time-decisions.test.ts +3 -13
  532. package/tests/api-resources/real-time-payments-transfers.test.ts +76 -0
  533. package/tests/api-resources/routing-numbers.test.ts +3 -2
  534. package/tests/api-resources/simulations/account-statements.test.ts +8 -5
  535. package/tests/api-resources/simulations/account-transfers.test.ts +2 -1
  536. package/tests/api-resources/simulations/ach-transfers.test.ts +10 -16
  537. package/tests/api-resources/simulations/card-disputes.test.ts +5 -4
  538. package/tests/api-resources/simulations/card-refunds.test.ts +8 -5
  539. package/tests/api-resources/simulations/cards.test.ts +9 -7
  540. package/tests/api-resources/simulations/check-deposits.test.ts +2 -1
  541. package/tests/api-resources/simulations/check-transfers.test.ts +14 -1
  542. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +8 -5
  543. package/tests/api-resources/simulations/documents.test.ts +7 -4
  544. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +26 -25
  545. package/tests/api-resources/simulations/interest-payments.test.ts +15 -0
  546. package/tests/api-resources/simulations/programs.test.ts +15 -0
  547. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +17 -9
  548. package/tests/api-resources/simulations/wire-transfers.test.ts +8 -7
  549. package/tests/api-resources/transactions.test.ts +8 -25
  550. package/tests/api-resources/wire-drawdown-requests.test.ts +17 -20
  551. package/tests/api-resources/wire-transfers.test.ts +19 -33
  552. package/tests/index.test.ts +30 -1
  553. package/tsconfig.json +2 -0
  554. package/version.ts +1 -1
@@ -3,8 +3,8 @@
3
3
  import * as Core from '~/core';
4
4
  import { APIResource } from '~/resource';
5
5
  import { isRequestOptions } from '~/core';
6
- import { Page, PageParams } from '~/pagination';
7
6
  import { SupplementalDocuments } from './supplemental-documents';
7
+ import { Page, PageParams } from '~/pagination';
8
8
 
9
9
  export class Entities extends APIResource {
10
10
  supplementalDocuments: SupplementalDocuments = new SupplementalDocuments(this.client);
@@ -35,7 +35,6 @@ export class Entities extends APIResource {
35
35
  if (isRequestOptions(query)) {
36
36
  return this.list({}, query);
37
37
  }
38
-
39
38
  return this.getAPIList('/entities', EntitiesPage, { query, ...options });
40
39
  }
41
40
  }
@@ -85,7 +84,9 @@ export interface Entity {
85
84
  structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
86
85
 
87
86
  /**
88
- * Additional documentation associated with the entity.
87
+ * Additional documentation associated with the entity. This is limited to the
88
+ * first 10 documents for an entity. If an entity has more than 10 documents, use
89
+ * the GET /entity_supplemental_documents list endpoint to retrieve them.
89
90
  */
90
91
  supplemental_documents: Array<Entity.SupplementalDocuments>;
91
92
 
@@ -102,6 +103,10 @@ export interface Entity {
102
103
  }
103
104
 
104
105
  export namespace Entity {
106
+ /**
107
+ * Details of the corporation entity. Will be present if `structure` is equal to
108
+ * `corporation`.
109
+ */
105
110
  export interface Corporation {
106
111
  /**
107
112
  * The corporation's address.
@@ -137,6 +142,9 @@ export namespace Entity {
137
142
  }
138
143
 
139
144
  export namespace Corporation {
145
+ /**
146
+ * The corporation's address.
147
+ */
140
148
  export interface Address {
141
149
  /**
142
150
  * The city of the address.
@@ -183,6 +191,9 @@ export namespace Entity {
183
191
  }
184
192
 
185
193
  export namespace BeneficialOwners {
194
+ /**
195
+ * Personal details for the beneficial owner.
196
+ */
186
197
  export interface Individual {
187
198
  /**
188
199
  * The person's address.
@@ -206,6 +217,9 @@ export namespace Entity {
206
217
  }
207
218
 
208
219
  export namespace Individual {
220
+ /**
221
+ * The person's address.
222
+ */
209
223
  export interface Address {
210
224
  /**
211
225
  * The city of the address.
@@ -234,6 +248,9 @@ export namespace Entity {
234
248
  zip: string;
235
249
  }
236
250
 
251
+ /**
252
+ * A means of verifying the person's identity.
253
+ */
237
254
  export interface Identification {
238
255
  /**
239
256
  * A method that can be used to verify the individual's identity.
@@ -255,6 +272,10 @@ export namespace Entity {
255
272
  }
256
273
  }
257
274
 
275
+ /**
276
+ * Details of the natural person entity. Will be present if `structure` is equal to
277
+ * `natural_person`.
278
+ */
258
279
  export interface NaturalPerson {
259
280
  /**
260
281
  * The person's address.
@@ -278,6 +299,9 @@ export namespace Entity {
278
299
  }
279
300
 
280
301
  export namespace NaturalPerson {
302
+ /**
303
+ * The person's address.
304
+ */
281
305
  export interface Address {
282
306
  /**
283
307
  * The city of the address.
@@ -306,6 +330,9 @@ export namespace Entity {
306
330
  zip: string;
307
331
  }
308
332
 
333
+ /**
334
+ * A means of verifying the person's identity.
335
+ */
309
336
  export interface Identification {
310
337
  /**
311
338
  * A method that can be used to verify the individual's identity.
@@ -325,6 +352,9 @@ export namespace Entity {
325
352
  }
326
353
  }
327
354
 
355
+ /**
356
+ * Details of the joint entity. Will be present if `structure` is equal to `joint`.
357
+ */
328
358
  export interface Joint {
329
359
  /**
330
360
  * The two individuals that share control of the entity.
@@ -361,6 +391,9 @@ export namespace Entity {
361
391
  }
362
392
 
363
393
  export namespace Individuals {
394
+ /**
395
+ * The person's address.
396
+ */
364
397
  export interface Address {
365
398
  /**
366
399
  * The city of the address.
@@ -389,6 +422,9 @@ export namespace Entity {
389
422
  zip: string;
390
423
  }
391
424
 
425
+ /**
426
+ * A means of verifying the person's identity.
427
+ */
392
428
  export interface Identification {
393
429
  /**
394
430
  * A method that can be used to verify the individual's identity.
@@ -409,6 +445,9 @@ export namespace Entity {
409
445
  }
410
446
  }
411
447
 
448
+ /**
449
+ * Details of the trust entity. Will be present if `structure` is equal to `trust`.
450
+ */
412
451
  export interface Trust {
413
452
  /**
414
453
  * The trust's address.
@@ -453,6 +492,9 @@ export namespace Entity {
453
492
  }
454
493
 
455
494
  export namespace Trust {
495
+ /**
496
+ * The trust's address.
497
+ */
456
498
  export interface Address {
457
499
  /**
458
500
  * The city of the address.
@@ -495,6 +537,10 @@ export namespace Entity {
495
537
  }
496
538
 
497
539
  export namespace Trustees {
540
+ /**
541
+ * The individual trustee of the trust. Will be present if the trustee's
542
+ * `structure` is equal to `individual`.
543
+ */
498
544
  export interface Individual {
499
545
  /**
500
546
  * The person's address.
@@ -518,6 +564,9 @@ export namespace Entity {
518
564
  }
519
565
 
520
566
  export namespace Individual {
567
+ /**
568
+ * The person's address.
569
+ */
521
570
  export interface Address {
522
571
  /**
523
572
  * The city of the address.
@@ -546,6 +595,9 @@ export namespace Entity {
546
595
  zip: string;
547
596
  }
548
597
 
598
+ /**
599
+ * A means of verifying the person's identity.
600
+ */
549
601
  export interface Identification {
550
602
  /**
551
603
  * A method that can be used to verify the individual's identity.
@@ -566,6 +618,9 @@ export namespace Entity {
566
618
  }
567
619
  }
568
620
 
621
+ /**
622
+ * The grantor of the trust. Will be present if the `category` is `revocable`.
623
+ */
569
624
  export interface Grantor {
570
625
  /**
571
626
  * The person's address.
@@ -589,6 +644,9 @@ export namespace Entity {
589
644
  }
590
645
 
591
646
  export namespace Grantor {
647
+ /**
648
+ * The person's address.
649
+ */
592
650
  export interface Address {
593
651
  /**
594
652
  * The city of the address.
@@ -617,6 +675,9 @@ export namespace Entity {
617
675
  zip: string;
618
676
  }
619
677
 
678
+ /**
679
+ * A means of verifying the person's identity.
680
+ */
620
681
  export interface Identification {
621
682
  /**
622
683
  * A method that can be used to verify the individual's identity.
@@ -637,11 +698,27 @@ export namespace Entity {
637
698
  }
638
699
  }
639
700
 
701
+ /**
702
+ * Supplemental Documents are uploaded files connected to an Entity during
703
+ * onboarding.
704
+ */
640
705
  export interface SupplementalDocuments {
706
+ /**
707
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
708
+ * Supplemental Document was created.
709
+ */
710
+ created_at: string;
711
+
641
712
  /**
642
713
  * The File containing the document.
643
714
  */
644
715
  file_id: string;
716
+
717
+ /**
718
+ * A constant representing the object's type. For this resource it will always be
719
+ * `entity_supplemental_document`.
720
+ */
721
+ type: 'entity_supplemental_document';
645
722
  }
646
723
  }
647
724
 
@@ -694,6 +771,10 @@ export interface EntityCreateParams {
694
771
  }
695
772
 
696
773
  export namespace EntityCreateParams {
774
+ /**
775
+ * Details of the corporation entity to create. Required if `structure` is equal to
776
+ * `corporation`.
777
+ */
697
778
  export interface Corporation {
698
779
  /**
699
780
  * The corporation's address.
@@ -729,6 +810,9 @@ export namespace EntityCreateParams {
729
810
  }
730
811
 
731
812
  export namespace Corporation {
813
+ /**
814
+ * The corporation's address.
815
+ */
732
816
  export interface Address {
733
817
  /**
734
818
  * The city of the address.
@@ -775,6 +859,9 @@ export namespace EntityCreateParams {
775
859
  }
776
860
 
777
861
  export namespace BeneficialOwners {
862
+ /**
863
+ * Personal details for the beneficial owner.
864
+ */
778
865
  export interface Individual {
779
866
  /**
780
867
  * The individual's address.
@@ -806,6 +893,9 @@ export namespace EntityCreateParams {
806
893
  }
807
894
 
808
895
  export namespace Individual {
896
+ /**
897
+ * The individual's address.
898
+ */
809
899
  export interface Address {
810
900
  /**
811
901
  * The city of the address.
@@ -834,6 +924,9 @@ export namespace EntityCreateParams {
834
924
  line2?: string;
835
925
  }
836
926
 
927
+ /**
928
+ * A means of verifying the person's identity.
929
+ */
837
930
  export interface Identification {
838
931
  /**
839
932
  * A method that can be used to verify the individual's identity.
@@ -871,6 +964,10 @@ export namespace EntityCreateParams {
871
964
  }
872
965
 
873
966
  export namespace Identification {
967
+ /**
968
+ * Information about the passport used for identification. Required if `method` is
969
+ * equal to `passport`.
970
+ */
874
971
  export interface Passport {
875
972
  /**
876
973
  * The country that issued the passport.
@@ -888,6 +985,10 @@ export namespace EntityCreateParams {
888
985
  file_id: string;
889
986
  }
890
987
 
988
+ /**
989
+ * Information about the United States driver's license used for identification.
990
+ * Required if `method` is equal to `drivers_license`.
991
+ */
891
992
  export interface DriversLicense {
892
993
  /**
893
994
  * The driver's license's expiration date in YYYY-MM-DD format.
@@ -905,6 +1006,10 @@ export namespace EntityCreateParams {
905
1006
  state: string;
906
1007
  }
907
1008
 
1009
+ /**
1010
+ * Information about the identification document provided. Required if `method` is
1011
+ * equal to `other`.
1012
+ */
908
1013
  export interface Other {
909
1014
  /**
910
1015
  * The two-character ISO 3166-1 code representing the country that issued the
@@ -932,261 +1037,116 @@ export namespace EntityCreateParams {
932
1037
  }
933
1038
  }
934
1039
 
935
- export interface NaturalPerson {
936
- /**
937
- * The individual's address.
938
- */
939
- address: NaturalPerson.Address;
940
-
941
- /**
942
- * The person's date of birth in YYYY-MM-DD format.
943
- */
944
- date_of_birth: string;
945
-
946
- /**
947
- * A means of verifying the person's identity.
948
- */
949
- identification: NaturalPerson.Identification;
950
-
1040
+ /**
1041
+ * Details of the joint entity to create. Required if `structure` is equal to
1042
+ * `joint`.
1043
+ */
1044
+ export interface Joint {
951
1045
  /**
952
- * The person's legal name.
1046
+ * The two individuals that share control of the entity.
953
1047
  */
954
- name: string;
1048
+ individuals: Array<Joint.Individuals>;
955
1049
 
956
1050
  /**
957
- * The identification method for an individual can only be a passport, driver's
958
- * license, or other document if you've confirmed the individual does not have a US
959
- * tax id (either a Social Security Number or Individual Taxpayer Identification
960
- * Number).
1051
+ * The name of the joint entity.
961
1052
  */
962
- confirmed_no_us_tax_id?: boolean;
1053
+ name?: string;
963
1054
  }
964
1055
 
965
- export namespace NaturalPerson {
966
- export interface Address {
1056
+ export namespace Joint {
1057
+ export interface Individuals {
967
1058
  /**
968
- * The city of the address.
1059
+ * The individual's address.
969
1060
  */
970
- city: string;
1061
+ address: Individuals.Address;
971
1062
 
972
1063
  /**
973
- * The first line of the address. This is usually the street number and street.
1064
+ * The person's date of birth in YYYY-MM-DD format.
974
1065
  */
975
- line1: string;
1066
+ date_of_birth: string;
976
1067
 
977
1068
  /**
978
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
979
- * the address.
1069
+ * A means of verifying the person's identity.
980
1070
  */
981
- state: string;
1071
+ identification: Individuals.Identification;
982
1072
 
983
1073
  /**
984
- * The ZIP code of the address.
1074
+ * The person's legal name.
985
1075
  */
986
- zip: string;
1076
+ name: string;
987
1077
 
988
1078
  /**
989
- * The second line of the address. This might be the floor or room number.
1079
+ * The identification method for an individual can only be a passport, driver's
1080
+ * license, or other document if you've confirmed the individual does not have a US
1081
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
1082
+ * Number).
990
1083
  */
991
- line2?: string;
1084
+ confirmed_no_us_tax_id?: boolean;
992
1085
  }
993
1086
 
994
- export interface Identification {
995
- /**
996
- * A method that can be used to verify the individual's identity.
997
- */
998
- method:
999
- | 'social_security_number'
1000
- | 'individual_taxpayer_identification_number'
1001
- | 'passport'
1002
- | 'drivers_license'
1003
- | 'other';
1004
-
1005
- /**
1006
- * An identification number that can be used to verify the individual's identity,
1007
- * such as a social security number.
1008
- */
1009
- number: string;
1010
-
1011
- /**
1012
- * Information about the United States driver's license used for identification.
1013
- * Required if `method` is equal to `drivers_license`.
1014
- */
1015
- drivers_license?: Identification.DriversLicense;
1016
-
1017
- /**
1018
- * Information about the identification document provided. Required if `method` is
1019
- * equal to `other`.
1020
- */
1021
- other?: Identification.Other;
1022
-
1087
+ export namespace Individuals {
1023
1088
  /**
1024
- * Information about the passport used for identification. Required if `method` is
1025
- * equal to `passport`.
1089
+ * The individual's address.
1026
1090
  */
1027
- passport?: Identification.Passport;
1028
- }
1029
-
1030
- export namespace Identification {
1031
- export interface Passport {
1091
+ export interface Address {
1032
1092
  /**
1033
- * The country that issued the passport.
1093
+ * The city of the address.
1034
1094
  */
1035
- country: string;
1095
+ city: string;
1036
1096
 
1037
1097
  /**
1038
- * The passport's expiration date in YYYY-MM-DD format.
1098
+ * The first line of the address. This is usually the street number and street.
1039
1099
  */
1040
- expiration_date: string;
1100
+ line1: string;
1041
1101
 
1042
1102
  /**
1043
- * The identifier of the File containing the passport.
1103
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1104
+ * the address.
1044
1105
  */
1045
- file_id: string;
1046
- }
1106
+ state: string;
1047
1107
 
1048
- export interface DriversLicense {
1049
1108
  /**
1050
- * The driver's license's expiration date in YYYY-MM-DD format.
1109
+ * The ZIP code of the address.
1051
1110
  */
1052
- expiration_date: string;
1111
+ zip: string;
1053
1112
 
1054
1113
  /**
1055
- * The identifier of the File containing the driver's license.
1114
+ * The second line of the address. This might be the floor or room number.
1056
1115
  */
1057
- file_id: string;
1116
+ line2?: string;
1117
+ }
1058
1118
 
1119
+ /**
1120
+ * A means of verifying the person's identity.
1121
+ */
1122
+ export interface Identification {
1059
1123
  /**
1060
- * The state that issued the provided driver's license.
1124
+ * A method that can be used to verify the individual's identity.
1061
1125
  */
1062
- state: string;
1063
- }
1126
+ method:
1127
+ | 'social_security_number'
1128
+ | 'individual_taxpayer_identification_number'
1129
+ | 'passport'
1130
+ | 'drivers_license'
1131
+ | 'other';
1064
1132
 
1065
- export interface Other {
1066
1133
  /**
1067
- * The two-character ISO 3166-1 code representing the country that issued the
1068
- * document.
1134
+ * An identification number that can be used to verify the individual's identity,
1135
+ * such as a social security number.
1069
1136
  */
1070
- country: string;
1137
+ number: string;
1071
1138
 
1072
1139
  /**
1073
- * A description of the document submitted.
1140
+ * Information about the United States driver's license used for identification.
1141
+ * Required if `method` is equal to `drivers_license`.
1074
1142
  */
1075
- description: string;
1143
+ drivers_license?: Identification.DriversLicense;
1076
1144
 
1077
1145
  /**
1078
- * The identifier of the File containing the document.
1146
+ * Information about the identification document provided. Required if `method` is
1147
+ * equal to `other`.
1079
1148
  */
1080
- file_id: string;
1081
-
1082
- /**
1083
- * The document's expiration date in YYYY-MM-DD format.
1084
- */
1085
- expiration_date?: string;
1086
- }
1087
- }
1088
- }
1089
-
1090
- export interface Joint {
1091
- /**
1092
- * The two individuals that share control of the entity.
1093
- */
1094
- individuals: Array<Joint.Individuals>;
1095
-
1096
- /**
1097
- * The name of the joint entity.
1098
- */
1099
- name?: string;
1100
- }
1101
-
1102
- export namespace Joint {
1103
- export interface Individuals {
1104
- /**
1105
- * The individual's address.
1106
- */
1107
- address: Individuals.Address;
1108
-
1109
- /**
1110
- * The person's date of birth in YYYY-MM-DD format.
1111
- */
1112
- date_of_birth: string;
1113
-
1114
- /**
1115
- * A means of verifying the person's identity.
1116
- */
1117
- identification: Individuals.Identification;
1118
-
1119
- /**
1120
- * The person's legal name.
1121
- */
1122
- name: string;
1123
-
1124
- /**
1125
- * The identification method for an individual can only be a passport, driver's
1126
- * license, or other document if you've confirmed the individual does not have a US
1127
- * tax id (either a Social Security Number or Individual Taxpayer Identification
1128
- * Number).
1129
- */
1130
- confirmed_no_us_tax_id?: boolean;
1131
- }
1132
-
1133
- export namespace Individuals {
1134
- export interface Address {
1135
- /**
1136
- * The city of the address.
1137
- */
1138
- city: string;
1139
-
1140
- /**
1141
- * The first line of the address. This is usually the street number and street.
1142
- */
1143
- line1: string;
1144
-
1145
- /**
1146
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1147
- * the address.
1148
- */
1149
- state: string;
1150
-
1151
- /**
1152
- * The ZIP code of the address.
1153
- */
1154
- zip: string;
1155
-
1156
- /**
1157
- * The second line of the address. This might be the floor or room number.
1158
- */
1159
- line2?: string;
1160
- }
1161
-
1162
- export interface Identification {
1163
- /**
1164
- * A method that can be used to verify the individual's identity.
1165
- */
1166
- method:
1167
- | 'social_security_number'
1168
- | 'individual_taxpayer_identification_number'
1169
- | 'passport'
1170
- | 'drivers_license'
1171
- | 'other';
1172
-
1173
- /**
1174
- * An identification number that can be used to verify the individual's identity,
1175
- * such as a social security number.
1176
- */
1177
- number: string;
1178
-
1179
- /**
1180
- * Information about the United States driver's license used for identification.
1181
- * Required if `method` is equal to `drivers_license`.
1182
- */
1183
- drivers_license?: Identification.DriversLicense;
1184
-
1185
- /**
1186
- * Information about the identification document provided. Required if `method` is
1187
- * equal to `other`.
1188
- */
1189
- other?: Identification.Other;
1149
+ other?: Identification.Other;
1190
1150
 
1191
1151
  /**
1192
1152
  * Information about the passport used for identification. Required if `method` is
@@ -1196,6 +1156,10 @@ export namespace EntityCreateParams {
1196
1156
  }
1197
1157
 
1198
1158
  export namespace Identification {
1159
+ /**
1160
+ * Information about the passport used for identification. Required if `method` is
1161
+ * equal to `passport`.
1162
+ */
1199
1163
  export interface Passport {
1200
1164
  /**
1201
1165
  * The country that issued the passport.
@@ -1213,6 +1177,10 @@ export namespace EntityCreateParams {
1213
1177
  file_id: string;
1214
1178
  }
1215
1179
 
1180
+ /**
1181
+ * Information about the United States driver's license used for identification.
1182
+ * Required if `method` is equal to `drivers_license`.
1183
+ */
1216
1184
  export interface DriversLicense {
1217
1185
  /**
1218
1186
  * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1230,6 +1198,10 @@ export namespace EntityCreateParams {
1230
1198
  state: string;
1231
1199
  }
1232
1200
 
1201
+ /**
1202
+ * Information about the identification document provided. Required if `method` is
1203
+ * equal to `other`.
1204
+ */
1233
1205
  export interface Other {
1234
1206
  /**
1235
1207
  * The two-character ISO 3166-1 code representing the country that issued the
@@ -1256,6 +1228,196 @@ export namespace EntityCreateParams {
1256
1228
  }
1257
1229
  }
1258
1230
 
1231
+ /**
1232
+ * Details of the natural person entity to create. Required if `structure` is equal
1233
+ * to `natural_person`. Natural people entities should be submitted with
1234
+ * `social_security_number` or `individual_taxpayer_identification_number`
1235
+ * identification methods.
1236
+ */
1237
+ export interface NaturalPerson {
1238
+ /**
1239
+ * The individual's address.
1240
+ */
1241
+ address: NaturalPerson.Address;
1242
+
1243
+ /**
1244
+ * The person's date of birth in YYYY-MM-DD format.
1245
+ */
1246
+ date_of_birth: string;
1247
+
1248
+ /**
1249
+ * A means of verifying the person's identity.
1250
+ */
1251
+ identification: NaturalPerson.Identification;
1252
+
1253
+ /**
1254
+ * The person's legal name.
1255
+ */
1256
+ name: string;
1257
+
1258
+ /**
1259
+ * The identification method for an individual can only be a passport, driver's
1260
+ * license, or other document if you've confirmed the individual does not have a US
1261
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
1262
+ * Number).
1263
+ */
1264
+ confirmed_no_us_tax_id?: boolean;
1265
+ }
1266
+
1267
+ export namespace NaturalPerson {
1268
+ /**
1269
+ * The individual's address.
1270
+ */
1271
+ export interface Address {
1272
+ /**
1273
+ * The city of the address.
1274
+ */
1275
+ city: string;
1276
+
1277
+ /**
1278
+ * The first line of the address. This is usually the street number and street.
1279
+ */
1280
+ line1: string;
1281
+
1282
+ /**
1283
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1284
+ * the address.
1285
+ */
1286
+ state: string;
1287
+
1288
+ /**
1289
+ * The ZIP code of the address.
1290
+ */
1291
+ zip: string;
1292
+
1293
+ /**
1294
+ * The second line of the address. This might be the floor or room number.
1295
+ */
1296
+ line2?: string;
1297
+ }
1298
+
1299
+ /**
1300
+ * A means of verifying the person's identity.
1301
+ */
1302
+ export interface Identification {
1303
+ /**
1304
+ * A method that can be used to verify the individual's identity.
1305
+ */
1306
+ method:
1307
+ | 'social_security_number'
1308
+ | 'individual_taxpayer_identification_number'
1309
+ | 'passport'
1310
+ | 'drivers_license'
1311
+ | 'other';
1312
+
1313
+ /**
1314
+ * An identification number that can be used to verify the individual's identity,
1315
+ * such as a social security number.
1316
+ */
1317
+ number: string;
1318
+
1319
+ /**
1320
+ * Information about the United States driver's license used for identification.
1321
+ * Required if `method` is equal to `drivers_license`.
1322
+ */
1323
+ drivers_license?: Identification.DriversLicense;
1324
+
1325
+ /**
1326
+ * Information about the identification document provided. Required if `method` is
1327
+ * equal to `other`.
1328
+ */
1329
+ other?: Identification.Other;
1330
+
1331
+ /**
1332
+ * Information about the passport used for identification. Required if `method` is
1333
+ * equal to `passport`.
1334
+ */
1335
+ passport?: Identification.Passport;
1336
+ }
1337
+
1338
+ export namespace Identification {
1339
+ /**
1340
+ * Information about the passport used for identification. Required if `method` is
1341
+ * equal to `passport`.
1342
+ */
1343
+ export interface Passport {
1344
+ /**
1345
+ * The country that issued the passport.
1346
+ */
1347
+ country: string;
1348
+
1349
+ /**
1350
+ * The passport's expiration date in YYYY-MM-DD format.
1351
+ */
1352
+ expiration_date: string;
1353
+
1354
+ /**
1355
+ * The identifier of the File containing the passport.
1356
+ */
1357
+ file_id: string;
1358
+ }
1359
+
1360
+ /**
1361
+ * Information about the United States driver's license used for identification.
1362
+ * Required if `method` is equal to `drivers_license`.
1363
+ */
1364
+ export interface DriversLicense {
1365
+ /**
1366
+ * The driver's license's expiration date in YYYY-MM-DD format.
1367
+ */
1368
+ expiration_date: string;
1369
+
1370
+ /**
1371
+ * The identifier of the File containing the driver's license.
1372
+ */
1373
+ file_id: string;
1374
+
1375
+ /**
1376
+ * The state that issued the provided driver's license.
1377
+ */
1378
+ state: string;
1379
+ }
1380
+
1381
+ /**
1382
+ * Information about the identification document provided. Required if `method` is
1383
+ * equal to `other`.
1384
+ */
1385
+ export interface Other {
1386
+ /**
1387
+ * The two-character ISO 3166-1 code representing the country that issued the
1388
+ * document.
1389
+ */
1390
+ country: string;
1391
+
1392
+ /**
1393
+ * A description of the document submitted.
1394
+ */
1395
+ description: string;
1396
+
1397
+ /**
1398
+ * The identifier of the File containing the document.
1399
+ */
1400
+ file_id: string;
1401
+
1402
+ /**
1403
+ * The document's expiration date in YYYY-MM-DD format.
1404
+ */
1405
+ expiration_date?: string;
1406
+ }
1407
+ }
1408
+ }
1409
+
1410
+ export interface SupplementalDocuments {
1411
+ /**
1412
+ * The identifier of the File containing the document.
1413
+ */
1414
+ file_id: string;
1415
+ }
1416
+
1417
+ /**
1418
+ * Details of the trust entity to create. Required if `structure` is equal to
1419
+ * `trust`.
1420
+ */
1259
1421
  export interface Trust {
1260
1422
  /**
1261
1423
  * The trust's address.
@@ -1303,6 +1465,9 @@ export namespace EntityCreateParams {
1303
1465
  }
1304
1466
 
1305
1467
  export namespace Trust {
1468
+ /**
1469
+ * The trust's address.
1470
+ */
1306
1471
  export interface Address {
1307
1472
  /**
1308
1473
  * The city of the address.
@@ -1345,6 +1510,10 @@ export namespace EntityCreateParams {
1345
1510
  }
1346
1511
 
1347
1512
  export namespace Trustees {
1513
+ /**
1514
+ * Details of the individual trustee. Required when the trustee `structure` is
1515
+ * equal to `individual`.
1516
+ */
1348
1517
  export interface Individual {
1349
1518
  /**
1350
1519
  * The individual's address.
@@ -1376,6 +1545,9 @@ export namespace EntityCreateParams {
1376
1545
  }
1377
1546
 
1378
1547
  export namespace Individual {
1548
+ /**
1549
+ * The individual's address.
1550
+ */
1379
1551
  export interface Address {
1380
1552
  /**
1381
1553
  * The city of the address.
@@ -1404,6 +1576,9 @@ export namespace EntityCreateParams {
1404
1576
  line2?: string;
1405
1577
  }
1406
1578
 
1579
+ /**
1580
+ * A means of verifying the person's identity.
1581
+ */
1407
1582
  export interface Identification {
1408
1583
  /**
1409
1584
  * A method that can be used to verify the individual's identity.
@@ -1441,6 +1616,10 @@ export namespace EntityCreateParams {
1441
1616
  }
1442
1617
 
1443
1618
  export namespace Identification {
1619
+ /**
1620
+ * Information about the passport used for identification. Required if `method` is
1621
+ * equal to `passport`.
1622
+ */
1444
1623
  export interface Passport {
1445
1624
  /**
1446
1625
  * The country that issued the passport.
@@ -1458,6 +1637,10 @@ export namespace EntityCreateParams {
1458
1637
  file_id: string;
1459
1638
  }
1460
1639
 
1640
+ /**
1641
+ * Information about the United States driver's license used for identification.
1642
+ * Required if `method` is equal to `drivers_license`.
1643
+ */
1461
1644
  export interface DriversLicense {
1462
1645
  /**
1463
1646
  * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1475,6 +1658,10 @@ export namespace EntityCreateParams {
1475
1658
  state: string;
1476
1659
  }
1477
1660
 
1661
+ /**
1662
+ * Information about the identification document provided. Required if `method` is
1663
+ * equal to `other`.
1664
+ */
1478
1665
  export interface Other {
1479
1666
  /**
1480
1667
  * The two-character ISO 3166-1 code representing the country that issued the
@@ -1501,6 +1688,9 @@ export namespace EntityCreateParams {
1501
1688
  }
1502
1689
  }
1503
1690
 
1691
+ /**
1692
+ * The grantor of the trust. Required if `category` is equal to `revocable`.
1693
+ */
1504
1694
  export interface Grantor {
1505
1695
  /**
1506
1696
  * The individual's address.
@@ -1532,6 +1722,9 @@ export namespace EntityCreateParams {
1532
1722
  }
1533
1723
 
1534
1724
  export namespace Grantor {
1725
+ /**
1726
+ * The individual's address.
1727
+ */
1535
1728
  export interface Address {
1536
1729
  /**
1537
1730
  * The city of the address.
@@ -1560,6 +1753,9 @@ export namespace EntityCreateParams {
1560
1753
  line2?: string;
1561
1754
  }
1562
1755
 
1756
+ /**
1757
+ * A means of verifying the person's identity.
1758
+ */
1563
1759
  export interface Identification {
1564
1760
  /**
1565
1761
  * A method that can be used to verify the individual's identity.
@@ -1597,6 +1793,10 @@ export namespace EntityCreateParams {
1597
1793
  }
1598
1794
 
1599
1795
  export namespace Identification {
1796
+ /**
1797
+ * Information about the passport used for identification. Required if `method` is
1798
+ * equal to `passport`.
1799
+ */
1600
1800
  export interface Passport {
1601
1801
  /**
1602
1802
  * The country that issued the passport.
@@ -1614,6 +1814,10 @@ export namespace EntityCreateParams {
1614
1814
  file_id: string;
1615
1815
  }
1616
1816
 
1817
+ /**
1818
+ * Information about the United States driver's license used for identification.
1819
+ * Required if `method` is equal to `drivers_license`.
1820
+ */
1617
1821
  export interface DriversLicense {
1618
1822
  /**
1619
1823
  * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1631,6 +1835,10 @@ export namespace EntityCreateParams {
1631
1835
  state: string;
1632
1836
  }
1633
1837
 
1838
+ /**
1839
+ * Information about the identification document provided. Required if `method` is
1840
+ * equal to `other`.
1841
+ */
1634
1842
  export interface Other {
1635
1843
  /**
1636
1844
  * The two-character ISO 3166-1 code representing the country that issued the
@@ -1656,13 +1864,36 @@ export namespace EntityCreateParams {
1656
1864
  }
1657
1865
  }
1658
1866
  }
1867
+ }
1659
1868
 
1660
- export interface SupplementalDocuments {
1869
+ export interface EntityListParams extends PageParams {
1870
+ created_at?: EntityListParams.CreatedAt;
1871
+ }
1872
+
1873
+ export namespace EntityListParams {
1874
+ export interface CreatedAt {
1661
1875
  /**
1662
- * The identifier of the File containing the document.
1876
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1877
+ * timestamp.
1663
1878
  */
1664
- file_id: string;
1879
+ after?: string;
1880
+
1881
+ /**
1882
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1883
+ * timestamp.
1884
+ */
1885
+ before?: string;
1886
+
1887
+ /**
1888
+ * Return results on or after this
1889
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1890
+ */
1891
+ on_or_after?: string;
1892
+
1893
+ /**
1894
+ * Return results on or before this
1895
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1896
+ */
1897
+ on_or_before?: string;
1665
1898
  }
1666
1899
  }
1667
-
1668
- export interface EntityListParams extends PageParams {}