increase 0.11.1 → 0.11.2

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 (506) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +5 -1
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +99 -0
  35. package/_shims/{ReadableStream.js → auto/types.js} +0 -2
  36. package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +79 -0
  44. package/_shims/index.js +13 -0
  45. package/_shims/index.mjs +7 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +87 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +54 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +35 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +39 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +35 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +70 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +63 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +82 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +170 -218
  74. package/core.d.ts.map +1 -1
  75. package/core.js +673 -731
  76. package/core.js.map +1 -1
  77. package/core.mjs +667 -682
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +104 -177
  80. package/error.js +247 -280
  81. package/error.mjs +244 -252
  82. package/index.d.mts +332 -356
  83. package/index.d.ts +332 -356
  84. package/index.d.ts.map +1 -1
  85. package/index.js +193 -264
  86. package/index.mjs +170 -198
  87. package/package.json +31 -58
  88. package/pagination.d.ts +25 -25
  89. package/pagination.js +29 -25
  90. package/pagination.mjs +27 -23
  91. package/resource.d.ts +10 -10
  92. package/resource.js +12 -12
  93. package/resource.mjs +10 -10
  94. package/resources/account-numbers.d.ts +162 -168
  95. package/resources/account-numbers.js +33 -31
  96. package/resources/account-numbers.mjs +28 -26
  97. package/resources/account-statements.d.ts +79 -81
  98. package/resources/account-statements.js +21 -21
  99. package/resources/account-statements.mjs +16 -14
  100. package/resources/account-transfers.d.ts +192 -194
  101. package/resources/account-transfers.js +39 -39
  102. package/resources/account-transfers.mjs +34 -32
  103. package/resources/accounts.d.ts +148 -151
  104. package/resources/accounts.js +39 -37
  105. package/resources/accounts.mjs +34 -32
  106. package/resources/ach-prenotifications.d.ts +370 -438
  107. package/resources/ach-prenotifications.d.ts.map +1 -1
  108. package/resources/ach-prenotifications.js +27 -27
  109. package/resources/ach-prenotifications.js.map +1 -1
  110. package/resources/ach-prenotifications.mjs +22 -20
  111. package/resources/ach-prenotifications.mjs.map +1 -1
  112. package/resources/ach-transfers.d.ts +604 -679
  113. package/resources/ach-transfers.d.ts.map +1 -1
  114. package/resources/ach-transfers.js +39 -37
  115. package/resources/ach-transfers.js.map +1 -1
  116. package/resources/ach-transfers.mjs +34 -32
  117. package/resources/ach-transfers.mjs.map +1 -1
  118. package/resources/balance-lookups.d.ts +35 -38
  119. package/resources/balance-lookups.js +12 -11
  120. package/resources/balance-lookups.mjs +9 -8
  121. package/resources/bookkeeping-accounts.d.ts +66 -70
  122. package/resources/bookkeeping-accounts.js +21 -21
  123. package/resources/bookkeeping-accounts.mjs +16 -14
  124. package/resources/bookkeeping-entries.d.ts +36 -37
  125. package/resources/bookkeeping-entries.js +15 -15
  126. package/resources/bookkeeping-entries.mjs +10 -8
  127. package/resources/bookkeeping-entry-sets.d.ts +61 -64
  128. package/resources/bookkeeping-entry-sets.js +12 -13
  129. package/resources/bookkeeping-entry-sets.mjs +9 -8
  130. package/resources/card-disputes.d.ts +127 -129
  131. package/resources/card-disputes.js +27 -25
  132. package/resources/card-disputes.mjs +22 -20
  133. package/resources/card-profiles.d.ts +235 -245
  134. package/resources/card-profiles.js +33 -31
  135. package/resources/card-profiles.mjs +28 -26
  136. package/resources/card-purchase-supplements.d.ts +219 -238
  137. package/resources/card-purchase-supplements.js +21 -21
  138. package/resources/card-purchase-supplements.mjs +16 -14
  139. package/resources/cards.d.ts +288 -279
  140. package/resources/cards.d.ts.map +1 -1
  141. package/resources/cards.js +39 -37
  142. package/resources/cards.js.map +1 -1
  143. package/resources/cards.mjs +34 -32
  144. package/resources/cards.mjs.map +1 -1
  145. package/resources/check-deposits.d.ts +238 -260
  146. package/resources/check-deposits.js +27 -25
  147. package/resources/check-deposits.mjs +22 -20
  148. package/resources/check-transfers.d.ts +487 -503
  149. package/resources/check-transfers.js +45 -43
  150. package/resources/check-transfers.mjs +40 -38
  151. package/resources/declined-transactions.d.ts +806 -926
  152. package/resources/declined-transactions.js +21 -21
  153. package/resources/declined-transactions.mjs +16 -14
  154. package/resources/digital-wallet-tokens.d.ts +75 -77
  155. package/resources/digital-wallet-tokens.js +21 -21
  156. package/resources/digital-wallet-tokens.mjs +16 -14
  157. package/resources/documents.d.ts +78 -77
  158. package/resources/documents.js +21 -19
  159. package/resources/documents.mjs +16 -14
  160. package/resources/entities/beneficial-owners.d.ts +233 -244
  161. package/resources/entities/beneficial-owners.js +24 -25
  162. package/resources/entities/beneficial-owners.mjs +21 -20
  163. package/resources/entities/entities.d.ts +1532 -1585
  164. package/resources/entities/entities.d.ts.map +1 -1
  165. package/resources/entities/entities.js +67 -83
  166. package/resources/entities/entities.mjs +43 -42
  167. package/resources/entities/index.d.ts +4 -22
  168. package/resources/entities/index.js +12 -42
  169. package/resources/entities/index.mjs +4 -4
  170. package/resources/entities/supplemental-documents.d.ts +38 -44
  171. package/resources/entities/supplemental-documents.js +24 -24
  172. package/resources/entities/supplemental-documents.mjs +20 -18
  173. package/resources/event-subscriptions.d.ts +242 -355
  174. package/resources/event-subscriptions.js +33 -33
  175. package/resources/event-subscriptions.mjs +28 -26
  176. package/resources/events.d.ts +150 -254
  177. package/resources/events.js +21 -19
  178. package/resources/events.mjs +16 -14
  179. package/resources/exports.d.ts +210 -158
  180. package/resources/exports.d.ts.map +1 -1
  181. package/resources/exports.js +27 -25
  182. package/resources/exports.js.map +1 -1
  183. package/resources/exports.mjs +22 -20
  184. package/resources/exports.mjs.map +1 -1
  185. package/resources/external-accounts.d.ts +122 -128
  186. package/resources/external-accounts.js +33 -33
  187. package/resources/external-accounts.mjs +28 -26
  188. package/resources/files.d.ts +149 -196
  189. package/resources/files.js +30 -28
  190. package/resources/files.mjs +24 -22
  191. package/resources/groups.d.ts +35 -35
  192. package/resources/groups.js +12 -11
  193. package/resources/groups.mjs +9 -8
  194. package/resources/inbound-ach-transfers.d.ts +265 -305
  195. package/resources/inbound-ach-transfers.js +42 -42
  196. package/resources/inbound-ach-transfers.mjs +37 -35
  197. package/resources/inbound-wire-drawdown-requests.d.ts +113 -119
  198. package/resources/inbound-wire-drawdown-requests.js +24 -25
  199. package/resources/inbound-wire-drawdown-requests.mjs +19 -19
  200. package/resources/index.d.ts +39 -205
  201. package/resources/index.js +114 -540
  202. package/resources/index.mjs +39 -42
  203. package/resources/oauth-connections.d.ts +43 -44
  204. package/resources/oauth-connections.js +21 -21
  205. package/resources/oauth-connections.mjs +16 -14
  206. package/resources/pending-transactions.d.ts +560 -601
  207. package/resources/pending-transactions.js +21 -21
  208. package/resources/pending-transactions.mjs +16 -14
  209. package/resources/programs.d.ts +41 -39
  210. package/resources/programs.js +21 -19
  211. package/resources/programs.mjs +16 -14
  212. package/resources/real-time-decisions.d.ts +384 -411
  213. package/resources/real-time-decisions.js +18 -19
  214. package/resources/real-time-decisions.mjs +15 -14
  215. package/resources/real-time-payments-transfers.d.ts +304 -342
  216. package/resources/real-time-payments-transfers.js +30 -30
  217. package/resources/real-time-payments-transfers.mjs +25 -23
  218. package/resources/routing-numbers.d.ts +52 -54
  219. package/resources/routing-numbers.js +18 -16
  220. package/resources/routing-numbers.mjs +14 -12
  221. package/resources/simulations/account-statements.d.ts +12 -15
  222. package/resources/simulations/account-statements.js +13 -14
  223. package/resources/simulations/account-statements.mjs +10 -9
  224. package/resources/simulations/account-transfers.d.ts +8 -11
  225. package/resources/simulations/account-transfers.js +13 -13
  226. package/resources/simulations/account-transfers.mjs +10 -10
  227. package/resources/simulations/ach-transfers.d.ts +3609 -3848
  228. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  229. package/resources/simulations/ach-transfers.js +40 -35
  230. package/resources/simulations/ach-transfers.js.map +1 -1
  231. package/resources/simulations/ach-transfers.mjs +37 -32
  232. package/resources/simulations/ach-transfers.mjs.map +1 -1
  233. package/resources/simulations/card-disputes.d.ts +22 -26
  234. package/resources/simulations/card-disputes.js +15 -14
  235. package/resources/simulations/card-disputes.mjs +12 -11
  236. package/resources/simulations/card-profiles.d.ts +9 -9
  237. package/resources/simulations/card-profiles.js +14 -14
  238. package/resources/simulations/card-profiles.mjs +11 -11
  239. package/resources/simulations/card-refunds.d.ts +13 -16
  240. package/resources/simulations/card-refunds.js +13 -12
  241. package/resources/simulations/card-refunds.mjs +10 -9
  242. package/resources/simulations/cards.d.ts +1306 -1448
  243. package/resources/simulations/cards.js +28 -27
  244. package/resources/simulations/cards.mjs +25 -24
  245. package/resources/simulations/check-deposits.d.ts +17 -17
  246. package/resources/simulations/check-deposits.js +26 -26
  247. package/resources/simulations/check-deposits.mjs +23 -23
  248. package/resources/simulations/check-transfers.d.ts +12 -18
  249. package/resources/simulations/check-transfers.js +19 -19
  250. package/resources/simulations/check-transfers.mjs +16 -16
  251. package/resources/simulations/digital-wallet-token-requests.d.ts +35 -43
  252. package/resources/simulations/digital-wallet-token-requests.js +13 -15
  253. package/resources/simulations/digital-wallet-token-requests.mjs +10 -9
  254. package/resources/simulations/documents.d.ts +11 -11
  255. package/resources/simulations/documents.js +12 -11
  256. package/resources/simulations/documents.mjs +9 -8
  257. package/resources/simulations/inbound-funds-holds.d.ts +63 -66
  258. package/resources/simulations/inbound-funds-holds.js +13 -14
  259. package/resources/simulations/inbound-funds-holds.mjs +10 -9
  260. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +94 -97
  261. package/resources/simulations/inbound-wire-drawdown-requests.js +13 -15
  262. package/resources/simulations/inbound-wire-drawdown-requests.mjs +10 -11
  263. package/resources/simulations/index.d.ts +19 -40
  264. package/resources/simulations/index.js +40 -148
  265. package/resources/simulations/index.mjs +19 -19
  266. package/resources/simulations/interest-payments.d.ts +2483 -2752
  267. package/resources/simulations/interest-payments.d.ts.map +1 -1
  268. package/resources/simulations/interest-payments.js +13 -14
  269. package/resources/simulations/interest-payments.js.map +1 -1
  270. package/resources/simulations/interest-payments.mjs +10 -9
  271. package/resources/simulations/interest-payments.mjs.map +1 -1
  272. package/resources/simulations/programs.d.ts +13 -13
  273. package/resources/simulations/programs.js +14 -13
  274. package/resources/simulations/programs.mjs +11 -10
  275. package/resources/simulations/real-time-payments-transfers.d.ts +3343 -3744
  276. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  277. package/resources/simulations/real-time-payments-transfers.js +24 -25
  278. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  279. package/resources/simulations/real-time-payments-transfers.mjs +21 -20
  280. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  281. package/resources/simulations/simulations.d.ts +75 -75
  282. package/resources/simulations/simulations.js +78 -101
  283. package/resources/simulations/simulations.mjs +56 -56
  284. package/resources/simulations/wire-transfers.d.ts +2541 -2810
  285. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  286. package/resources/simulations/wire-transfers.js +12 -11
  287. package/resources/simulations/wire-transfers.js.map +1 -1
  288. package/resources/simulations/wire-transfers.mjs +9 -8
  289. package/resources/simulations/wire-transfers.mjs.map +1 -1
  290. package/resources/transactions.d.ts +2539 -2838
  291. package/resources/transactions.d.ts.map +1 -1
  292. package/resources/transactions.js +21 -19
  293. package/resources/transactions.js.map +1 -1
  294. package/resources/transactions.mjs +16 -14
  295. package/resources/transactions.mjs.map +1 -1
  296. package/resources/wire-drawdown-requests.d.ts +140 -147
  297. package/resources/wire-drawdown-requests.js +27 -27
  298. package/resources/wire-drawdown-requests.mjs +22 -20
  299. package/resources/wire-transfers.d.ts +315 -324
  300. package/resources/wire-transfers.js +56 -54
  301. package/resources/wire-transfers.mjs +51 -49
  302. package/shims/node.d.ts +29 -0
  303. package/shims/node.d.ts.map +1 -0
  304. package/shims/node.js +31 -0
  305. package/shims/node.js.map +1 -0
  306. package/shims/node.mjs +5 -0
  307. package/shims/node.mjs.map +1 -0
  308. package/shims/web.d.ts +26 -0
  309. package/shims/web.d.ts.map +1 -0
  310. package/shims/web.js +31 -0
  311. package/shims/web.js.map +1 -0
  312. package/shims/web.mjs +5 -0
  313. package/shims/web.mjs.map +1 -0
  314. package/src/_shims/MultipartBody.ts +9 -0
  315. package/src/_shims/README.md +46 -0
  316. package/src/_shims/auto/runtime-bun.ts +4 -0
  317. package/src/_shims/auto/runtime-node.ts +4 -0
  318. package/src/_shims/auto/runtime.ts +4 -0
  319. package/src/_shims/auto/types-node.ts +4 -0
  320. package/src/_shims/auto/types.d.ts +99 -0
  321. package/src/_shims/auto/types.js +3 -0
  322. package/src/_shims/auto/types.mjs +3 -0
  323. package/src/_shims/bun-runtime.ts +14 -0
  324. package/src/_shims/index.d.ts +79 -0
  325. package/src/_shims/index.js +13 -0
  326. package/src/_shims/index.mjs +7 -0
  327. package/src/_shims/manual-types.d.ts +12 -0
  328. package/src/_shims/manual-types.js +3 -0
  329. package/src/_shims/manual-types.mjs +3 -0
  330. package/src/_shims/node-runtime.ts +79 -0
  331. package/src/_shims/node-types.d.ts +42 -0
  332. package/src/_shims/node-types.js +3 -0
  333. package/src/_shims/node-types.mjs +3 -0
  334. package/src/_shims/registry.ts +64 -0
  335. package/src/_shims/web-runtime.ts +91 -0
  336. package/src/_shims/web-types.d.ts +82 -0
  337. package/src/_shims/web-types.js +3 -0
  338. package/src/_shims/web-types.mjs +3 -0
  339. package/src/core.ts +33 -16
  340. package/src/error.ts +1 -1
  341. package/src/index.ts +6 -6
  342. package/src/pagination.ts +1 -1
  343. package/src/resource.ts +1 -1
  344. package/src/resources/account-numbers.ts +5 -5
  345. package/src/resources/account-statements.ts +5 -5
  346. package/src/resources/account-transfers.ts +5 -5
  347. package/src/resources/accounts.ts +5 -5
  348. package/src/resources/ach-prenotifications.ts +45 -16
  349. package/src/resources/ach-transfers.ts +47 -17
  350. package/src/resources/balance-lookups.ts +3 -3
  351. package/src/resources/bookkeeping-accounts.ts +5 -5
  352. package/src/resources/bookkeeping-entries.ts +5 -5
  353. package/src/resources/bookkeeping-entry-sets.ts +3 -3
  354. package/src/resources/card-disputes.ts +5 -5
  355. package/src/resources/card-profiles.ts +5 -5
  356. package/src/resources/card-purchase-supplements.ts +5 -5
  357. package/src/resources/cards.ts +15 -5
  358. package/src/resources/check-deposits.ts +5 -5
  359. package/src/resources/check-transfers.ts +5 -5
  360. package/src/resources/declined-transactions.ts +5 -5
  361. package/src/resources/digital-wallet-tokens.ts +5 -5
  362. package/src/resources/documents.ts +5 -5
  363. package/src/resources/entities/beneficial-owners.ts +5 -5
  364. package/src/resources/entities/entities.ts +18 -18
  365. package/src/resources/entities/index.ts +3 -3
  366. package/src/resources/entities/supplemental-documents.ts +5 -5
  367. package/src/resources/event-subscriptions.ts +5 -5
  368. package/src/resources/events.ts +5 -5
  369. package/src/resources/exports.ts +64 -7
  370. package/src/resources/external-accounts.ts +5 -5
  371. package/src/resources/files.ts +6 -6
  372. package/src/resources/groups.ts +3 -3
  373. package/src/resources/inbound-ach-transfers.ts +5 -5
  374. package/src/resources/inbound-wire-drawdown-requests.ts +5 -5
  375. package/src/resources/index.ts +38 -38
  376. package/src/resources/oauth-connections.ts +5 -5
  377. package/src/resources/pending-transactions.ts +5 -5
  378. package/src/resources/programs.ts +5 -5
  379. package/src/resources/real-time-decisions.ts +3 -3
  380. package/src/resources/real-time-payments-transfers.ts +5 -5
  381. package/src/resources/routing-numbers.ts +4 -4
  382. package/src/resources/simulations/account-statements.ts +4 -4
  383. package/src/resources/simulations/account-transfers.ts +3 -3
  384. package/src/resources/simulations/ach-transfers.ts +297 -29
  385. package/src/resources/simulations/card-disputes.ts +4 -4
  386. package/src/resources/simulations/card-profiles.ts +3 -3
  387. package/src/resources/simulations/card-refunds.ts +4 -4
  388. package/src/resources/simulations/cards.ts +4 -4
  389. package/src/resources/simulations/check-deposits.ts +3 -3
  390. package/src/resources/simulations/check-transfers.ts +3 -3
  391. package/src/resources/simulations/digital-wallet-token-requests.ts +3 -3
  392. package/src/resources/simulations/documents.ts +4 -4
  393. package/src/resources/simulations/inbound-funds-holds.ts +3 -3
  394. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +4 -4
  395. package/src/resources/simulations/index.ts +18 -18
  396. package/src/resources/simulations/interest-payments.ts +18 -14
  397. package/src/resources/simulations/programs.ts +4 -4
  398. package/src/resources/simulations/real-time-payments-transfers.ts +19 -15
  399. package/src/resources/simulations/simulations.ts +19 -19
  400. package/src/resources/simulations/wire-transfers.ts +18 -14
  401. package/src/resources/transactions.ts +20 -16
  402. package/src/resources/wire-drawdown-requests.ts +5 -5
  403. package/src/resources/wire-transfers.ts +5 -5
  404. package/src/shims/node.ts +50 -0
  405. package/src/shims/web.ts +50 -0
  406. package/src/uploads.ts +12 -16
  407. package/src/version.ts +1 -1
  408. package/uploads.d.ts +23 -39
  409. package/uploads.d.ts.map +1 -1
  410. package/uploads.js +115 -157
  411. package/uploads.js.map +1 -1
  412. package/uploads.mjs +111 -133
  413. package/uploads.mjs.map +1 -1
  414. package/version.d.ts +2 -2
  415. package/version.js +4 -4
  416. package/version.mjs +2 -2
  417. package/_shims/ReadableStream-node.d.ts +0 -6
  418. package/_shims/ReadableStream-node.d.ts.map +0 -1
  419. package/_shims/ReadableStream-node.js +0 -14
  420. package/_shims/ReadableStream-node.js.map +0 -1
  421. package/_shims/ReadableStream-node.mjs +0 -3
  422. package/_shims/ReadableStream-node.mjs.map +0 -1
  423. package/_shims/ReadableStream.d.ts +0 -38
  424. package/_shims/ReadableStream.mjs +0 -7
  425. package/_shims/agent-node.d.ts +0 -7
  426. package/_shims/agent-node.d.ts.map +0 -1
  427. package/_shims/agent-node.js +0 -28
  428. package/_shims/agent-node.js.map +0 -1
  429. package/_shims/agent-node.mjs +0 -16
  430. package/_shims/agent-node.mjs.map +0 -1
  431. package/_shims/agent.d.ts +0 -9
  432. package/_shims/agent.d.ts.map +0 -1
  433. package/_shims/agent.js +0 -14
  434. package/_shims/agent.js.map +0 -1
  435. package/_shims/agent.mjs +0 -10
  436. package/_shims/agent.mjs.map +0 -1
  437. package/_shims/fetch-node.d.ts +0 -64
  438. package/_shims/fetch-node.js +0 -12
  439. package/_shims/fetch-node.mjs +0 -14
  440. package/_shims/fetch.d.ts +0 -60
  441. package/_shims/fetch.js +0 -13
  442. package/_shims/fetch.mjs +0 -15
  443. package/_shims/fileFromPath-node.d.ts +0 -17
  444. package/_shims/fileFromPath-node.d.ts.map +0 -1
  445. package/_shims/fileFromPath-node.js +0 -17
  446. package/_shims/fileFromPath-node.js.map +0 -1
  447. package/_shims/fileFromPath-node.mjs +0 -13
  448. package/_shims/fileFromPath-node.mjs.map +0 -1
  449. package/_shims/fileFromPath.d.ts +0 -22
  450. package/_shims/fileFromPath.d.ts.map +0 -1
  451. package/_shims/fileFromPath.js +0 -16
  452. package/_shims/fileFromPath.js.map +0 -1
  453. package/_shims/fileFromPath.mjs +0 -12
  454. package/_shims/fileFromPath.mjs.map +0 -1
  455. package/_shims/form-data-node.d.ts +0 -45
  456. package/_shims/form-data-node.js +0 -11
  457. package/_shims/form-data-node.mjs +0 -9
  458. package/_shims/form-data.d.ts +0 -43
  459. package/_shims/form-data.js +0 -17
  460. package/_shims/form-data.mjs +0 -20
  461. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  462. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  463. package/_shims/getMultipartRequestOptions-node.js +0 -22
  464. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  465. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  466. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  467. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  468. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  469. package/_shims/getMultipartRequestOptions.js +0 -12
  470. package/_shims/getMultipartRequestOptions.js.map +0 -1
  471. package/_shims/getMultipartRequestOptions.mjs +0 -8
  472. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  473. package/_shims/node-readable-node.d.ts +0 -8
  474. package/_shims/node-readable-node.d.ts.map +0 -1
  475. package/_shims/node-readable-node.js +0 -9
  476. package/_shims/node-readable-node.js.map +0 -1
  477. package/_shims/node-readable-node.mjs +0 -5
  478. package/_shims/node-readable-node.mjs.map +0 -1
  479. package/_shims/node-readable.d.ts +0 -23
  480. package/_shims/node-readable.d.ts.map +0 -1
  481. package/_shims/node-readable.js +0 -11
  482. package/_shims/node-readable.js.map +0 -1
  483. package/_shims/node-readable.mjs +0 -7
  484. package/_shims/node-readable.mjs.map +0 -1
  485. package/src/_shims/ReadableStream.d.ts +0 -38
  486. package/src/_shims/ReadableStream.mjs +0 -7
  487. package/src/_shims/agent-node.ts +0 -22
  488. package/src/_shims/agent.ts +0 -12
  489. package/src/_shims/fetch-node.d.ts +0 -64
  490. package/src/_shims/fetch-node.js +0 -12
  491. package/src/_shims/fetch-node.mjs +0 -14
  492. package/src/_shims/fetch.d.ts +0 -60
  493. package/src/_shims/fetch.js +0 -13
  494. package/src/_shims/fetch.mjs +0 -15
  495. package/src/_shims/fileFromPath-node.ts +0 -29
  496. package/src/_shims/fileFromPath.ts +0 -29
  497. package/src/_shims/form-data-node.d.ts +0 -45
  498. package/src/_shims/form-data-node.js +0 -11
  499. package/src/_shims/form-data-node.mjs +0 -9
  500. package/src/_shims/form-data.d.ts +0 -43
  501. package/src/_shims/form-data.js +0 -17
  502. package/src/_shims/form-data.mjs +0 -20
  503. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  504. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  505. package/src/_shims/node-readable-node.ts +0 -10
  506. package/src/_shims/node-readable.ts +0 -30
