increase 0.1.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 (425) hide show
  1. package/.eslintrc.js +10 -0
  2. package/.prettierrc +6 -0
  3. package/.stats.yml +1 -0
  4. package/LICENSE +201 -0
  5. package/README.md +211 -0
  6. package/api.md +477 -0
  7. package/bin/check-test-server +50 -0
  8. package/build +12 -0
  9. package/check-version.ts +15 -0
  10. package/core.ts +908 -0
  11. package/dist/cjs/check-version.d.ts +1 -0
  12. package/dist/cjs/check-version.js +21 -0
  13. package/dist/cjs/check-version.js.map +1 -0
  14. package/dist/cjs/core.d.ts +262 -0
  15. package/dist/cjs/core.js +978 -0
  16. package/dist/cjs/core.js.map +1 -0
  17. package/dist/cjs/fetch-polyfill.d.ts +5 -0
  18. package/dist/cjs/fetch-polyfill.js +55 -0
  19. package/dist/cjs/fetch-polyfill.js.map +1 -0
  20. package/dist/cjs/index.d.ts +201 -0
  21. package/dist/cjs/index.js +180 -0
  22. package/dist/cjs/index.js.map +1 -0
  23. package/dist/cjs/pagination.d.ts +28 -0
  24. package/dist/cjs/pagination.js +30 -0
  25. package/dist/cjs/pagination.js.map +1 -0
  26. package/dist/cjs/resource.d.ts +11 -0
  27. package/dist/cjs/resource.js +17 -0
  28. package/dist/cjs/resource.js.map +1 -0
  29. package/dist/cjs/resources/account-numbers.d.ts +103 -0
  30. package/dist/cjs/resources/account-numbers.js +37 -0
  31. package/dist/cjs/resources/account-numbers.js.map +1 -0
  32. package/dist/cjs/resources/account-statements.d.ts +99 -0
  33. package/dist/cjs/resources/account-statements.js +25 -0
  34. package/dist/cjs/resources/account-statements.js.map +1 -0
  35. package/dist/cjs/resources/account-transfers.d.ts +189 -0
  36. package/dist/cjs/resources/account-transfers.js +43 -0
  37. package/dist/cjs/resources/account-transfers.js.map +1 -0
  38. package/dist/cjs/resources/accounts.d.ts +133 -0
  39. package/dist/cjs/resources/accounts.js +43 -0
  40. package/dist/cjs/resources/accounts.js.map +1 -0
  41. package/dist/cjs/resources/ach-prenotifications.d.ts +188 -0
  42. package/dist/cjs/resources/ach-prenotifications.js +35 -0
  43. package/dist/cjs/resources/ach-prenotifications.js.map +1 -0
  44. package/dist/cjs/resources/ach-transfers.d.ts +375 -0
  45. package/dist/cjs/resources/ach-transfers.js +43 -0
  46. package/dist/cjs/resources/ach-transfers.js.map +1 -0
  47. package/dist/cjs/resources/card-disputes.d.ts +143 -0
  48. package/dist/cjs/resources/card-disputes.js +31 -0
  49. package/dist/cjs/resources/card-disputes.js.map +1 -0
  50. package/dist/cjs/resources/card-profiles.d.ts +183 -0
  51. package/dist/cjs/resources/card-profiles.js +31 -0
  52. package/dist/cjs/resources/card-profiles.js.map +1 -0
  53. package/dist/cjs/resources/cards.d.ts +316 -0
  54. package/dist/cjs/resources/cards.js +43 -0
  55. package/dist/cjs/resources/cards.js.map +1 -0
  56. package/dist/cjs/resources/check-deposits.d.ts +241 -0
  57. package/dist/cjs/resources/check-deposits.js +31 -0
  58. package/dist/cjs/resources/check-deposits.js.map +1 -0
  59. package/dist/cjs/resources/check-transfers.d.ts +331 -0
  60. package/dist/cjs/resources/check-transfers.js +49 -0
  61. package/dist/cjs/resources/check-transfers.js.map +1 -0
  62. package/dist/cjs/resources/declined-transactions.d.ts +424 -0
  63. package/dist/cjs/resources/declined-transactions.js +29 -0
  64. package/dist/cjs/resources/declined-transactions.js.map +1 -0
  65. package/dist/cjs/resources/digital-wallet-tokens.d.ts +85 -0
  66. package/dist/cjs/resources/digital-wallet-tokens.js +29 -0
  67. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -0
  68. package/dist/cjs/resources/documents.d.ts +87 -0
  69. package/dist/cjs/resources/documents.js +25 -0
  70. package/dist/cjs/resources/documents.js.map +1 -0
  71. package/dist/cjs/resources/entities/entities.d.ts +1383 -0
  72. package/dist/cjs/resources/entities/entities.js +36 -0
  73. package/dist/cjs/resources/entities/entities.js.map +1 -0
  74. package/dist/cjs/resources/entities/index.d.ts +2 -0
  75. package/dist/cjs/resources/entities/index.js +12 -0
  76. package/dist/cjs/resources/entities/index.js.map +1 -0
  77. package/dist/cjs/resources/entities/supplemental-documents.d.ts +19 -0
  78. package/dist/cjs/resources/entities/supplemental-documents.js +15 -0
  79. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -0
  80. package/dist/cjs/resources/event-subscriptions.d.ts +196 -0
  81. package/dist/cjs/resources/event-subscriptions.js +37 -0
  82. package/dist/cjs/resources/event-subscriptions.js.map +1 -0
  83. package/dist/cjs/resources/events.d.ts +183 -0
  84. package/dist/cjs/resources/events.js +25 -0
  85. package/dist/cjs/resources/events.js.map +1 -0
  86. package/dist/cjs/resources/external-accounts.d.ts +121 -0
  87. package/dist/cjs/resources/external-accounts.js +37 -0
  88. package/dist/cjs/resources/external-accounts.js.map +1 -0
  89. package/dist/cjs/resources/files.d.ts +148 -0
  90. package/dist/cjs/resources/files.js +34 -0
  91. package/dist/cjs/resources/files.js.map +1 -0
  92. package/dist/cjs/resources/groups.d.ts +37 -0
  93. package/dist/cjs/resources/groups.js +15 -0
  94. package/dist/cjs/resources/groups.js.map +1 -0
  95. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +106 -0
  96. package/dist/cjs/resources/inbound-ach-transfer-returns.js +35 -0
  97. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -0
  98. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +124 -0
  99. package/dist/cjs/resources/inbound-wire-drawdown-requests.js +29 -0
  100. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -0
  101. package/dist/cjs/resources/index.d.ts +163 -0
  102. package/dist/cjs/resources/index.js +478 -0
  103. package/dist/cjs/resources/index.js.map +1 -0
  104. package/dist/cjs/resources/limits.d.ts +105 -0
  105. package/dist/cjs/resources/limits.js +37 -0
  106. package/dist/cjs/resources/limits.js.map +1 -0
  107. package/dist/cjs/resources/oauth-connections.d.ts +50 -0
  108. package/dist/cjs/resources/oauth-connections.js +25 -0
  109. package/dist/cjs/resources/oauth-connections.js.map +1 -0
  110. package/dist/cjs/resources/pending-transactions.d.ts +397 -0
  111. package/dist/cjs/resources/pending-transactions.js +29 -0
  112. package/dist/cjs/resources/pending-transactions.js.map +1 -0
  113. package/dist/cjs/resources/real-time-decisions.d.ts +289 -0
  114. package/dist/cjs/resources/real-time-decisions.js +21 -0
  115. package/dist/cjs/resources/real-time-decisions.js.map +1 -0
  116. package/dist/cjs/resources/routing-numbers.d.ts +49 -0
  117. package/dist/cjs/resources/routing-numbers.js +21 -0
  118. package/dist/cjs/resources/routing-numbers.js.map +1 -0
  119. package/dist/cjs/resources/shared.d.ts +15 -0
  120. package/dist/cjs/resources/shared.js +4 -0
  121. package/dist/cjs/resources/shared.js.map +1 -0
  122. package/dist/cjs/resources/simulations/account-statements.d.ts +19 -0
  123. package/dist/cjs/resources/simulations/account-statements.js +16 -0
  124. package/dist/cjs/resources/simulations/account-statements.js.map +1 -0
  125. package/dist/cjs/resources/simulations/account-transfers.d.ts +15 -0
  126. package/dist/cjs/resources/simulations/account-transfers.js +18 -0
  127. package/dist/cjs/resources/simulations/account-transfers.js.map +1 -0
  128. package/dist/cjs/resources/simulations/ach-transfers.d.ts +1488 -0
  129. package/dist/cjs/resources/simulations/ach-transfers.js +39 -0
  130. package/dist/cjs/resources/simulations/ach-transfers.js.map +1 -0
  131. package/dist/cjs/resources/simulations/card-disputes.d.ts +26 -0
  132. package/dist/cjs/resources/simulations/card-disputes.js +18 -0
  133. package/dist/cjs/resources/simulations/card-disputes.js.map +1 -0
  134. package/dist/cjs/resources/simulations/card-refunds.d.ts +20 -0
  135. package/dist/cjs/resources/simulations/card-refunds.js +16 -0
  136. package/dist/cjs/resources/simulations/card-refunds.js.map +1 -0
  137. package/dist/cjs/resources/simulations/cards.d.ts +793 -0
  138. package/dist/cjs/resources/simulations/cards.js +31 -0
  139. package/dist/cjs/resources/simulations/cards.js.map +1 -0
  140. package/dist/cjs/resources/simulations/check-deposits.d.ts +30 -0
  141. package/dist/cjs/resources/simulations/check-deposits.js +31 -0
  142. package/dist/cjs/resources/simulations/check-deposits.js.map +1 -0
  143. package/dist/cjs/resources/simulations/check-transfers.d.ts +22 -0
  144. package/dist/cjs/resources/simulations/check-transfers.js +24 -0
  145. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -0
  146. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +43 -0
  147. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js +16 -0
  148. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js.map +1 -0
  149. package/dist/cjs/resources/simulations/documents.d.ts +18 -0
  150. package/dist/cjs/resources/simulations/documents.js +15 -0
  151. package/dist/cjs/resources/simulations/documents.js.map +1 -0
  152. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +101 -0
  153. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js +16 -0
  154. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -0
  155. package/dist/cjs/resources/simulations/index.d.ts +20 -0
  156. package/dist/cjs/resources/simulations/index.js +4 -0
  157. package/dist/cjs/resources/simulations/index.js.map +1 -0
  158. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +1431 -0
  159. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +16 -0
  160. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -0
  161. package/dist/cjs/resources/simulations/simulations.d.ts +29 -0
  162. package/dist/cjs/resources/simulations/simulations.js +44 -0
  163. package/dist/cjs/resources/simulations/simulations.js.map +1 -0
  164. package/dist/cjs/resources/simulations/wire-transfers.d.ts +1104 -0
  165. package/dist/cjs/resources/simulations/wire-transfers.js +15 -0
  166. package/dist/cjs/resources/simulations/wire-transfers.js.map +1 -0
  167. package/dist/cjs/resources/transactions.d.ts +1101 -0
  168. package/dist/cjs/resources/transactions.js +25 -0
  169. package/dist/cjs/resources/transactions.js.map +1 -0
  170. package/dist/cjs/resources/wire-drawdown-requests.d.ts +148 -0
  171. package/dist/cjs/resources/wire-drawdown-requests.js +35 -0
  172. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -0
  173. package/dist/cjs/resources/wire-transfers.d.ts +310 -0
  174. package/dist/cjs/resources/wire-transfers.js +60 -0
  175. package/dist/cjs/resources/wire-transfers.js.map +1 -0
  176. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +1 -0
  177. package/dist/cjs/tests/api-resources/account-numbers.test.js +104 -0
  178. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -0
  179. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +1 -0
  180. package/dist/cjs/tests/api-resources/account-statements.test.js +101 -0
  181. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -0
  182. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +1 -0
  183. package/dist/cjs/tests/api-resources/account-transfers.test.js +146 -0
  184. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -0
  185. package/dist/cjs/tests/api-resources/accounts.test.d.ts +1 -0
  186. package/dist/cjs/tests/api-resources/accounts.test.js +119 -0
  187. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -0
  188. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +1 -0
  189. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +125 -0
  190. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -0
  191. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +1 -0
  192. package/dist/cjs/tests/api-resources/ach-transfers.test.js +159 -0
  193. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -0
  194. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +1 -0
  195. package/dist/cjs/tests/api-resources/card-disputes.test.js +108 -0
  196. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -0
  197. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +1 -0
  198. package/dist/cjs/tests/api-resources/card-profiles.test.js +97 -0
  199. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -0
  200. package/dist/cjs/tests/api-resources/cards.test.d.ts +1 -0
  201. package/dist/cjs/tests/api-resources/cards.test.js +138 -0
  202. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -0
  203. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +1 -0
  204. package/dist/cjs/tests/api-resources/check-deposits.test.js +113 -0
  205. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -0
  206. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +1 -0
  207. package/dist/cjs/tests/api-resources/check-transfers.test.js +172 -0
  208. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -0
  209. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +1 -0
  210. package/dist/cjs/tests/api-resources/declined-transactions.test.js +105 -0
  211. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -0
  212. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +1 -0
  213. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +103 -0
  214. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -0
  215. package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
  216. package/dist/cjs/tests/api-resources/documents.test.js +101 -0
  217. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -0
  218. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +1 -0
  219. package/dist/cjs/tests/api-resources/entities/entities.test.js +280 -0
  220. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -0
  221. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +1 -0
  222. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +49 -0
  223. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -0
  224. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +1 -0
  225. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +109 -0
  226. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -0
  227. package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
  228. package/dist/cjs/tests/api-resources/events.test.js +101 -0
  229. package/dist/cjs/tests/api-resources/events.test.js.map +1 -0
  230. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
  231. package/dist/cjs/tests/api-resources/external-accounts.test.js +113 -0
  232. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -0
  233. package/dist/cjs/tests/api-resources/files.test.d.ts +1 -0
  234. package/dist/cjs/tests/api-resources/files.test.js +117 -0
  235. package/dist/cjs/tests/api-resources/files.test.js.map +1 -0
  236. package/dist/cjs/tests/api-resources/groups.test.d.ts +1 -0
  237. package/dist/cjs/tests/api-resources/groups.test.js +54 -0
  238. package/dist/cjs/tests/api-resources/groups.test.js.map +1 -0
  239. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +1 -0
  240. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +90 -0
  241. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +1 -0
  242. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +1 -0
  243. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +83 -0
  244. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +1 -0
  245. package/dist/cjs/tests/api-resources/limits.test.d.ts +1 -0
  246. package/dist/cjs/tests/api-resources/limits.test.js +100 -0
  247. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -0
  248. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +1 -0
  249. package/dist/cjs/tests/api-resources/oauth-connections.test.js +78 -0
  250. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +1 -0
  251. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +1 -0
  252. package/dist/cjs/tests/api-resources/pending-transactions.test.js +97 -0
  253. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -0
  254. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +1 -0
  255. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +71 -0
  256. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -0
  257. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +1 -0
  258. package/dist/cjs/tests/api-resources/routing-numbers.test.js +55 -0
  259. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -0
  260. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +1 -0
  261. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +49 -0
  262. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +1 -0
  263. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +1 -0
  264. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +60 -0
  265. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +1 -0
  266. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +1 -0
  267. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +92 -0
  268. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -0
  269. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +1 -0
  270. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +56 -0
  271. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -0
  272. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +1 -0
  273. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js +49 -0
  274. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +1 -0
  275. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +1 -0
  276. package/dist/cjs/tests/api-resources/simulations/cards.test.js +70 -0
  277. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -0
  278. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +1 -0
  279. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +86 -0
  280. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +1 -0
  281. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +1 -0
  282. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +73 -0
  283. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +1 -0
  284. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +1 -0
  285. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +49 -0
  286. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +1 -0
  287. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +1 -0
  288. package/dist/cjs/tests/api-resources/simulations/documents.test.js +49 -0
  289. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +1 -0
  290. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +1 -0
  291. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +81 -0
  292. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -0
  293. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +1 -0
  294. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +62 -0
  295. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -0
  296. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +1 -0
  297. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +70 -0
  298. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -0
  299. package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
  300. package/dist/cjs/tests/api-resources/transactions.test.js +109 -0
  301. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -0
  302. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +1 -0
  303. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +110 -0
  304. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -0
  305. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +1 -0
  306. package/dist/cjs/tests/api-resources/wire-transfers.test.js +184 -0
  307. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -0
  308. package/dist/cjs/tests/form.test.d.ts +1 -0
  309. package/dist/cjs/tests/form.test.js +60 -0
  310. package/dist/cjs/tests/form.test.js.map +1 -0
  311. package/dist/cjs/tests/index.test.d.ts +1 -0
  312. package/dist/cjs/tests/index.test.js +44 -0
  313. package/dist/cjs/tests/index.test.js.map +1 -0
  314. package/dist/cjs/tests/responses.test.d.ts +1 -0
  315. package/dist/cjs/tests/responses.test.js +59 -0
  316. package/dist/cjs/tests/responses.test.js.map +1 -0
  317. package/dist/cjs/version.d.ts +1 -0
  318. package/dist/cjs/version.js +5 -0
  319. package/dist/cjs/version.js.map +1 -0
  320. package/fetch-polyfill.ts +69 -0
  321. package/index.ts +276 -0
  322. package/jest.config.js +8 -0
  323. package/package.json +47 -0
  324. package/pagination.ts +58 -0
  325. package/resource.ts +24 -0
  326. package/resources/account-numbers.ts +141 -0
  327. package/resources/account-statements.ts +132 -0
  328. package/resources/account-transfers.ts +244 -0
  329. package/resources/accounts.ts +179 -0
  330. package/resources/ach-prenotifications.ts +242 -0
  331. package/resources/ach-transfers.ts +465 -0
  332. package/resources/card-disputes.ts +187 -0
  333. package/resources/card-profiles.ts +236 -0
  334. package/resources/cards.ts +398 -0
  335. package/resources/check-deposits.ts +303 -0
  336. package/resources/check-transfers.ts +422 -0
  337. package/resources/declined-transactions.ts +547 -0
  338. package/resources/digital-wallet-tokens.ts +115 -0
  339. package/resources/documents.ts +119 -0
  340. package/resources/entities/entities.ts +1668 -0
  341. package/resources/entities/index.ts +4 -0
  342. package/resources/entities/supplemental-documents.ts +25 -0
  343. package/resources/event-subscriptions.ts +232 -0
  344. package/resources/events.ts +215 -0
  345. package/resources/external-accounts.ts +162 -0
  346. package/resources/files.ts +188 -0
  347. package/resources/groups.ts +47 -0
  348. package/resources/inbound-ach-transfer-returns.ts +142 -0
  349. package/resources/inbound-wire-drawdown-requests.ts +168 -0
  350. package/resources/index.ts +165 -0
  351. package/resources/limits.ts +144 -0
  352. package/resources/oauth-connections.ts +74 -0
  353. package/resources/pending-transactions.ts +491 -0
  354. package/resources/real-time-decisions.ts +345 -0
  355. package/resources/routing-numbers.ts +62 -0
  356. package/resources/shared.ts +17 -0
  357. package/resources/simulations/account-statements.ts +25 -0
  358. package/resources/simulations/account-transfers.ts +20 -0
  359. package/resources/simulations/ach-transfers.ts +1873 -0
  360. package/resources/simulations/card-disputes.ts +33 -0
  361. package/resources/simulations/card-refunds.ts +26 -0
  362. package/resources/simulations/cards.ts +979 -0
  363. package/resources/simulations/check-deposits.ts +41 -0
  364. package/resources/simulations/check-transfers.ts +30 -0
  365. package/resources/simulations/digital-wallet-token-requests.ts +52 -0
  366. package/resources/simulations/documents.ts +24 -0
  367. package/resources/simulations/inbound-wire-drawdown-requests.ts +126 -0
  368. package/resources/simulations/index.ts +22 -0
  369. package/resources/simulations/real-time-payments-transfers.ts +1809 -0
  370. package/resources/simulations/simulations.ts +32 -0
  371. package/resources/simulations/wire-transfers.ts +1391 -0
  372. package/resources/transactions.ts +1393 -0
  373. package/resources/wire-drawdown-requests.ts +195 -0
  374. package/resources/wire-transfers.ts +399 -0
  375. package/tests/api-resources/account-numbers.test.ts +67 -0
  376. package/tests/api-resources/account-statements.test.ts +64 -0
  377. package/tests/api-resources/account-transfers.test.ts +109 -0
  378. package/tests/api-resources/accounts.test.ts +82 -0
  379. package/tests/api-resources/ach-prenotifications.test.ts +86 -0
  380. package/tests/api-resources/ach-transfers.test.ts +120 -0
  381. package/tests/api-resources/card-disputes.test.ts +71 -0
  382. package/tests/api-resources/card-profiles.test.ts +60 -0
  383. package/tests/api-resources/cards.test.ts +101 -0
  384. package/tests/api-resources/check-deposits.test.ts +74 -0
  385. package/tests/api-resources/check-transfers.test.ts +135 -0
  386. package/tests/api-resources/declined-transactions.test.ts +68 -0
  387. package/tests/api-resources/digital-wallet-tokens.test.ts +64 -0
  388. package/tests/api-resources/documents.test.ts +64 -0
  389. package/tests/api-resources/entities/entities.test.ts +243 -0
  390. package/tests/api-resources/entities/supplemental-documents.test.ts +12 -0
  391. package/tests/api-resources/event-subscriptions.test.ts +69 -0
  392. package/tests/api-resources/events.test.ts +64 -0
  393. package/tests/api-resources/external-accounts.test.ts +76 -0
  394. package/tests/api-resources/files.test.ts +81 -0
  395. package/tests/api-resources/groups.test.ts +17 -0
  396. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +53 -0
  397. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +46 -0
  398. package/tests/api-resources/limits.test.ts +63 -0
  399. package/tests/api-resources/oauth-connections.test.ts +41 -0
  400. package/tests/api-resources/pending-transactions.test.ts +58 -0
  401. package/tests/api-resources/real-time-decisions.test.ts +34 -0
  402. package/tests/api-resources/routing-numbers.test.ts +18 -0
  403. package/tests/api-resources/simulations/account-statements.test.ts +12 -0
  404. package/tests/api-resources/simulations/account-transfers.test.ts +23 -0
  405. package/tests/api-resources/simulations/ach-transfers.test.ts +52 -0
  406. package/tests/api-resources/simulations/card-disputes.test.ts +19 -0
  407. package/tests/api-resources/simulations/card-refunds.test.ts +12 -0
  408. package/tests/api-resources/simulations/cards.test.ts +33 -0
  409. package/tests/api-resources/simulations/check-deposits.test.ts +49 -0
  410. package/tests/api-resources/simulations/check-transfers.test.ts +34 -0
  411. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +12 -0
  412. package/tests/api-resources/simulations/documents.test.ts +12 -0
  413. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +44 -0
  414. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +25 -0
  415. package/tests/api-resources/simulations/wire-transfers.test.ts +33 -0
  416. package/tests/api-resources/transactions.test.ts +70 -0
  417. package/tests/api-resources/wire-drawdown-requests.test.ts +73 -0
  418. package/tests/api-resources/wire-transfers.test.ts +147 -0
  419. package/tests/form.test.ts +27 -0
  420. package/tests/index.test.ts +47 -0
  421. package/tests/responses.test.ts +25 -0
  422. package/tsconfig.cjs.json +8 -0
  423. package/tsconfig.json +37 -0
  424. package/typings/digest-fetch/index.d.ts +33 -0
  425. package/version.ts +1 -0