@@ -1,568 +1,552 @@
1
1
  import * as Core from 'increase/core';
2
2
  import { APIResource } from 'increase/resource';
3
- import * as API from './index.js';
3
+ import * as API from "./index.js";
4
4
  import { Page, PageParams } from 'increase/pagination';
5
5
  export declare class CheckTransfers extends APIResource {
6
- /**
7
- * Create a Check Transfer
8
- */
9
- create(body: CheckTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
10
- /**
11
- * Retrieve a Check Transfer
12
- */
13
- retrieve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
14
- /**
15
- * List Check Transfers
16
- */
17
- list(
18
- query?: CheckTransferListParams,
19
- options?: Core.RequestOptions,
20
- ): Core.PagePromise<CheckTransfersPage, CheckTransfer>;
21
- list(options?: Core.RequestOptions): Core.PagePromise<CheckTransfersPage, CheckTransfer>;
22
- /**
23
- * Approve a Check Transfer
24
- */
25
- approve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
26
- /**
27
- * Cancel a pending Check Transfer
28
- */
29
- cancel(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
30
- /**
31
- * Request a stop payment on a Check Transfer
32
- */
33
- stopPayment(
34
- checkTransferId: string,
35
- body: CheckTransferStopPaymentParams,
36
- options?: Core.RequestOptions,
37
- ): Core.APIPromise<CheckTransfer>;
6
+ /**
7
+ * Create a Check Transfer
8
+ */
9
+ create(body: CheckTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
10
+ /**
11
+ * Retrieve a Check Transfer
12
+ */
13
+ retrieve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
14
+ /**
15
+ * List Check Transfers
16
+ */
17
+ list(query?: CheckTransferListParams, options?: Core.RequestOptions): Core.PagePromise<CheckTransfersPage, CheckTransfer>;
18
+ list(options?: Core.RequestOptions): Core.PagePromise<CheckTransfersPage, CheckTransfer>;
19
+ /**
20
+ * Approve a Check Transfer
21
+ */
22
+ approve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
23
+ /**
24
+ * Cancel a pending Check Transfer
25
+ */
26
+ cancel(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
27
+ /**
28
+ * Request a stop payment on a Check Transfer
29
+ */
30
+ stopPayment(checkTransferId: string, body: CheckTransferStopPaymentParams, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer>;
31
+ }
32
+ export declare class CheckTransfersPage extends Page<CheckTransfer> {
38
33
  }
39
- export declare class CheckTransfersPage extends Page<CheckTransfer> {}
40
34
  type _CheckTransfersPage = CheckTransfersPage;
41
35
  /**
42
36
  * Check Transfers move funds from your Increase account by mailing a physical
43
37
  * check.
44
38
  */
45
39
  export interface CheckTransfer {
46
- /**
47
- * The Check transfer's identifier.
48
- */
49
- id: string;
50
- /**
51
- * The identifier of the Account from which funds will be transferred.
52
- */
53
- account_id: string;
54
- /**
55
- * The account number printed on the check.
56
- */
57
- account_number: string;
58
- /**
59
- * The transfer amount in USD cents.
60
- */
61
- amount: number;
62
- /**
63
- * If your account requires approvals for transfers and the transfer was approved,
64
- * this will contain details of the approval.
65
- */
66
- approval: CheckTransfer.Approval | null;
67
- /**
68
- * If your account requires approvals for transfers and the transfer was not
69
- * approved, this will contain details of the cancellation.
70
- */
71
- cancellation: CheckTransfer.Cancellation | null;
72
- /**
73
- * The check number printed on the check.
74
- */
75
- check_number: string;
76
- /**
77
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
78
- * the transfer was created.
79
- */
80
- created_at: string;
81
- /**
82
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
83
- * currency.
84
- *
85
- * - `CAD` - Canadian Dollar (CAD)
86
- * - `CHF` - Swiss Franc (CHF)
87
- * - `EUR` - Euro (EUR)
88
- * - `GBP` - British Pound (GBP)
89
- * - `JPY` - Japanese Yen (JPY)
90
- * - `USD` - US Dollar (USD)
91
- */
92
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
93
- /**
94
- * After a check transfer is deposited, this will contain supplemental details.
95
- */
96
- deposit: CheckTransfer.Deposit | null;
97
- /**
98
- * Whether Increase will print and mail the check or if you will do it yourself.
99
- *
100
- * - `physical_check` - Increase will print and mail a physical check.
101
- * - `third_party` - Increase will not print a check; you are responsible for
102
- * printing and mailing a check with the provided account number, routing number,
103
- * check number, and amount.
104
- */
105
- fulfillment_method: 'physical_check' | 'third_party';
106
- /**
107
- * If the check has been mailed by Increase, this will contain details of the
108
- * shipment.
109
- */
110
- mailing: CheckTransfer.Mailing | null;
111
- /**
112
- * The ID for the pending transaction representing the transfer. A pending
113
- * transaction is created when the transfer
114
- * [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
115
- * by someone else in your organization.
116
- */
117
- pending_transaction_id: string | null;
118
- /**
119
- * Details relating to the physical check that Increase will print and mail. Will
120
- * be present if and only if `fulfillment_method` is equal to `physical_check`.
121
- */
122
- physical_check: CheckTransfer.PhysicalCheck | null;
123
- /**
124
- * The routing number printed on the check.
125
- */
126
- routing_number: string;
127
- /**
128
- * The identifier of the Account Number from which to send the transfer and print
129
- * on the check.
130
- */
131
- source_account_number_id: string | null;
132
- /**
133
- * The lifecycle status of the transfer.
134
- *
135
- * - `pending_approval` - The transfer is awaiting approval.
136
- * - `pending_submission` - The transfer is pending submission.
137
- * - `submitted` - The transfer is complete.
138
- * - `pending_mailing` - The check is queued for mailing.
139
- * - `mailed` - The check has been mailed.
140
- * - `canceled` - The transfer has been canceled.
141
- * - `deposited` - The check has been deposited.
142
- * - `stopped` - A stop-payment was requested for this check.
143
- * - `rejected` - The transfer has been rejected.
144
- * - `requires_attention` - The transfer requires attention from an Increase
145
- * operator.
146
- */
147
- status:
148
- | 'pending_approval'
149
- | 'pending_submission'
150
- | 'submitted'
151
- | 'pending_mailing'
152
- | 'mailed'
153
- | 'canceled'
154
- | 'deposited'
155
- | 'stopped'
156
- | 'rejected'
157
- | 'requires_attention';
158
- /**
159
- * After a stop-payment is requested on the check, this will contain supplemental
160
- * details.
161
- */
162
- stop_payment_request: CheckTransfer.StopPaymentRequest | null;
163
- /**
164
- * After the transfer is submitted, this will contain supplemental details.
165
- */
166
- submission: CheckTransfer.Submission | null;
167
- /**
168
- * A constant representing the object's type. For this resource it will always be
169
- * `check_transfer`.
170
- */
171
- type: 'check_transfer';
172
- /**
173
- * The unique identifier you chose for this transfer.
174
- */
175
- unique_identifier: string | null;
176
- }
177
- export declare namespace CheckTransfer {
178
- /**
179
- * If your account requires approvals for transfers and the transfer was approved,
180
- * this will contain details of the approval.
181
- */
182
- interface Approval {
183
40
  /**
184
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
185
- * the transfer was approved.
41
+ * The Check transfer's identifier.
186
42
  */
187
- approved_at: string;
43
+ id: string;
188
44
  /**
189
- * If the Transfer was approved by a user in the dashboard, the email address of
190
- * that user.
45
+ * The identifier of the Account from which funds will be transferred.
191
46
  */
192
- approved_by: string | null;
193
- }
194
- /**
195
- * If your account requires approvals for transfers and the transfer was not
196
- * approved, this will contain details of the cancellation.
197
- */
198
- interface Cancellation {
47
+ account_id: string;
199
48
  /**
200
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
201
- * the Transfer was canceled.
49
+ * The account number printed on the check.
202
50
  */
203
- canceled_at: string;
51
+ account_number: string;
204
52
  /**
205
- * If the Transfer was canceled by a user in the dashboard, the email address of
206
- * that user.
53
+ * The transfer amount in USD cents.
207
54
  */
208
- canceled_by: string | null;
209
- }
210
- /**
211
- * After a check transfer is deposited, this will contain supplemental details.
212
- */
213
- interface Deposit {
55
+ amount: number;
214
56
  /**
215
- * The identifier of the API File object containing an image of the back of the
216
- * deposited check.
57
+ * If your account requires approvals for transfers and the transfer was approved,
58
+ * this will contain details of the approval.
217
59
  */
218
- back_image_file_id: string | null;
60
+ approval: CheckTransfer.Approval | null;
219
61
  /**
220
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
221
- * bank depositing this check. In some rare cases, this is not transmitted via
222
- * Check21 and the value will be null.
62
+ * If your account requires approvals for transfers and the transfer was not
63
+ * approved, this will contain details of the cancellation.
223
64
  */
224
- bank_of_first_deposit_routing_number: string | null;
65
+ cancellation: CheckTransfer.Cancellation | null;
225
66
  /**
226
- * When the check was deposited.
67
+ * The check number printed on the check.
227
68
  */
228
- deposited_at: string;
69
+ check_number: string;
229
70
  /**
230
- * The identifier of the API File object containing an image of the front of the
231
- * deposited check.
71
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
72
+ * the transfer was created.
232
73
  */
233
- front_image_file_id: string | null;
74
+ created_at: string;
234
75
  /**
235
- * The identifier of the Transaction object created when the check was deposited.
76
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
77
+ * currency.
78
+ *
79
+ * - `CAD` - Canadian Dollar (CAD)
80
+ * - `CHF` - Swiss Franc (CHF)
81
+ * - `EUR` - Euro (EUR)
82
+ * - `GBP` - British Pound (GBP)
83
+ * - `JPY` - Japanese Yen (JPY)
84
+ * - `USD` - US Dollar (USD)
236
85
  */
237
- transaction_id: string | null;
86
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
238
87
  /**
239
- * A constant representing the object's type. For this resource it will always be
240
- * `check_transfer_deposit`.
88
+ * After a check transfer is deposited, this will contain supplemental details.
241
89
  */
242
- type: 'check_transfer_deposit';
243
- }
244
- /**
245
- * If the check has been mailed by Increase, this will contain details of the
246
- * shipment.
247
- */
248
- interface Mailing {
90
+ deposit: CheckTransfer.Deposit | null;
249
91
  /**
250
- * The ID of the file corresponding to an image of the check that was mailed, if
251
- * available.
92
+ * Whether Increase will print and mail the check or if you will do it yourself.
93
+ *
94
+ * - `physical_check` - Increase will print and mail a physical check.
95
+ * - `third_party` - Increase will not print a check; you are responsible for
96
+ * printing and mailing a check with the provided account number, routing number,
97
+ * check number, and amount.
252
98
  */
253
- image_id: string | null;
99
+ fulfillment_method: 'physical_check' | 'third_party';
254
100
  /**
255
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
256
- * the check was mailed.
257
- */
258
- mailed_at: string;
259
- }
260
- /**
261
- * Details relating to the physical check that Increase will print and mail. Will
262
- * be present if and only if `fulfillment_method` is equal to `physical_check`.
263
- */
264
- interface PhysicalCheck {
265
- /**
266
- * Details for where Increase will mail the check.
267
- */
268
- mailing_address: PhysicalCheck.MailingAddress;
269
- /**
270
- * The descriptor that will be printed on the memo field on the check.
271
- */
272
- memo: string | null;
273
- /**
274
- * The descriptor that will be printed on the letter included with the check.
275
- */
276
- note: string | null;
277
- /**
278
- * The name that will be printed on the check.
279
- */
280
- recipient_name: string;
281
- /**
282
- * The return address to be printed on the check.
283
- */
284
- return_address: PhysicalCheck.ReturnAddress | null;
285
- }
286
- namespace PhysicalCheck {
287
- /**
288
- * Details for where Increase will mail the check.
289
- */
290
- interface MailingAddress {
291
- /**
292
- * The city of the check's destination.
293
- */
294
- city: string | null;
295
- /**
296
- * The street address of the check's destination.
297
- */
298
- line1: string | null;
299
- /**
300
- * The second line of the address of the check's destination.
301
- */
302
- line2: string | null;
303
- /**
304
- * The name component of the check's mailing address.
305
- */
306
- name: string | null;
307
- /**
308
- * The postal code of the check's destination.
309
- */
310
- postal_code: string | null;
311
- /**
312
- * The state of the check's destination.
313
- */
314
- state: string | null;
315
- }
101
+ * If the check has been mailed by Increase, this will contain details of the
102
+ * shipment.
103
+ */
104
+ mailing: CheckTransfer.Mailing | null;
316
105
  /**
317
- * The return address to be printed on the check.
318
- */
319
- interface ReturnAddress {
320
- /**
321
- * The city of the check's destination.
322
- */
323
- city: string | null;
324
- /**
325
- * The street address of the check's destination.
326
- */
327
- line1: string | null;
328
- /**
329
- * The second line of the address of the check's destination.
330
- */
331
- line2: string | null;
332
- /**
333
- * The name component of the check's return address.
334
- */
335
- name: string | null;
336
- /**
337
- * The postal code of the check's destination.
338
- */
339
- postal_code: string | null;
340
- /**
341
- * The state of the check's destination.
342
- */
343
- state: string | null;
344
- }
345
- }
346
- /**
347
- * After a stop-payment is requested on the check, this will contain supplemental
348
- * details.
349
- */
350
- interface StopPaymentRequest {
351
- /**
352
- * The reason why this transfer was stopped.
106
+ * The ID for the pending transaction representing the transfer. A pending
107
+ * transaction is created when the transfer
108
+ * [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
109
+ * by someone else in your organization.
110
+ */
111
+ pending_transaction_id: string | null;
112
+ /**
113
+ * Details relating to the physical check that Increase will print and mail. Will
114
+ * be present if and only if `fulfillment_method` is equal to `physical_check`.
115
+ */
116
+ physical_check: CheckTransfer.PhysicalCheck | null;
117
+ /**
118
+ * The routing number printed on the check.
119
+ */
120
+ routing_number: string;
121
+ /**
122
+ * The identifier of the Account Number from which to send the transfer and print
123
+ * on the check.
124
+ */
125
+ source_account_number_id: string | null;
126
+ /**
127
+ * The lifecycle status of the transfer.
353
128
  *
354
- * - `mail_delivery_failed` - The check could not be delivered.
355
- * - `rejected_by_increase` - The check was canceled by an Increase operator who
356
- * will provide details out-of-band.
357
- * - `unknown` - The check was stopped for another reason.
129
+ * - `pending_approval` - The transfer is awaiting approval.
130
+ * - `pending_submission` - The transfer is pending submission.
131
+ * - `submitted` - The transfer is complete.
132
+ * - `pending_mailing` - The check is queued for mailing.
133
+ * - `mailed` - The check has been mailed.
134
+ * - `canceled` - The transfer has been canceled.
135
+ * - `deposited` - The check has been deposited.
136
+ * - `stopped` - A stop-payment was requested for this check.
137
+ * - `rejected` - The transfer has been rejected.
138
+ * - `requires_attention` - The transfer requires attention from an Increase
139
+ * operator.
358
140
  */
359
- reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
141
+ status: 'pending_approval' | 'pending_submission' | 'submitted' | 'pending_mailing' | 'mailed' | 'canceled' | 'deposited' | 'stopped' | 'rejected' | 'requires_attention';
360
142
  /**
361
- * The time the stop-payment was requested.
143
+ * After a stop-payment is requested on the check, this will contain supplemental
144
+ * details.
362
145
  */
363
- requested_at: string;
146
+ stop_payment_request: CheckTransfer.StopPaymentRequest | null;
364
147
  /**
365
- * The ID of the check transfer that was stopped.
148
+ * After the transfer is submitted, this will contain supplemental details.
366
149
  */
367
- transfer_id: string;
150
+ submission: CheckTransfer.Submission | null;
368
151
  /**
369
152
  * A constant representing the object's type. For this resource it will always be
370
- * `check_transfer_stop_payment_request`.
153
+ * `check_transfer`.
371
154
  */
372
- type: 'check_transfer_stop_payment_request';
373
- }
374
- /**
375
- * After the transfer is submitted, this will contain supplemental details.
376
- */
377
- interface Submission {
155
+ type: 'check_transfer';
378
156
  /**
379
- * When this check transfer was submitted to our check printer.
157
+ * The unique identifier you chose for this transfer.
380
158
  */
381
- submitted_at: string;
382
- }
383
- }
384
- export interface CheckTransferCreateParams {
385
- /**
386
- * The identifier for the account that will send the transfer.
387
- */
388
- account_id: string;
389
- /**
390
- * The transfer amount in cents.
391
- */
392
- amount: number;
393
- /**
394
- * Whether Increase will print and mail the check or if you will do it yourself.
395
- *
396
- * - `physical_check` - Increase will print and mail a physical check.
397
- * - `third_party` - Increase will not print a check; you are responsible for
398
- * printing and mailing a check with the provided account number, routing number,
399
- * check number, and amount.
400
- */
401
- fulfillment_method?: 'physical_check' | 'third_party';
402
- /**
403
- * Details relating to the physical check that Increase will print and mail. This
404
- * is required if `fulfillment_method` is equal to `physical_check`. It must not be
405
- * included if any other `fulfillment_method` is provided.
406
- */
407
- physical_check?: CheckTransferCreateParams.PhysicalCheck;
408
- /**
409
- * Whether the transfer requires explicit approval via the dashboard or API.
410
- */
411
- require_approval?: boolean;
412
- /**
413
- * The identifier of the Account Number from which to send the transfer and print
414
- * on the check.
415
- */
416
- source_account_number_id?: string;
417
- /**
418
- * A unique identifier you choose for the transfer. Reusing this identifier for
419
- * another transfer will result in an error. You can query for the transfer
420
- * associated with this identifier using the List endpoint.
421
- */
422
- unique_identifier?: string;
159
+ unique_identifier: string | null;
423
160
  }
424
- export declare namespace CheckTransferCreateParams {
425
- /**
426
- * Details relating to the physical check that Increase will print and mail. This
427
- * is required if `fulfillment_method` is equal to `physical_check`. It must not be
428
- * included if any other `fulfillment_method` is provided.
429
- */
430
- interface PhysicalCheck {
431
- /**
432
- * Details for where Increase will mail the check.
433
- */
434
- mailing_address: PhysicalCheck.MailingAddress;
435
- /**
436
- * The descriptor that will be printed on the memo field on the check.
437
- */
438
- memo: string;
439
- /**
440
- * The name that will be printed on the check in the 'To:' field.
441
- */
442
- recipient_name: string;
443
- /**
444
- * The descriptor that will be printed on the letter included with the check.
445
- */
446
- note?: string;
447
- /**
448
- * The return address to be printed on the check. If omitted this will default to
449
- * the address of the Entity of the Account used to make the Check Transfer.
450
- */
451
- return_address?: PhysicalCheck.ReturnAddress;
452
- }
453
- namespace PhysicalCheck {
454
- /**
455
- * Details for where Increase will mail the check.
456
- */
457
- interface MailingAddress {
458
- /**
459
- * The city component of the check's destination address.
460
- */
461
- city: string;
462
- /**
463
- * The first line of the address component of the check's destination address.
464
- */
465
- line1: string;
466
- /**
467
- * The postal code component of the check's destination address.
468
- */
469
- postal_code: string;
470
- /**
471
- * The US state component of the check's destination address.
472
- */
473
- state: string;
474
- /**
475
- * The second line of the address component of the check's destination address.
476
- */
477
- line2?: string;
478
- /**
479
- * The name component of the check's destination address. Defaults to the provided
480
- * `recipient_name` parameter.
481
- */
482
- name?: string;
161
+ export declare namespace CheckTransfer {
162
+ /**
163
+ * If your account requires approvals for transfers and the transfer was approved,
164
+ * this will contain details of the approval.
165
+ */
166
+ interface Approval {
167
+ /**
168
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
169
+ * the transfer was approved.
170
+ */
171
+ approved_at: string;
172
+ /**
173
+ * If the Transfer was approved by a user in the dashboard, the email address of
174
+ * that user.
175
+ */
176
+ approved_by: string | null;
483
177
  }
484
178
  /**
485
- * The return address to be printed on the check. If omitted this will default to
486
- * the address of the Entity of the Account used to make the Check Transfer.
487
- */
488
- interface ReturnAddress {
489
- /**
490
- * The city of the return address.
491
- */
492
- city: string;
493
- /**
494
- * The first line of the return address.
495
- */
496
- line1: string;
497
- /**
498
- * The name of the return address.
499
- */
500
- name: string;
501
- /**
502
- * The postal code of the return address.
503
- */
504
- postal_code: string;
505
- /**
506
- * The US state of the return address.
507
- */
508
- state: string;
509
- /**
510
- * The second line of the return address.
511
- */
512
- line2?: string;
179
+ * If your account requires approvals for transfers and the transfer was not
180
+ * approved, this will contain details of the cancellation.
181
+ */
182
+ interface Cancellation {
183
+ /**
184
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
185
+ * the Transfer was canceled.
186
+ */
187
+ canceled_at: string;
188
+ /**
189
+ * If the Transfer was canceled by a user in the dashboard, the email address of
190
+ * that user.
191
+ */
192
+ canceled_by: string | null;
193
+ }
194
+ /**
195
+ * After a check transfer is deposited, this will contain supplemental details.
196
+ */
197
+ interface Deposit {
198
+ /**
199
+ * The identifier of the API File object containing an image of the back of the
200
+ * deposited check.
201
+ */
202
+ back_image_file_id: string | null;
203
+ /**
204
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
205
+ * bank depositing this check. In some rare cases, this is not transmitted via
206
+ * Check21 and the value will be null.
207
+ */
208
+ bank_of_first_deposit_routing_number: string | null;
209
+ /**
210
+ * When the check was deposited.
211
+ */
212
+ deposited_at: string;
213
+ /**
214
+ * The identifier of the API File object containing an image of the front of the
215
+ * deposited check.
216
+ */
217
+ front_image_file_id: string | null;
218
+ /**
219
+ * The identifier of the Transaction object created when the check was deposited.
220
+ */
221
+ transaction_id: string | null;
222
+ /**
223
+ * A constant representing the object's type. For this resource it will always be
224
+ * `check_transfer_deposit`.
225
+ */
226
+ type: 'check_transfer_deposit';
227
+ }
228
+ /**
229
+ * If the check has been mailed by Increase, this will contain details of the
230
+ * shipment.
231
+ */
232
+ interface Mailing {
233
+ /**
234
+ * The ID of the file corresponding to an image of the check that was mailed, if
235
+ * available.
236
+ */
237
+ image_id: string | null;
238
+ /**
239
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
240
+ * the check was mailed.
241
+ */
242
+ mailed_at: string;
243
+ }
244
+ /**
245
+ * Details relating to the physical check that Increase will print and mail. Will
246
+ * be present if and only if `fulfillment_method` is equal to `physical_check`.
247
+ */
248
+ interface PhysicalCheck {
249
+ /**
250
+ * Details for where Increase will mail the check.
251
+ */
252
+ mailing_address: PhysicalCheck.MailingAddress;
253
+ /**
254
+ * The descriptor that will be printed on the memo field on the check.
255
+ */
256
+ memo: string | null;
257
+ /**
258
+ * The descriptor that will be printed on the letter included with the check.
259
+ */
260
+ note: string | null;
261
+ /**
262
+ * The name that will be printed on the check.
263
+ */
264
+ recipient_name: string;
265
+ /**
266
+ * The return address to be printed on the check.
267
+ */
268
+ return_address: PhysicalCheck.ReturnAddress | null;
269
+ }
270
+ namespace PhysicalCheck {
271
+ /**
272
+ * Details for where Increase will mail the check.
273
+ */
274
+ interface MailingAddress {
275
+ /**
276
+ * The city of the check's destination.
277
+ */
278
+ city: string | null;
279
+ /**
280
+ * The street address of the check's destination.
281
+ */
282
+ line1: string | null;
283
+ /**
284
+ * The second line of the address of the check's destination.
285
+ */
286
+ line2: string | null;
287
+ /**
288
+ * The name component of the check's mailing address.
289
+ */
290
+ name: string | null;
291
+ /**
292
+ * The postal code of the check's destination.
293
+ */
294
+ postal_code: string | null;
295
+ /**
296
+ * The state of the check's destination.
297
+ */
298
+ state: string | null;
299
+ }
300
+ /**
301
+ * The return address to be printed on the check.
302
+ */
303
+ interface ReturnAddress {
304
+ /**
305
+ * The city of the check's destination.
306
+ */
307
+ city: string | null;
308
+ /**
309
+ * The street address of the check's destination.
310
+ */
311
+ line1: string | null;
312
+ /**
313
+ * The second line of the address of the check's destination.
314
+ */
315
+ line2: string | null;
316
+ /**
317
+ * The name component of the check's return address.
318
+ */
319
+ name: string | null;
320
+ /**
321
+ * The postal code of the check's destination.
322
+ */
323
+ postal_code: string | null;
324
+ /**
325
+ * The state of the check's destination.
326
+ */
327
+ state: string | null;
328
+ }
329
+ }
330
+ /**
331
+ * After a stop-payment is requested on the check, this will contain supplemental
332
+ * details.
333
+ */
334
+ interface StopPaymentRequest {
335
+ /**
336
+ * The reason why this transfer was stopped.
337
+ *
338
+ * - `mail_delivery_failed` - The check could not be delivered.
339
+ * - `rejected_by_increase` - The check was canceled by an Increase operator who
340
+ * will provide details out-of-band.
341
+ * - `unknown` - The check was stopped for another reason.
342
+ */
343
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
344
+ /**
345
+ * The time the stop-payment was requested.
346
+ */
347
+ requested_at: string;
348
+ /**
349
+ * The ID of the check transfer that was stopped.
350
+ */
351
+ transfer_id: string;
352
+ /**
353
+ * A constant representing the object's type. For this resource it will always be
354
+ * `check_transfer_stop_payment_request`.
355
+ */
356
+ type: 'check_transfer_stop_payment_request';
357
+ }
358
+ /**
359
+ * After the transfer is submitted, this will contain supplemental details.
360
+ */
361
+ interface Submission {
362
+ /**
363
+ * When this check transfer was submitted to our check printer.
364
+ */
365
+ submitted_at: string;
513
366
  }
514
- }
515
- }
516
- export interface CheckTransferListParams extends PageParams {
517
- /**
518
- * Filter Check Transfers to those that originated from the specified Account.
519
- */
520
- account_id?: string;
521
- created_at?: CheckTransferListParams.CreatedAt;
522
- /**
523
- * Filter Check Transfers to the one with the specified unique identifier.
524
- */
525
- unique_identifier?: string;
526
367
  }
527
- export declare namespace CheckTransferListParams {
528
- interface CreatedAt {
368
+ export interface CheckTransferCreateParams {
369
+ /**
370
+ * The identifier for the account that will send the transfer.
371
+ */
372
+ account_id: string;
529
373
  /**
530
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
531
- * timestamp.
374
+ * The transfer amount in cents.
532
375
  */
533
- after?: string;
376
+ amount: number;
534
377
  /**
535
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
536
- * timestamp.
378
+ * Whether Increase will print and mail the check or if you will do it yourself.
379
+ *
380
+ * - `physical_check` - Increase will print and mail a physical check.
381
+ * - `third_party` - Increase will not print a check; you are responsible for
382
+ * printing and mailing a check with the provided account number, routing number,
383
+ * check number, and amount.
537
384
  */
538
- before?: string;
385
+ fulfillment_method?: 'physical_check' | 'third_party';
539
386
  /**
540
- * Return results on or after this
541
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
387
+ * Details relating to the physical check that Increase will print and mail. This
388
+ * is required if `fulfillment_method` is equal to `physical_check`. It must not be
389
+ * included if any other `fulfillment_method` is provided.
542
390
  */
543
- on_or_after?: string;
391
+ physical_check?: CheckTransferCreateParams.PhysicalCheck;
544
392
  /**
545
- * Return results on or before this
546
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
393
+ * Whether the transfer requires explicit approval via the dashboard or API.
547
394
  */
548
- on_or_before?: string;
549
- }
395
+ require_approval?: boolean;
396
+ /**
397
+ * The identifier of the Account Number from which to send the transfer and print
398
+ * on the check.
399
+ */
400
+ source_account_number_id?: string;
401
+ /**
402
+ * A unique identifier you choose for the transfer. Reusing this identifier for
403
+ * another transfer will result in an error. You can query for the transfer
404
+ * associated with this identifier using the List endpoint.
405
+ */
406
+ unique_identifier?: string;
407
+ }
408
+ export declare namespace CheckTransferCreateParams {
409
+ /**
410
+ * Details relating to the physical check that Increase will print and mail. This
411
+ * is required if `fulfillment_method` is equal to `physical_check`. It must not be
412
+ * included if any other `fulfillment_method` is provided.
413
+ */
414
+ interface PhysicalCheck {
415
+ /**
416
+ * Details for where Increase will mail the check.
417
+ */
418
+ mailing_address: PhysicalCheck.MailingAddress;
419
+ /**
420
+ * The descriptor that will be printed on the memo field on the check.
421
+ */
422
+ memo: string;
423
+ /**
424
+ * The name that will be printed on the check in the 'To:' field.
425
+ */
426
+ recipient_name: string;
427
+ /**
428
+ * The descriptor that will be printed on the letter included with the check.
429
+ */
430
+ note?: string;
431
+ /**
432
+ * The return address to be printed on the check. If omitted this will default to
433
+ * the address of the Entity of the Account used to make the Check Transfer.
434
+ */
435
+ return_address?: PhysicalCheck.ReturnAddress;
436
+ }
437
+ namespace PhysicalCheck {
438
+ /**
439
+ * Details for where Increase will mail the check.
440
+ */
441
+ interface MailingAddress {
442
+ /**
443
+ * The city component of the check's destination address.
444
+ */
445
+ city: string;
446
+ /**
447
+ * The first line of the address component of the check's destination address.
448
+ */
449
+ line1: string;
450
+ /**
451
+ * The postal code component of the check's destination address.
452
+ */
453
+ postal_code: string;
454
+ /**
455
+ * The US state component of the check's destination address.
456
+ */
457
+ state: string;
458
+ /**
459
+ * The second line of the address component of the check's destination address.
460
+ */
461
+ line2?: string;
462
+ /**
463
+ * The name component of the check's destination address. Defaults to the provided
464
+ * `recipient_name` parameter.
465
+ */
466
+ name?: string;
467
+ }
468
+ /**
469
+ * The return address to be printed on the check. If omitted this will default to
470
+ * the address of the Entity of the Account used to make the Check Transfer.
471
+ */
472
+ interface ReturnAddress {
473
+ /**
474
+ * The city of the return address.
475
+ */
476
+ city: string;
477
+ /**
478
+ * The first line of the return address.
479
+ */
480
+ line1: string;
481
+ /**
482
+ * The name of the return address.
483
+ */
484
+ name: string;
485
+ /**
486
+ * The postal code of the return address.
487
+ */
488
+ postal_code: string;
489
+ /**
490
+ * The US state of the return address.
491
+ */
492
+ state: string;
493
+ /**
494
+ * The second line of the return address.
495
+ */
496
+ line2?: string;
497
+ }
498
+ }
499
+ }
500
+ export interface CheckTransferListParams extends PageParams {
501
+ /**
502
+ * Filter Check Transfers to those that originated from the specified Account.
503
+ */
504
+ account_id?: string;
505
+ created_at?: CheckTransferListParams.CreatedAt;
506
+ /**
507
+ * Filter Check Transfers to the one with the specified unique identifier.
508
+ */
509
+ unique_identifier?: string;
510
+ }
511
+ export declare namespace CheckTransferListParams {
512
+ interface CreatedAt {
513
+ /**
514
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
515
+ * timestamp.
516
+ */
517
+ after?: string;
518
+ /**
519
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
520
+ * timestamp.
521
+ */
522
+ before?: string;
523
+ /**
524
+ * Return results on or after this
525
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
526
+ */
527
+ on_or_after?: string;
528
+ /**
529
+ * Return results on or before this
530
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
531
+ */
532
+ on_or_before?: string;
533
+ }
550
534
  }
551
535
  export interface CheckTransferStopPaymentParams {
552
- /**
553
- * The reason why this transfer should be stopped.
554
- *
555
- * - `mail_delivery_failed` - The check could not be delivered.
556
- * - `unknown` - The check was stopped for another reason.
557
- */
558
- reason?: 'mail_delivery_failed' | 'unknown';
536
+ /**
537
+ * The reason why this transfer should be stopped.
538
+ *
539
+ * - `mail_delivery_failed` - The check could not be delivered.
540
+ * - `unknown` - The check was stopped for another reason.
541
+ */
542
+ reason?: 'mail_delivery_failed' | 'unknown';
559
543
  }
560
544
  export declare namespace CheckTransfers {
561
- export import CheckTransfer = API.CheckTransfer;
562
- type CheckTransfersPage = _CheckTransfersPage;
563
- export import CheckTransferCreateParams = API.CheckTransferCreateParams;
564
- export import CheckTransferListParams = API.CheckTransferListParams;
565
- export import CheckTransferStopPaymentParams = API.CheckTransferStopPaymentParams;
545
+ export import CheckTransfer = API.CheckTransfer;
546
+ type CheckTransfersPage = _CheckTransfersPage;
547
+ export import CheckTransferCreateParams = API.CheckTransferCreateParams;
548
+ export import CheckTransferListParams = API.CheckTransferListParams;
549
+ export import CheckTransferStopPaymentParams = API.CheckTransferStopPaymentParams;
566
550
  }
567
551
  export {};
568
- //# sourceMappingURL=check-transfers.d.ts.map
552
+ //# sourceMappingURL=check-transfers.d.ts.map