@@ -0,0 +1,188 @@
1
+ import * as Core from '../core';
2
+ import { APIResource } from '../resource';
3
+ import { Page, PageParams } from '../pagination';
4
+ export declare class ACHPrenotifications extends APIResource {
5
+ /**
6
+ * Create an ACH Prenotification
7
+ */
8
+ create(
9
+ body: ACHPrenotificationCreateParams,
10
+ options?: Core.RequestOptions,
11
+ ): Promise<Core.APIResponse<ACHPrenotification>>;
12
+ /**
13
+ * Retrieve an ACH Prenotification
14
+ */
15
+ retrieve(
16
+ achPrenotificationId: string,
17
+ options?: Core.RequestOptions,
18
+ ): Promise<Core.APIResponse<ACHPrenotification>>;
19
+ /**
20
+ * List ACH Prenotifications
21
+ */
22
+ list(
23
+ query?: ACHPrenotificationListParams,
24
+ options?: Core.RequestOptions,
25
+ ): Core.PagePromise<ACHPrenotificationsPage>;
26
+ list(options?: Core.RequestOptions): Core.PagePromise<ACHPrenotificationsPage>;
27
+ }
28
+ export declare class ACHPrenotificationsPage extends Page<ACHPrenotification> {}
29
+ /**
30
+ * ACH Prenotifications are one way you can verify account and routing numbers by
31
+ * Automated Clearing House (ACH).
32
+ */
33
+ export interface ACHPrenotification {
34
+ /**
35
+ * The destination account number.
36
+ */
37
+ account_number: string;
38
+ /**
39
+ * Additional information for the recipient.
40
+ */
41
+ addendum: string | null;
42
+ /**
43
+ * The description of the date of the notification.
44
+ */
45
+ company_descriptive_date: string | null;
46
+ /**
47
+ * Optional data associated with the notification.
48
+ */
49
+ company_discretionary_data: string | null;
50
+ /**
51
+ * The description of the notification.
52
+ */
53
+ company_entry_description: string | null;
54
+ /**
55
+ * The name by which you know the company.
56
+ */
57
+ company_name: string | null;
58
+ /**
59
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
60
+ * the prenotification was created.
61
+ */
62
+ created_at: string;
63
+ /**
64
+ * If the notification is for a future credit or debit.
65
+ */
66
+ credit_debit_indicator: 'credit' | 'debit' | null;
67
+ /**
68
+ * The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
69
+ */
70
+ effective_date: string | null;
71
+ /**
72
+ * The ACH Prenotification's identifier.
73
+ */
74
+ id: string;
75
+ /**
76
+ * If your prenotification is returned, this will contain details of the return.
77
+ */
78
+ prenotification_return: ACHPrenotification.PrenotificationReturn | null;
79
+ /**
80
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
81
+ */
82
+ routing_number: string;
83
+ /**
84
+ * The lifecycle status of the ACH Prenotification.
85
+ */
86
+ status: 'pending_submitting' | 'requires_attention' | 'returned' | 'submitted';
87
+ /**
88
+ * A constant representing the object's type. For this resource it will always be
89
+ * `ach_prenotification`.
90
+ */
91
+ type: 'ach_prenotification';
92
+ }
93
+ export declare namespace ACHPrenotification {
94
+ interface PrenotificationReturn {
95
+ /**
96
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
97
+ * the Prenotification was returned.
98
+ */
99
+ created_at: string;
100
+ /**
101
+ * Why the Prenotification was returned.
102
+ */
103
+ return_reason_code: string;
104
+ }
105
+ }
106
+ export interface ACHPrenotificationCreateParams {
107
+ /**
108
+ * The account number for the destination account.
109
+ */
110
+ account_number: string;
111
+ /**
112
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
113
+ * destination account.
114
+ */
115
+ routing_number: string;
116
+ /**
117
+ * Additional information that will be sent to the recipient.
118
+ */
119
+ addendum?: string;
120
+ /**
121
+ * The description of the date of the transfer.
122
+ */
123
+ company_descriptive_date?: string;
124
+ /**
125
+ * The data you choose to associate with the transfer.
126
+ */
127
+ company_discretionary_data?: string;
128
+ /**
129
+ * The description of the transfer you wish to be shown to the recipient.
130
+ */
131
+ company_entry_description?: string;
132
+ /**
133
+ * The name by which the recipient knows you.
134
+ */
135
+ company_name?: string;
136
+ /**
137
+ * Whether the Prenotification is for a future debit or credit.
138
+ */
139
+ credit_debit_indicator?: 'credit' | 'debit';
140
+ /**
141
+ * The transfer effective date in
142
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
143
+ */
144
+ effective_date?: string;
145
+ /**
146
+ * Your identifer for the transfer recipient.
147
+ */
148
+ individual_id?: string;
149
+ /**
150
+ * The name of the transfer recipient. This value is information and not verified
151
+ * by the recipient's bank.
152
+ */
153
+ individual_name?: string;
154
+ /**
155
+ * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
156
+ */
157
+ standard_entry_class_code?:
158
+ | 'corporate_credit_or_debit'
159
+ | 'prearranged_payments_and_deposit'
160
+ | 'internet_initiated';
161
+ }
162
+ export interface ACHPrenotificationListParams extends PageParams {
163
+ created_at?: ACHPrenotificationListParams.CreatedAt;
164
+ }
165
+ export declare namespace ACHPrenotificationListParams {
166
+ interface CreatedAt {
167
+ /**
168
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
169
+ * timestamp.
170
+ */
171
+ after?: string;
172
+ /**
173
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
174
+ * timestamp.
175
+ */
176
+ before?: string;
177
+ /**
178
+ * Return results on or after this
179
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
180
+ */
181
+ on_or_after?: string;
182
+ /**
183
+ * Return results on or before this
184
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
185
+ */
186
+ on_or_before?: string;
187
+ }
188
+ }
@@ -0,0 +1,35 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.ACHPrenotificationsPage = exports.ACHPrenotifications = void 0;
5
+ const resource_1 = require('../resource');
6
+ const core_1 = require('../core');
7
+ const pagination_1 = require('../pagination');
8
+ class ACHPrenotifications extends resource_1.APIResource {
9
+ /**
10
+ * Create an ACH Prenotification
11
+ */
12
+ create(body, options) {
13
+ return this.post('/ach_prenotifications', Object.assign({ body }, options));
14
+ }
15
+ /**
16
+ * Retrieve an ACH Prenotification
17
+ */
18
+ retrieve(achPrenotificationId, options) {
19
+ return this.get(`/ach_prenotifications/${achPrenotificationId}`, options);
20
+ }
21
+ list(query = {}, options) {
22
+ if ((0, core_1.isRequestOptions)(query)) {
23
+ return this.list({}, query);
24
+ }
25
+ return this.getAPIList(
26
+ '/ach_prenotifications',
27
+ ACHPrenotificationsPage,
28
+ Object.assign({ query }, options),
29
+ );
30
+ }
31
+ }
32
+ exports.ACHPrenotifications = ACHPrenotifications;
33
+ class ACHPrenotificationsPage extends pagination_1.Page {}
34
+ exports.ACHPrenotificationsPage = ACHPrenotificationsPage;
35
+ //# sourceMappingURL=ach-prenotifications.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ach-prenotifications.js","sourceRoot":"","sources":["../../../resources/ach-prenotifications.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAAgD;AAEhD,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;OAEG;IACH,MAAM,CACJ,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,kBAAI,IAAI,IAAK,OAAO,EAAG,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,oBAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,oBAAoB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAUD,IAAI,CACF,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,uBAAuB,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IAClG,CAAC;CACF;AAvCD,kDAuCC;AAED,MAAa,uBAAwB,SAAQ,iBAAwB;CAAG;AAAxE,0DAAwE"}
@@ -0,0 +1,375 @@
1
+ import * as Core from '../core';
2
+ import { APIResource } from '../resource';
3
+ import { Page, PageParams } from '../pagination';
4
+ export declare class ACHTransfers extends APIResource {
5
+ /**
6
+ * Create an ACH Transfer
7
+ */
8
+ create(
9
+ body: ACHTransferCreateParams,
10
+ options?: Core.RequestOptions,
11
+ ): Promise<Core.APIResponse<ACHTransfer>>;
12
+ /**
13
+ * Retrieve an ACH Transfer
14
+ */
15
+ retrieve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
16
+ /**
17
+ * List ACH Transfers
18
+ */
19
+ list(query?: ACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
20
+ list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
21
+ /**
22
+ * Approves an ACH Transfer in a pending_approval state.
23
+ */
24
+ approve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
25
+ /**
26
+ * Cancels an ACH Transfer in a pending_approval state.
27
+ */
28
+ cancel(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
29
+ }
30
+ export declare class ACHTransfersPage extends Page<ACHTransfer> {}
31
+ /**
32
+ * ACH transfers move funds between your Increase account and any other account
33
+ * accessible by the Automated Clearing House (ACH).
34
+ */
35
+ export interface ACHTransfer {
36
+ /**
37
+ * The Account to which the transfer belongs.
38
+ */
39
+ account_id: string;
40
+ /**
41
+ * The destination account number.
42
+ */
43
+ account_number: string;
44
+ /**
45
+ * Additional information that will be sent to the recipient.
46
+ */
47
+ addendum: string | null;
48
+ /**
49
+ * The transfer amount in USD cents. A positive amount indicates a credit transfer
50
+ * pushing funds to the receiving account. A negative amount indicates a debit
51
+ * transfer pulling funds from the receiving account.
52
+ */
53
+ amount: number;
54
+ /**
55
+ * If your account requires approvals for transfers and the transfer was approved,
56
+ * this will contain details of the approval.
57
+ */
58
+ approval: ACHTransfer.Approval | null;
59
+ /**
60
+ * If your account requires approvals for transfers and the transfer was not
61
+ * approved, this will contain details of the cancellation.
62
+ */
63
+ cancellation: ACHTransfer.Cancellation | null;
64
+ /**
65
+ * The description of the date of the transfer.
66
+ */
67
+ company_descriptive_date: string | null;
68
+ /**
69
+ * The data you chose to associate with the transfer.
70
+ */
71
+ company_discretionary_data: string | null;
72
+ /**
73
+ * The description of the transfer you set to be shown to the recipient.
74
+ */
75
+ company_entry_description: string | null;
76
+ /**
77
+ * The name by which the recipient knows you.
78
+ */
79
+ company_name: string | null;
80
+ /**
81
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
82
+ * the transfer was created.
83
+ */
84
+ created_at: string;
85
+ /**
86
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
87
+ * currency. For ACH transfers this is always equal to `usd`.
88
+ */
89
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
90
+ /**
91
+ * The identifier of the External Account the transfer was made to, if any.
92
+ */
93
+ external_account_id: string | null;
94
+ /**
95
+ * The type of the account to which the transfer will be sent.
96
+ */
97
+ funding: 'checking' | 'savings';
98
+ /**
99
+ * The ACH transfer's identifier.
100
+ */
101
+ id: string;
102
+ /**
103
+ * Your identifer for the transfer recipient.
104
+ */
105
+ individual_id: string | null;
106
+ /**
107
+ * The name of the transfer recipient. This value is information and not verified
108
+ * by the recipient's bank.
109
+ */
110
+ individual_name: string | null;
111
+ /**
112
+ * The transfer's network.
113
+ */
114
+ network: 'ach';
115
+ /**
116
+ * If the receiving bank accepts the transfer but notifies that future transfers
117
+ * should use different details, this will contain those details.
118
+ */
119
+ notification_of_change: ACHTransfer.NotificationOfChange | null;
120
+ /**
121
+ * If your transfer is returned, this will contain details of the return.
122
+ */
123
+ return: ACHTransfer.Return | null;
124
+ /**
125
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
126
+ */
127
+ routing_number: string;
128
+ /**
129
+ * The Standard Entry Class (SEC) code to use for the transfer.
130
+ */
131
+ standard_entry_class_code:
132
+ | 'corporate_credit_or_debit'
133
+ | 'prearranged_payments_and_deposit'
134
+ | 'internet_initiated';
135
+ /**
136
+ * The descriptor that will show on the recipient's bank statement.
137
+ */
138
+ statement_descriptor: string;
139
+ /**
140
+ * The lifecycle status of the transfer.
141
+ */
142
+ status:
143
+ | 'pending_approval'
144
+ | 'canceled'
145
+ | 'pending_submission'
146
+ | 'submitted'
147
+ | 'returned'
148
+ | 'requires_attention'
149
+ | 'rejected';
150
+ /**
151
+ * After the transfer is submitted to FedACH, this will contain supplemental
152
+ * details.
153
+ */
154
+ submission: ACHTransfer.Submission | null;
155
+ /**
156
+ * If the transfer was created from a template, this will be the template's ID.
157
+ */
158
+ template_id: string | null;
159
+ /**
160
+ * The ID for the transaction funding the transfer.
161
+ */
162
+ transaction_id: string | null;
163
+ /**
164
+ * A constant representing the object's type. For this resource it will always be
165
+ * `ach_transfer`.
166
+ */
167
+ type: 'ach_transfer';
168
+ }
169
+ export declare namespace ACHTransfer {
170
+ interface Approval {
171
+ /**
172
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
173
+ * the transfer was approved.
174
+ */
175
+ approved_at: string;
176
+ }
177
+ interface Cancellation {
178
+ /**
179
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
180
+ * the Transfer was canceled.
181
+ */
182
+ canceled_at: string;
183
+ }
184
+ interface NotificationOfChange {
185
+ /**
186
+ * The type of change that occurred.
187
+ */
188
+ change_code: string;
189
+ /**
190
+ * The corrected data.
191
+ */
192
+ corrected_data: string;
193
+ /**
194
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
195
+ * the notification occurred.
196
+ */
197
+ created_at: string;
198
+ }
199
+ interface Return {
200
+ /**
201
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
202
+ * the transfer was created.
203
+ */
204
+ created_at: string;
205
+ /**
206
+ * Why the ACH Transfer was returned.
207
+ */
208
+ return_reason_code:
209
+ | 'insufficient_fund'
210
+ | 'no_account'
211
+ | 'account_closed'
212
+ | 'invalid_account_number_structure'
213
+ | 'account_frozen_entry_returned_per_ofac_instruction'
214
+ | 'credit_entry_refused_by_receiver'
215
+ | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
216
+ | 'corporate_customer_advised_not_authorized'
217
+ | 'payment_stopped'
218
+ | 'non_transaction_account'
219
+ | 'uncollected_funds'
220
+ | 'routing_number_check_digit_error'
221
+ | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
222
+ | 'amount_field_error'
223
+ | 'authorization_revoked_by_customer'
224
+ | 'invalid_ach_routing_number'
225
+ | 'file_record_edit_criteria'
226
+ | 'enr_invalid_individual_name'
227
+ | 'returned_per_odfi_request'
228
+ | 'addenda_error'
229
+ | 'limited_participation_dfi'
230
+ | 'incorrectly_coded_outbound_international_payment'
231
+ | 'other';
232
+ /**
233
+ * The identifier of the Tranasaction associated with this return.
234
+ */
235
+ transaction_id: string;
236
+ /**
237
+ * The identifier of the ACH Transfer associated with this return.
238
+ */
239
+ transfer_id: string;
240
+ }
241
+ interface Submission {
242
+ /**
243
+ * When the ACH transfer was sent to FedACH.
244
+ */
245
+ submitted_at: string;
246
+ /**
247
+ * The trace number for the submission.
248
+ */
249
+ trace_number: string;
250
+ }
251
+ }
252
+ export interface ACHTransferCreateParams {
253
+ /**
254
+ * The Increase identifier for the account that will send the transfer.
255
+ */
256
+ account_id: string;
257
+ /**
258
+ * The transfer amount in cents. A positive amount originates a credit transfer
259
+ * pushing funds to the receiving account. A negative amount originates a debit
260
+ * transfer pulling funds from the receiving account.
261
+ */
262
+ amount: number;
263
+ /**
264
+ * A description you choose to give the transfer. This will be saved with the
265
+ * transfer details, displayed in the dashboard, and returned by the API. If
266
+ * `individual_name` and `company_name` are not explicitly set by this API, the
267
+ * `statement_descriptor` will be sent in those fields to the receiving bank to
268
+ * help the customer recognize the transfer. You are highly encouraged to pass
269
+ * `individual_name` and `company_name` instead of relying on this fallback.
270
+ */
271
+ statement_descriptor: string;
272
+ /**
273
+ * The account number for the destination account.
274
+ */
275
+ account_number?: string;
276
+ /**
277
+ * Additional information that will be sent to the recipient. This is included in
278
+ * the transfer data sent to the receiving bank.
279
+ */
280
+ addendum?: string;
281
+ /**
282
+ * The description of the date of the transfer, usually in the format `YYYYMMDD`.
283
+ * This is included in the transfer data sent to the receiving bank.
284
+ */
285
+ company_descriptive_date?: string;
286
+ /**
287
+ * The data you choose to associate with the transfer. This is included in the
288
+ * transfer data sent to the receiving bank.
289
+ */
290
+ company_discretionary_data?: string;
291
+ /**
292
+ * A description of the transfer. This is included in the transfer data sent to the
293
+ * receiving bank.
294
+ */
295
+ company_entry_description?: string;
296
+ /**
297
+ * The name by which the recipient knows you. This is included in the transfer data
298
+ * sent to the receiving bank.
299
+ */
300
+ company_name?: string;
301
+ /**
302
+ * The transfer effective date in
303
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
304
+ */
305
+ effective_date?: string;
306
+ /**
307
+ * The ID of an External Account to initiate a transfer to. If this parameter is
308
+ * provided, `account_number`, `routing_number`, and `funding` must be absent.
309
+ */
310
+ external_account_id?: string;
311
+ /**
312
+ * The type of the account to which the transfer will be sent.
313
+ */
314
+ funding?: 'checking' | 'savings';
315
+ /**
316
+ * Your identifer for the transfer recipient.
317
+ */
318
+ individual_id?: string;
319
+ /**
320
+ * The name of the transfer recipient. This value is informational and not verified
321
+ * by the recipient's bank.
322
+ */
323
+ individual_name?: string;
324
+ /**
325
+ * Whether the transfer requires explicit approval via the dashboard or API.
326
+ */
327
+ require_approval?: boolean;
328
+ /**
329
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
330
+ * destination account.
331
+ */
332
+ routing_number?: string;
333
+ /**
334
+ * The Standard Entry Class (SEC) code to use for the transfer.
335
+ */
336
+ standard_entry_class_code?:
337
+ | 'corporate_credit_or_debit'
338
+ | 'prearranged_payments_and_deposit'
339
+ | 'internet_initiated';
340
+ }
341
+ export interface ACHTransferListParams extends PageParams {
342
+ /**
343
+ * Filter ACH Transfers to those that originated from the specified Account.
344
+ */
345
+ account_id?: string;
346
+ created_at?: ACHTransferListParams.CreatedAt;
347
+ /**
348
+ * Filter ACH Transfers to those made to the specified External Account.
349
+ */
350
+ external_account_id?: string;
351
+ }
352
+ export declare namespace ACHTransferListParams {
353
+ interface CreatedAt {
354
+ /**
355
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
356
+ * timestamp.
357
+ */
358
+ after?: string;
359
+ /**
360
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
361
+ * timestamp.
362
+ */
363
+ before?: string;
364
+ /**
365
+ * Return results on or after this
366
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
367
+ */
368
+ on_or_after?: string;
369
+ /**
370
+ * Return results on or before this
371
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
372
+ */
373
+ on_or_before?: string;
374
+ }
375
+ }
@@ -0,0 +1,43 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.ACHTransfersPage = exports.ACHTransfers = void 0;
5
+ const resource_1 = require('../resource');
6
+ const core_1 = require('../core');
7
+ const pagination_1 = require('../pagination');
8
+ class ACHTransfers extends resource_1.APIResource {
9
+ /**
10
+ * Create an ACH Transfer
11
+ */
12
+ create(body, options) {
13
+ return this.post('/ach_transfers', Object.assign({ body }, options));
14
+ }
15
+ /**
16
+ * Retrieve an ACH Transfer
17
+ */
18
+ retrieve(achTransferId, options) {
19
+ return this.get(`/ach_transfers/${achTransferId}`, options);
20
+ }
21
+ list(query = {}, options) {
22
+ if ((0, core_1.isRequestOptions)(query)) {
23
+ return this.list({}, query);
24
+ }
25
+ return this.getAPIList('/ach_transfers', ACHTransfersPage, Object.assign({ query }, options));
26
+ }
27
+ /**
28
+ * Approves an ACH Transfer in a pending_approval state.
29
+ */
30
+ approve(achTransferId, options) {
31
+ return this.post(`/ach_transfers/${achTransferId}/approve`, options);
32
+ }
33
+ /**
34
+ * Cancels an ACH Transfer in a pending_approval state.
35
+ */
36
+ cancel(achTransferId, options) {
37
+ return this.post(`/ach_transfers/${achTransferId}/cancel`, options);
38
+ }
39
+ }
40
+ exports.ACHTransfers = ACHTransfers;
41
+ class ACHTransfersPage extends pagination_1.Page {}
42
+ exports.ACHTransfersPage = ACHTransfersPage;
43
+ //# sourceMappingURL=ach-transfers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ach-transfers.js","sourceRoot":"","sources":["../../../resources/ach-transfers.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAAgD;AAEhD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,kBAAI,IAAI,IAAK,OAAO,EAAG,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAOD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,aAAqB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,aAAa,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,aAAa,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AA/CD,oCA+CC;AAED,MAAa,gBAAiB,SAAQ,iBAAiB;CAAG;AAA1D,4CAA0D"}