modern-treasury 2.6.0 → 2.7.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 (474) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +8 -4
  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 -223
  74. package/core.d.ts.map +1 -1
  75. package/core.js +678 -731
  76. package/core.js.map +1 -1
  77. package/core.mjs +672 -682
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +32 -32
  80. package/error.d.ts.map +1 -1
  81. package/error.js +95 -106
  82. package/error.js.map +1 -1
  83. package/error.mjs +91 -91
  84. package/error.mjs.map +1 -1
  85. package/index.d.mts +323 -333
  86. package/index.d.ts +323 -333
  87. package/index.d.ts.map +1 -1
  88. package/index.js +190 -243
  89. package/index.js.map +1 -1
  90. package/index.mjs +167 -190
  91. package/index.mjs.map +1 -1
  92. package/package.json +32 -58
  93. package/pagination.d.ts +11 -11
  94. package/pagination.js +30 -26
  95. package/pagination.mjs +28 -24
  96. package/resource.d.ts +10 -10
  97. package/resource.js +12 -12
  98. package/resource.mjs +10 -10
  99. package/resources/account-collection-flows.d.ts +71 -116
  100. package/resources/account-collection-flows.js +52 -62
  101. package/resources/account-collection-flows.js.map +1 -1
  102. package/resources/account-collection-flows.mjs +47 -55
  103. package/resources/account-collection-flows.mjs.map +1 -1
  104. package/resources/account-details.d.ts +59 -81
  105. package/resources/account-details.js +47 -50
  106. package/resources/account-details.js.map +1 -1
  107. package/resources/account-details.mjs +42 -45
  108. package/resources/account-details.mjs.map +1 -1
  109. package/resources/connections.d.ts +42 -44
  110. package/resources/connections.js +15 -13
  111. package/resources/connections.mjs +10 -8
  112. package/resources/counterparties.d.ts +400 -466
  113. package/resources/counterparties.js +63 -71
  114. package/resources/counterparties.js.map +1 -1
  115. package/resources/counterparties.mjs +58 -66
  116. package/resources/counterparties.mjs.map +1 -1
  117. package/resources/documents.d.ts +88 -120
  118. package/resources/documents.js +36 -42
  119. package/resources/documents.js.map +1 -1
  120. package/resources/documents.mjs +30 -36
  121. package/resources/documents.mjs.map +1 -1
  122. package/resources/events.d.ts +56 -55
  123. package/resources/events.js +21 -19
  124. package/resources/events.mjs +16 -14
  125. package/resources/expected-payments.d.ts +321 -373
  126. package/resources/expected-payments.js +46 -51
  127. package/resources/expected-payments.js.map +1 -1
  128. package/resources/expected-payments.mjs +41 -44
  129. package/resources/expected-payments.mjs.map +1 -1
  130. package/resources/external-accounts.d.ts +295 -373
  131. package/resources/external-accounts.js +76 -91
  132. package/resources/external-accounts.js.map +1 -1
  133. package/resources/external-accounts.mjs +71 -84
  134. package/resources/external-accounts.mjs.map +1 -1
  135. package/resources/incoming-payment-details.d.ts +200 -222
  136. package/resources/incoming-payment-details.js +42 -47
  137. package/resources/incoming-payment-details.js.map +1 -1
  138. package/resources/incoming-payment-details.mjs +37 -40
  139. package/resources/incoming-payment-details.mjs.map +1 -1
  140. package/resources/index.d.ts +35 -212
  141. package/resources/index.js +111 -484
  142. package/resources/index.mjs +34 -37
  143. package/resources/internal-accounts/balance-reports.d.ts +74 -113
  144. package/resources/internal-accounts/balance-reports.js +21 -23
  145. package/resources/internal-accounts/balance-reports.mjs +16 -18
  146. package/resources/internal-accounts/index.d.ts +3 -15
  147. package/resources/internal-accounts/index.js +10 -34
  148. package/resources/internal-accounts/index.mjs +3 -3
  149. package/resources/internal-accounts/internal-accounts.d.ts +203 -233
  150. package/resources/internal-accounts/internal-accounts.js +65 -86
  151. package/resources/internal-accounts/internal-accounts.js.map +1 -1
  152. package/resources/internal-accounts/internal-accounts.mjs +41 -45
  153. package/resources/internal-accounts/internal-accounts.mjs.map +1 -1
  154. package/resources/invoices/index.d.ts +3 -17
  155. package/resources/invoices/index.js +9 -29
  156. package/resources/invoices/index.mjs +3 -3
  157. package/resources/invoices/invoices.d.ts +509 -549
  158. package/resources/invoices/invoices.js +74 -95
  159. package/resources/invoices/invoices.js.map +1 -1
  160. package/resources/invoices/invoices.mjs +50 -54
  161. package/resources/invoices/invoices.mjs.map +1 -1
  162. package/resources/invoices/line-items.d.ts +119 -133
  163. package/resources/invoices/line-items.js +49 -52
  164. package/resources/invoices/line-items.js.map +1 -1
  165. package/resources/invoices/line-items.mjs +44 -47
  166. package/resources/invoices/line-items.mjs.map +1 -1
  167. package/resources/ledger-account-balance-monitors.d.ts +213 -224
  168. package/resources/ledger-account-balance-monitors.js +49 -55
  169. package/resources/ledger-account-balance-monitors.js.map +1 -1
  170. package/resources/ledger-account-balance-monitors.mjs +44 -49
  171. package/resources/ledger-account-balance-monitors.mjs.map +1 -1
  172. package/resources/ledger-account-categories.d.ts +255 -276
  173. package/resources/ledger-account-categories.js +84 -89
  174. package/resources/ledger-account-categories.js.map +1 -1
  175. package/resources/ledger-account-categories.mjs +79 -82
  176. package/resources/ledger-account-categories.mjs.map +1 -1
  177. package/resources/ledger-account-payouts.d.ts +151 -160
  178. package/resources/ledger-account-payouts.js +45 -50
  179. package/resources/ledger-account-payouts.js.map +1 -1
  180. package/resources/ledger-account-payouts.mjs +40 -43
  181. package/resources/ledger-account-payouts.mjs.map +1 -1
  182. package/resources/ledger-account-statements.d.ts +455 -461
  183. package/resources/ledger-account-statements.js +26 -32
  184. package/resources/ledger-account-statements.js.map +1 -1
  185. package/resources/ledger-account-statements.mjs +23 -27
  186. package/resources/ledger-account-statements.mjs.map +1 -1
  187. package/resources/ledger-accounts.d.ts +347 -357
  188. package/resources/ledger-accounts.js +45 -48
  189. package/resources/ledger-accounts.js.map +1 -1
  190. package/resources/ledger-accounts.mjs +40 -43
  191. package/resources/ledger-accounts.mjs.map +1 -1
  192. package/resources/ledger-entries.d.ts +244 -250
  193. package/resources/ledger-entries.js +20 -18
  194. package/resources/ledger-entries.mjs +15 -13
  195. package/resources/ledger-event-handlers.d.ts +369 -376
  196. package/resources/ledger-event-handlers.js +44 -49
  197. package/resources/ledger-event-handlers.js.map +1 -1
  198. package/resources/ledger-event-handlers.mjs +39 -42
  199. package/resources/ledger-event-handlers.mjs.map +1 -1
  200. package/resources/ledger-transactions/index.d.ts +3 -16
  201. package/resources/ledger-transactions/index.js +10 -34
  202. package/resources/ledger-transactions/index.mjs +3 -3
  203. package/resources/ledger-transactions/ledger-transactions.d.ts +335 -389
  204. package/resources/ledger-transactions/ledger-transactions.js +70 -91
  205. package/resources/ledger-transactions/ledger-transactions.js.map +1 -1
  206. package/resources/ledger-transactions/ledger-transactions.mjs +46 -50
  207. package/resources/ledger-transactions/ledger-transactions.mjs.map +1 -1
  208. package/resources/ledger-transactions/versions.d.ts +199 -214
  209. package/resources/ledger-transactions/versions.js +18 -16
  210. package/resources/ledger-transactions/versions.mjs +13 -11
  211. package/resources/ledgerable-events.d.ts +96 -99
  212. package/resources/ledgerable-events.js +27 -33
  213. package/resources/ledgerable-events.js.map +1 -1
  214. package/resources/ledgerable-events.mjs +24 -28
  215. package/resources/ledgerable-events.mjs.map +1 -1
  216. package/resources/ledgers.d.ts +98 -97
  217. package/resources/ledgers.js +46 -49
  218. package/resources/ledgers.js.map +1 -1
  219. package/resources/ledgers.mjs +41 -44
  220. package/resources/ledgers.mjs.map +1 -1
  221. package/resources/line-items.d.ts +78 -101
  222. package/resources/line-items.js +29 -27
  223. package/resources/line-items.mjs +24 -22
  224. package/resources/paper-items.d.ts +91 -93
  225. package/resources/paper-items.js +21 -19
  226. package/resources/paper-items.mjs +16 -14
  227. package/resources/payment-flows.d.ts +132 -138
  228. package/resources/payment-flows.js +49 -57
  229. package/resources/payment-flows.js.map +1 -1
  230. package/resources/payment-flows.mjs +44 -52
  231. package/resources/payment-flows.mjs.map +1 -1
  232. package/resources/payment-orders/index.d.ts +3 -13
  233. package/resources/payment-orders/index.js +9 -29
  234. package/resources/payment-orders/index.mjs +3 -3
  235. package/resources/payment-orders/payment-orders.d.ts +1416 -1696
  236. package/resources/payment-orders/payment-orders.js +80 -109
  237. package/resources/payment-orders/payment-orders.js.map +1 -1
  238. package/resources/payment-orders/payment-orders.mjs +55 -67
  239. package/resources/payment-orders/payment-orders.mjs.map +1 -1
  240. package/resources/payment-orders/reversals.d.ts +153 -183
  241. package/resources/payment-orders/reversals.js +38 -41
  242. package/resources/payment-orders/reversals.js.map +1 -1
  243. package/resources/payment-orders/reversals.mjs +33 -36
  244. package/resources/payment-orders/reversals.mjs.map +1 -1
  245. package/resources/payment-references.d.ts +61 -118
  246. package/resources/payment-references.js +26 -26
  247. package/resources/payment-references.mjs +21 -19
  248. package/resources/returns.d.ts +167 -324
  249. package/resources/returns.js +35 -38
  250. package/resources/returns.js.map +1 -1
  251. package/resources/returns.mjs +30 -33
  252. package/resources/returns.mjs.map +1 -1
  253. package/resources/routing-details.d.ts +83 -173
  254. package/resources/routing-details.js +47 -50
  255. package/resources/routing-details.js.map +1 -1
  256. package/resources/routing-details.mjs +42 -45
  257. package/resources/routing-details.mjs.map +1 -1
  258. package/resources/shared.d.ts +4 -194
  259. package/resources/shared.js +3 -3
  260. package/resources/shared.mjs +1 -1
  261. package/resources/top-level.d.ts +4 -4
  262. package/resources/top-level.js +5 -4
  263. package/resources/top-level.mjs +3 -2
  264. package/resources/transactions/index.d.ts +3 -14
  265. package/resources/transactions/index.js +10 -34
  266. package/resources/transactions/index.mjs +3 -3
  267. package/resources/transactions/line-items.d.ts +69 -78
  268. package/resources/transactions/line-items.js +21 -19
  269. package/resources/transactions/line-items.mjs +16 -14
  270. package/resources/transactions/transactions.d.ts +163 -211
  271. package/resources/transactions/transactions.js +51 -67
  272. package/resources/transactions/transactions.mjs +27 -26
  273. package/resources/validations.d.ts +67 -111
  274. package/resources/validations.js +13 -12
  275. package/resources/validations.mjs +10 -9
  276. package/resources/virtual-accounts.d.ts +161 -201
  277. package/resources/virtual-accounts.js +46 -51
  278. package/resources/virtual-accounts.js.map +1 -1
  279. package/resources/virtual-accounts.mjs +41 -44
  280. package/resources/virtual-accounts.mjs.map +1 -1
  281. package/resources/webhooks.d.ts +21 -28
  282. package/resources/webhooks.js +35 -37
  283. package/resources/webhooks.js.map +1 -1
  284. package/resources/webhooks.mjs +30 -31
  285. package/resources/webhooks.mjs.map +1 -1
  286. package/shims/node.d.ts +29 -0
  287. package/shims/node.d.ts.map +1 -0
  288. package/shims/node.js +31 -0
  289. package/shims/node.js.map +1 -0
  290. package/shims/node.mjs +5 -0
  291. package/shims/node.mjs.map +1 -0
  292. package/shims/web.d.ts +26 -0
  293. package/shims/web.d.ts.map +1 -0
  294. package/shims/web.js +31 -0
  295. package/shims/web.js.map +1 -0
  296. package/shims/web.mjs +5 -0
  297. package/shims/web.mjs.map +1 -0
  298. package/src/_shims/MultipartBody.ts +9 -0
  299. package/src/_shims/README.md +46 -0
  300. package/src/_shims/auto/runtime-bun.ts +4 -0
  301. package/src/_shims/auto/runtime-node.ts +4 -0
  302. package/src/_shims/auto/runtime.ts +4 -0
  303. package/src/_shims/auto/types-node.ts +4 -0
  304. package/src/_shims/auto/types.d.ts +99 -0
  305. package/src/_shims/auto/types.js +3 -0
  306. package/src/_shims/auto/types.mjs +3 -0
  307. package/src/_shims/bun-runtime.ts +14 -0
  308. package/src/_shims/index.d.ts +79 -0
  309. package/src/_shims/index.js +13 -0
  310. package/src/_shims/index.mjs +7 -0
  311. package/src/_shims/manual-types.d.ts +12 -0
  312. package/src/_shims/manual-types.js +3 -0
  313. package/src/_shims/manual-types.mjs +3 -0
  314. package/src/_shims/node-runtime.ts +79 -0
  315. package/src/_shims/node-types.d.ts +42 -0
  316. package/src/_shims/node-types.js +3 -0
  317. package/src/_shims/node-types.mjs +3 -0
  318. package/src/_shims/registry.ts +64 -0
  319. package/src/_shims/web-runtime.ts +91 -0
  320. package/src/_shims/web-types.d.ts +82 -0
  321. package/src/_shims/web-types.js +3 -0
  322. package/src/_shims/web-types.mjs +3 -0
  323. package/src/core.ts +72 -43
  324. package/src/error.ts +4 -2
  325. package/src/index.ts +10 -8
  326. package/src/pagination.ts +1 -1
  327. package/src/resource.ts +1 -1
  328. package/src/resources/account-collection-flows.ts +5 -5
  329. package/src/resources/account-details.ts +6 -6
  330. package/src/resources/connections.ts +5 -5
  331. package/src/resources/counterparties.ts +8 -8
  332. package/src/resources/documents.ts +6 -6
  333. package/src/resources/events.ts +5 -5
  334. package/src/resources/expected-payments.ts +6 -6
  335. package/src/resources/external-accounts.ts +8 -8
  336. package/src/resources/incoming-payment-details.ts +7 -7
  337. package/src/resources/index.ts +34 -40
  338. package/src/resources/internal-accounts/balance-reports.ts +6 -6
  339. package/src/resources/internal-accounts/index.ts +2 -2
  340. package/src/resources/internal-accounts/internal-accounts.ts +10 -10
  341. package/src/resources/invoices/index.ts +2 -2
  342. package/src/resources/invoices/invoices.ts +8 -8
  343. package/src/resources/invoices/line-items.ts +5 -5
  344. package/src/resources/ledger-account-balance-monitors.ts +5 -5
  345. package/src/resources/ledger-account-categories.ts +5 -5
  346. package/src/resources/ledger-account-payouts.ts +5 -5
  347. package/src/resources/ledger-account-statements.ts +3 -3
  348. package/src/resources/ledger-accounts.ts +5 -5
  349. package/src/resources/ledger-entries.ts +5 -5
  350. package/src/resources/ledger-event-handlers.ts +5 -5
  351. package/src/resources/ledger-transactions/index.ts +2 -2
  352. package/src/resources/ledger-transactions/ledger-transactions.ts +7 -7
  353. package/src/resources/ledger-transactions/versions.ts +5 -5
  354. package/src/resources/ledgerable-events.ts +3 -3
  355. package/src/resources/ledgers.ts +5 -5
  356. package/src/resources/line-items.ts +5 -5
  357. package/src/resources/paper-items.ts +6 -6
  358. package/src/resources/payment-flows.ts +5 -5
  359. package/src/resources/payment-orders/index.ts +2 -2
  360. package/src/resources/payment-orders/payment-orders.ts +10 -10
  361. package/src/resources/payment-orders/reversals.ts +5 -5
  362. package/src/resources/payment-references.ts +5 -5
  363. package/src/resources/returns.ts +6 -6
  364. package/src/resources/routing-details.ts +6 -6
  365. package/src/resources/top-level.ts +1 -1
  366. package/src/resources/transactions/index.ts +2 -7
  367. package/src/resources/transactions/line-items.ts +5 -5
  368. package/src/resources/transactions/transactions.ts +7 -7
  369. package/src/resources/validations.ts +3 -3
  370. package/src/resources/virtual-accounts.ts +7 -7
  371. package/src/resources/webhooks.ts +3 -3
  372. package/src/shims/node.ts +50 -0
  373. package/src/shims/web.ts +50 -0
  374. package/src/uploads.ts +12 -16
  375. package/src/version.ts +1 -1
  376. package/uploads.d.ts +23 -39
  377. package/uploads.d.ts.map +1 -1
  378. package/uploads.js +111 -157
  379. package/uploads.js.map +1 -1
  380. package/uploads.mjs +107 -133
  381. package/uploads.mjs.map +1 -1
  382. package/version.d.ts +2 -2
  383. package/version.js +4 -4
  384. package/version.mjs +2 -2
  385. package/_shims/ReadableStream-node.d.ts +0 -6
  386. package/_shims/ReadableStream-node.d.ts.map +0 -1
  387. package/_shims/ReadableStream-node.js +0 -14
  388. package/_shims/ReadableStream-node.js.map +0 -1
  389. package/_shims/ReadableStream-node.mjs +0 -3
  390. package/_shims/ReadableStream-node.mjs.map +0 -1
  391. package/_shims/ReadableStream.d.ts +0 -38
  392. package/_shims/ReadableStream.mjs +0 -7
  393. package/_shims/agent-node.d.ts +0 -7
  394. package/_shims/agent-node.d.ts.map +0 -1
  395. package/_shims/agent-node.js +0 -28
  396. package/_shims/agent-node.js.map +0 -1
  397. package/_shims/agent-node.mjs +0 -16
  398. package/_shims/agent-node.mjs.map +0 -1
  399. package/_shims/agent.d.ts +0 -9
  400. package/_shims/agent.d.ts.map +0 -1
  401. package/_shims/agent.js +0 -14
  402. package/_shims/agent.js.map +0 -1
  403. package/_shims/agent.mjs +0 -10
  404. package/_shims/agent.mjs.map +0 -1
  405. package/_shims/fetch-node.d.ts +0 -64
  406. package/_shims/fetch-node.js +0 -12
  407. package/_shims/fetch-node.mjs +0 -14
  408. package/_shims/fetch.d.ts +0 -60
  409. package/_shims/fetch.js +0 -13
  410. package/_shims/fetch.mjs +0 -15
  411. package/_shims/fileFromPath-node.d.ts +0 -17
  412. package/_shims/fileFromPath-node.d.ts.map +0 -1
  413. package/_shims/fileFromPath-node.js +0 -17
  414. package/_shims/fileFromPath-node.js.map +0 -1
  415. package/_shims/fileFromPath-node.mjs +0 -13
  416. package/_shims/fileFromPath-node.mjs.map +0 -1
  417. package/_shims/fileFromPath.d.ts +0 -22
  418. package/_shims/fileFromPath.d.ts.map +0 -1
  419. package/_shims/fileFromPath.js +0 -16
  420. package/_shims/fileFromPath.js.map +0 -1
  421. package/_shims/fileFromPath.mjs +0 -12
  422. package/_shims/fileFromPath.mjs.map +0 -1
  423. package/_shims/form-data-node.d.ts +0 -45
  424. package/_shims/form-data-node.js +0 -11
  425. package/_shims/form-data-node.mjs +0 -9
  426. package/_shims/form-data.d.ts +0 -43
  427. package/_shims/form-data.js +0 -17
  428. package/_shims/form-data.mjs +0 -20
  429. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  430. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  431. package/_shims/getMultipartRequestOptions-node.js +0 -22
  432. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  433. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  434. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  435. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  436. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  437. package/_shims/getMultipartRequestOptions.js +0 -12
  438. package/_shims/getMultipartRequestOptions.js.map +0 -1
  439. package/_shims/getMultipartRequestOptions.mjs +0 -8
  440. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  441. package/_shims/node-readable-node.d.ts +0 -8
  442. package/_shims/node-readable-node.d.ts.map +0 -1
  443. package/_shims/node-readable-node.js +0 -9
  444. package/_shims/node-readable-node.js.map +0 -1
  445. package/_shims/node-readable-node.mjs +0 -5
  446. package/_shims/node-readable-node.mjs.map +0 -1
  447. package/_shims/node-readable.d.ts +0 -23
  448. package/_shims/node-readable.d.ts.map +0 -1
  449. package/_shims/node-readable.js +0 -11
  450. package/_shims/node-readable.js.map +0 -1
  451. package/_shims/node-readable.mjs +0 -7
  452. package/_shims/node-readable.mjs.map +0 -1
  453. package/src/_shims/ReadableStream.d.ts +0 -38
  454. package/src/_shims/ReadableStream.mjs +0 -7
  455. package/src/_shims/agent-node.ts +0 -22
  456. package/src/_shims/agent.ts +0 -12
  457. package/src/_shims/fetch-node.d.ts +0 -64
  458. package/src/_shims/fetch-node.js +0 -12
  459. package/src/_shims/fetch-node.mjs +0 -14
  460. package/src/_shims/fetch.d.ts +0 -60
  461. package/src/_shims/fetch.js +0 -13
  462. package/src/_shims/fetch.mjs +0 -15
  463. package/src/_shims/fileFromPath-node.ts +0 -29
  464. package/src/_shims/fileFromPath.ts +0 -29
  465. package/src/_shims/form-data-node.d.ts +0 -45
  466. package/src/_shims/form-data-node.js +0 -11
  467. package/src/_shims/form-data-node.mjs +0 -9
  468. package/src/_shims/form-data.d.ts +0 -43
  469. package/src/_shims/form-data.js +0 -17
  470. package/src/_shims/form-data.mjs +0 -20
  471. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  472. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  473. package/src/_shims/node-readable-node.ts +0 -10
  474. package/src/_shims/node-readable.ts +0 -30
@@ -1,407 +1,355 @@
1
1
  import * as Core from 'modern-treasury/core';
2
2
  import { APIResource } from 'modern-treasury/resource';
3
3
  import * as Shared from 'modern-treasury/resources/shared';
4
- import * as API from './index.js';
4
+ import * as API from "./index.js";
5
5
  import { Page, PageParams } from 'modern-treasury/pagination';
6
6
  export declare class ExpectedPayments extends APIResource {
7
- /**
8
- * create expected payment
9
- */
10
- create(
11
- params: ExpectedPaymentCreateParams,
12
- options?: Core.RequestOptions,
13
- ): Core.APIPromise<ExpectedPayment>;
14
- /**
15
- * get expected payment
16
- */
17
- retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
18
- /**
19
- * update expected payment
20
- */
21
- update(
22
- id: string,
23
- body?: ExpectedPaymentUpdateParams,
24
- options?: Core.RequestOptions,
25
- ): Core.APIPromise<ExpectedPayment>;
26
- update(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
27
- /**
28
- * list expected_payments
29
- */
30
- list(
31
- query?: ExpectedPaymentListParams,
32
- options?: Core.RequestOptions,
33
- ): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
34
- list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
35
- /**
36
- * delete expected payment
37
- */
38
- del(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
7
+ /**
8
+ * create expected payment
9
+ */
10
+ create(params: ExpectedPaymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
11
+ /**
12
+ * get expected payment
13
+ */
14
+ retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
15
+ /**
16
+ * update expected payment
17
+ */
18
+ update(id: string, body?: ExpectedPaymentUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
19
+ update(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
20
+ /**
21
+ * list expected_payments
22
+ */
23
+ list(query?: ExpectedPaymentListParams, options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
24
+ list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
25
+ /**
26
+ * delete expected payment
27
+ */
28
+ del(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
29
+ }
30
+ export declare class ExpectedPaymentsPage extends Page<ExpectedPayment> {
39
31
  }
40
- export declare class ExpectedPaymentsPage extends Page<ExpectedPayment> {}
41
32
  type _ExpectedPaymentsPage = ExpectedPaymentsPage;
42
33
  export interface ExpectedPayment {
43
- id: string;
44
- /**
45
- * The lowest amount this expected payment may be equal to. Value in specified
46
- * currency's smallest unit. e.g. $10 would be represented as 1000.
47
- */
48
- amount_lower_bound: number;
49
- /**
50
- * The highest amount this expected payment may be equal to. Value in specified
51
- * currency's smallest unit. e.g. $10 would be represented as 1000.
52
- */
53
- amount_upper_bound: number;
54
- /**
55
- * The ID of the counterparty you expect for this payment.
56
- */
57
- counterparty_id: string | null;
58
- created_at: string;
59
- /**
60
- * Must conform to ISO 4217. Defaults to the currency of the internal account.
61
- */
62
- currency: Shared.Currency | null;
63
- /**
64
- * The earliest date the payment may come in. Format: yyyy-mm-dd
65
- */
66
- date_lower_bound: string | null;
67
- /**
68
- * The latest date the payment may come in. Format: yyyy-mm-dd
69
- */
70
- date_upper_bound: string | null;
71
- /**
72
- * An optional description for internal use.
73
- */
74
- description: string | null;
75
- /**
76
- * One of credit or debit. When you are receiving money, use credit. When you are
77
- * being charged, use debit.
78
- */
79
- direction: 'credit' | 'debit';
80
- /**
81
- * The ID of the Internal Account for the expected payment.
82
- */
83
- internal_account_id: string;
84
- /**
85
- * The ID of the ledger transaction linked to the expected payment.
86
- */
87
- ledger_transaction_id: string | null;
88
- /**
89
- * This field will be true if this object exists in the live environment or false
90
- * if it exists in the test environment.
91
- */
92
- live_mode: boolean;
93
- /**
94
- * Additional data represented as key-value pairs. Both the key and value must be
95
- * strings.
96
- */
97
- metadata: Record<string, string>;
98
- object: string;
99
- /**
100
- * The reconciliation filters you have for this payment.
101
- */
102
- reconciliation_filters: unknown | null;
103
- /**
104
- * The reconciliation groups you have for this payment.
105
- */
106
- reconciliation_groups: unknown | null;
107
- /**
108
- * One of manual if this expected payment was manually reconciled in the dashboard,
109
- * automatic if it was automatically reconciled by Modern Treasury, or null if it
110
- * is unreconciled.
111
- */
112
- reconciliation_method: 'automatic' | 'manual' | null;
113
- /**
114
- * For `ach`, this field will be passed through on an addenda record. For `wire`
115
- * payments the field will be passed through as the "Originator to Beneficiary
116
- * Information", also known as OBI or Fedwire tag 6000.
117
- */
118
- remittance_information: string | null;
119
- /**
120
- * The statement description you expect to see on the transaction. For ACH
121
- * payments, this will be the full line item passed from the bank. For wire
122
- * payments, this will be the OBI field on the wire. For check payments, this will
123
- * be the memo field.
124
- */
125
- statement_descriptor: string | null;
126
- /**
127
- * One of unreconciled, reconciled, or archived.
128
- */
129
- status: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
130
- /**
131
- * The ID of the Transaction this expected payment object has been matched to.
132
- */
133
- transaction_id: string | null;
134
- /**
135
- * The ID of the Transaction Line Item this expected payment has been matched to.
136
- */
137
- transaction_line_item_id: string | null;
138
- /**
139
- * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
140
- * sepa, signet, wire.
141
- */
142
- type: ExpectedPaymentType | null;
143
- updated_at: string;
34
+ id: string;
35
+ /**
36
+ * The lowest amount this expected payment may be equal to. Value in specified
37
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
38
+ */
39
+ amount_lower_bound: number;
40
+ /**
41
+ * The highest amount this expected payment may be equal to. Value in specified
42
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
43
+ */
44
+ amount_upper_bound: number;
45
+ /**
46
+ * The ID of the counterparty you expect for this payment.
47
+ */
48
+ counterparty_id: string | null;
49
+ created_at: string;
50
+ /**
51
+ * Must conform to ISO 4217. Defaults to the currency of the internal account.
52
+ */
53
+ currency: Shared.Currency | null;
54
+ /**
55
+ * The earliest date the payment may come in. Format: yyyy-mm-dd
56
+ */
57
+ date_lower_bound: string | null;
58
+ /**
59
+ * The latest date the payment may come in. Format: yyyy-mm-dd
60
+ */
61
+ date_upper_bound: string | null;
62
+ /**
63
+ * An optional description for internal use.
64
+ */
65
+ description: string | null;
66
+ /**
67
+ * One of credit or debit. When you are receiving money, use credit. When you are
68
+ * being charged, use debit.
69
+ */
70
+ direction: 'credit' | 'debit';
71
+ /**
72
+ * The ID of the Internal Account for the expected payment.
73
+ */
74
+ internal_account_id: string;
75
+ /**
76
+ * The ID of the ledger transaction linked to the expected payment.
77
+ */
78
+ ledger_transaction_id: string | null;
79
+ /**
80
+ * This field will be true if this object exists in the live environment or false
81
+ * if it exists in the test environment.
82
+ */
83
+ live_mode: boolean;
84
+ /**
85
+ * Additional data represented as key-value pairs. Both the key and value must be
86
+ * strings.
87
+ */
88
+ metadata: Record<string, string>;
89
+ object: string;
90
+ /**
91
+ * The reconciliation filters you have for this payment.
92
+ */
93
+ reconciliation_filters: unknown | null;
94
+ /**
95
+ * The reconciliation groups you have for this payment.
96
+ */
97
+ reconciliation_groups: unknown | null;
98
+ /**
99
+ * One of manual if this expected payment was manually reconciled in the dashboard,
100
+ * automatic if it was automatically reconciled by Modern Treasury, or null if it
101
+ * is unreconciled.
102
+ */
103
+ reconciliation_method: 'automatic' | 'manual' | null;
104
+ /**
105
+ * For `ach`, this field will be passed through on an addenda record. For `wire`
106
+ * payments the field will be passed through as the "Originator to Beneficiary
107
+ * Information", also known as OBI or Fedwire tag 6000.
108
+ */
109
+ remittance_information: string | null;
110
+ /**
111
+ * The statement description you expect to see on the transaction. For ACH
112
+ * payments, this will be the full line item passed from the bank. For wire
113
+ * payments, this will be the OBI field on the wire. For check payments, this will
114
+ * be the memo field.
115
+ */
116
+ statement_descriptor: string | null;
117
+ /**
118
+ * One of unreconciled, reconciled, or archived.
119
+ */
120
+ status: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
121
+ /**
122
+ * The ID of the Transaction this expected payment object has been matched to.
123
+ */
124
+ transaction_id: string | null;
125
+ /**
126
+ * The ID of the Transaction Line Item this expected payment has been matched to.
127
+ */
128
+ transaction_line_item_id: string | null;
129
+ /**
130
+ * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
131
+ * sepa, signet, wire.
132
+ */
133
+ type: ExpectedPaymentType | null;
134
+ updated_at: string;
144
135
  }
145
136
  /**
146
137
  * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
147
138
  * sepa, signet, wire.
148
139
  */
149
- export type ExpectedPaymentType =
150
- | 'ach'
151
- | 'au_becs'
152
- | 'bacs'
153
- | 'book'
154
- | 'card'
155
- | 'check'
156
- | 'cross_border'
157
- | 'eft'
158
- | 'interac'
159
- | 'masav'
160
- | 'neft'
161
- | 'nics'
162
- | 'provxchange'
163
- | 'rtp'
164
- | 'se_bankgirot'
165
- | 'sen'
166
- | 'sepa'
167
- | 'sic'
168
- | 'signet'
169
- | 'wire'
170
- | 'zengin'
171
- | null;
140
+ export type ExpectedPaymentType = 'ach' | 'au_becs' | 'bacs' | 'book' | 'card' | 'check' | 'cross_border' | 'eft' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'se_bankgirot' | 'sen' | 'sepa' | 'sic' | 'signet' | 'wire' | 'zengin' | null;
172
141
  export interface ExpectedPaymentCreateParams {
173
- /**
174
- * The lowest amount this expected payment may be equal to. Value in specified
175
- * currency's smallest unit. e.g. $10 would be represented as 1000.
176
- */
177
- amount_lower_bound: number;
178
- /**
179
- * The highest amount this expected payment may be equal to. Value in specified
180
- * currency's smallest unit. e.g. $10 would be represented as 1000.
181
- */
182
- amount_upper_bound: number;
183
- /**
184
- * One of credit or debit. When you are receiving money, use credit. When you are
185
- * being charged, use debit.
186
- */
187
- direction: 'credit' | 'debit';
188
- /**
189
- * The ID of the Internal Account for the expected payment.
190
- */
191
- internal_account_id: string;
192
- /**
193
- * The ID of the counterparty you expect for this payment.
194
- */
195
- counterparty_id?: string | null;
196
- /**
197
- * Must conform to ISO 4217. Defaults to the currency of the internal account.
198
- */
199
- currency?: Shared.Currency | null;
200
- /**
201
- * The earliest date the payment may come in. Format: yyyy-mm-dd
202
- */
203
- date_lower_bound?: string | null;
204
- /**
205
- * The latest date the payment may come in. Format: yyyy-mm-dd
206
- */
207
- date_upper_bound?: string | null;
208
- /**
209
- * An optional description for internal use.
210
- */
211
- description?: string | null;
212
- line_items?: Array<ExpectedPaymentCreateParams.LineItem>;
213
- /**
214
- * Additional data represented as key-value pairs. Both the key and value must be
215
- * strings.
216
- */
217
- metadata?: Record<string, string>;
218
- /**
219
- * The reconciliation filters you have for this payment.
220
- */
221
- reconciliation_filters?: unknown | null;
222
- /**
223
- * The reconciliation groups you have for this payment.
224
- */
225
- reconciliation_groups?: unknown | null;
226
- /**
227
- * For `ach`, this field will be passed through on an addenda record. For `wire`
228
- * payments the field will be passed through as the "Originator to Beneficiary
229
- * Information", also known as OBI or Fedwire tag 6000.
230
- */
231
- remittance_information?: string | null;
232
- /**
233
- * The statement description you expect to see on the transaction. For ACH
234
- * payments, this will be the full line item passed from the bank. For wire
235
- * payments, this will be the OBI field on the wire. For check payments, this will
236
- * be the memo field.
237
- */
238
- statement_descriptor?: string | null;
239
- /**
240
- * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
241
- * sepa, signet, wire.
242
- */
243
- type?: ExpectedPaymentType | null;
244
- }
245
- export declare namespace ExpectedPaymentCreateParams {
246
- interface LineItem {
247
142
  /**
248
- * Value in specified currency's smallest unit. e.g. $10 would be represented
249
- * as 1000.
143
+ * The lowest amount this expected payment may be equal to. Value in specified
144
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
145
+ */
146
+ amount_lower_bound: number;
147
+ /**
148
+ * The highest amount this expected payment may be equal to. Value in specified
149
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
150
+ */
151
+ amount_upper_bound: number;
152
+ /**
153
+ * One of credit or debit. When you are receiving money, use credit. When you are
154
+ * being charged, use debit.
155
+ */
156
+ direction: 'credit' | 'debit';
157
+ /**
158
+ * The ID of the Internal Account for the expected payment.
159
+ */
160
+ internal_account_id: string;
161
+ /**
162
+ * The ID of the counterparty you expect for this payment.
163
+ */
164
+ counterparty_id?: string | null;
165
+ /**
166
+ * Must conform to ISO 4217. Defaults to the currency of the internal account.
167
+ */
168
+ currency?: Shared.Currency | null;
169
+ /**
170
+ * The earliest date the payment may come in. Format: yyyy-mm-dd
250
171
  */
251
- amount: number;
172
+ date_lower_bound?: string | null;
252
173
  /**
253
- * The ID of one of your accounting categories. Note that these will only be
254
- * accessible if your accounting system has been connected.
174
+ * The latest date the payment may come in. Format: yyyy-mm-dd
255
175
  */
256
- accounting_category_id?: string | null;
176
+ date_upper_bound?: string | null;
257
177
  /**
258
- * A free-form description of the line item.
178
+ * An optional description for internal use.
259
179
  */
260
180
  description?: string | null;
181
+ line_items?: Array<ExpectedPaymentCreateParams.LineItem>;
261
182
  /**
262
183
  * Additional data represented as key-value pairs. Both the key and value must be
263
184
  * strings.
264
185
  */
265
186
  metadata?: Record<string, string>;
266
- }
187
+ /**
188
+ * The reconciliation filters you have for this payment.
189
+ */
190
+ reconciliation_filters?: unknown | null;
191
+ /**
192
+ * The reconciliation groups you have for this payment.
193
+ */
194
+ reconciliation_groups?: unknown | null;
195
+ /**
196
+ * For `ach`, this field will be passed through on an addenda record. For `wire`
197
+ * payments the field will be passed through as the "Originator to Beneficiary
198
+ * Information", also known as OBI or Fedwire tag 6000.
199
+ */
200
+ remittance_information?: string | null;
201
+ /**
202
+ * The statement description you expect to see on the transaction. For ACH
203
+ * payments, this will be the full line item passed from the bank. For wire
204
+ * payments, this will be the OBI field on the wire. For check payments, this will
205
+ * be the memo field.
206
+ */
207
+ statement_descriptor?: string | null;
208
+ /**
209
+ * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
210
+ * sepa, signet, wire.
211
+ */
212
+ type?: ExpectedPaymentType | null;
213
+ }
214
+ export declare namespace ExpectedPaymentCreateParams {
215
+ interface LineItem {
216
+ /**
217
+ * Value in specified currency's smallest unit. e.g. $10 would be represented
218
+ * as 1000.
219
+ */
220
+ amount: number;
221
+ /**
222
+ * The ID of one of your accounting categories. Note that these will only be
223
+ * accessible if your accounting system has been connected.
224
+ */
225
+ accounting_category_id?: string | null;
226
+ /**
227
+ * A free-form description of the line item.
228
+ */
229
+ description?: string | null;
230
+ /**
231
+ * Additional data represented as key-value pairs. Both the key and value must be
232
+ * strings.
233
+ */
234
+ metadata?: Record<string, string>;
235
+ }
267
236
  }
268
237
  export interface ExpectedPaymentUpdateParams {
269
- /**
270
- * The lowest amount this expected payment may be equal to. Value in specified
271
- * currency's smallest unit. e.g. $10 would be represented as 1000.
272
- */
273
- amount_lower_bound?: number;
274
- /**
275
- * The highest amount this expected payment may be equal to. Value in specified
276
- * currency's smallest unit. e.g. $10 would be represented as 1000.
277
- */
278
- amount_upper_bound?: number;
279
- /**
280
- * The ID of the counterparty you expect for this payment.
281
- */
282
- counterparty_id?: string | null;
283
- /**
284
- * Must conform to ISO 4217. Defaults to the currency of the internal account.
285
- */
286
- currency?: Shared.Currency | null;
287
- /**
288
- * The earliest date the payment may come in. Format: yyyy-mm-dd
289
- */
290
- date_lower_bound?: string | null;
291
- /**
292
- * The latest date the payment may come in. Format: yyyy-mm-dd
293
- */
294
- date_upper_bound?: string | null;
295
- /**
296
- * An optional description for internal use.
297
- */
298
- description?: string | null;
299
- /**
300
- * One of credit or debit. When you are receiving money, use credit. When you are
301
- * being charged, use debit.
302
- */
303
- direction?: 'credit' | 'debit';
304
- /**
305
- * The ID of the Internal Account for the expected payment.
306
- */
307
- internal_account_id?: string;
308
- /**
309
- * Additional data represented as key-value pairs. Both the key and value must be
310
- * strings.
311
- */
312
- metadata?: Record<string, string>;
313
- /**
314
- * The reconciliation filters you have for this payment.
315
- */
316
- reconciliation_filters?: unknown | null;
317
- /**
318
- * The reconciliation groups you have for this payment.
319
- */
320
- reconciliation_groups?: unknown | null;
321
- /**
322
- * For `ach`, this field will be passed through on an addenda record. For `wire`
323
- * payments the field will be passed through as the "Originator to Beneficiary
324
- * Information", also known as OBI or Fedwire tag 6000.
325
- */
326
- remittance_information?: string | null;
327
- /**
328
- * The statement description you expect to see on the transaction. For ACH
329
- * payments, this will be the full line item passed from the bank. For wire
330
- * payments, this will be the OBI field on the wire. For check payments, this will
331
- * be the memo field.
332
- */
333
- statement_descriptor?: string | null;
334
- /**
335
- * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
336
- * sepa, signet, wire.
337
- */
338
- type?: ExpectedPaymentType | null;
238
+ /**
239
+ * The lowest amount this expected payment may be equal to. Value in specified
240
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
241
+ */
242
+ amount_lower_bound?: number;
243
+ /**
244
+ * The highest amount this expected payment may be equal to. Value in specified
245
+ * currency's smallest unit. e.g. $10 would be represented as 1000.
246
+ */
247
+ amount_upper_bound?: number;
248
+ /**
249
+ * The ID of the counterparty you expect for this payment.
250
+ */
251
+ counterparty_id?: string | null;
252
+ /**
253
+ * Must conform to ISO 4217. Defaults to the currency of the internal account.
254
+ */
255
+ currency?: Shared.Currency | null;
256
+ /**
257
+ * The earliest date the payment may come in. Format: yyyy-mm-dd
258
+ */
259
+ date_lower_bound?: string | null;
260
+ /**
261
+ * The latest date the payment may come in. Format: yyyy-mm-dd
262
+ */
263
+ date_upper_bound?: string | null;
264
+ /**
265
+ * An optional description for internal use.
266
+ */
267
+ description?: string | null;
268
+ /**
269
+ * One of credit or debit. When you are receiving money, use credit. When you are
270
+ * being charged, use debit.
271
+ */
272
+ direction?: 'credit' | 'debit';
273
+ /**
274
+ * The ID of the Internal Account for the expected payment.
275
+ */
276
+ internal_account_id?: string;
277
+ /**
278
+ * Additional data represented as key-value pairs. Both the key and value must be
279
+ * strings.
280
+ */
281
+ metadata?: Record<string, string>;
282
+ /**
283
+ * The reconciliation filters you have for this payment.
284
+ */
285
+ reconciliation_filters?: unknown | null;
286
+ /**
287
+ * The reconciliation groups you have for this payment.
288
+ */
289
+ reconciliation_groups?: unknown | null;
290
+ /**
291
+ * For `ach`, this field will be passed through on an addenda record. For `wire`
292
+ * payments the field will be passed through as the "Originator to Beneficiary
293
+ * Information", also known as OBI or Fedwire tag 6000.
294
+ */
295
+ remittance_information?: string | null;
296
+ /**
297
+ * The statement description you expect to see on the transaction. For ACH
298
+ * payments, this will be the full line item passed from the bank. For wire
299
+ * payments, this will be the OBI field on the wire. For check payments, this will
300
+ * be the memo field.
301
+ */
302
+ statement_descriptor?: string | null;
303
+ /**
304
+ * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
305
+ * sepa, signet, wire.
306
+ */
307
+ type?: ExpectedPaymentType | null;
339
308
  }
340
309
  export interface ExpectedPaymentListParams extends PageParams {
341
- /**
342
- * Specify counterparty_id to see expected_payments for a specific account.
343
- */
344
- counterparty_id?: string;
345
- /**
346
- * Used to return expected payments created after some datetime
347
- */
348
- created_at_lower_bound?: string;
349
- /**
350
- * Used to return expected payments created before some datetime
351
- */
352
- created_at_upper_bound?: string;
353
- /**
354
- * One of credit, debit
355
- */
356
- direction?: 'credit' | 'debit';
357
- /**
358
- * Specify internal_account_id to see expected_payments for a specific account.
359
- */
360
- internal_account_id?: string;
361
- /**
362
- * For example, if you want to query for records with metadata key `Type` and value
363
- * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
364
- * parameters.
365
- */
366
- metadata?: Record<string, string>;
367
- /**
368
- * One of unreconciled, reconciled, or archived.
369
- */
370
- status?: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
371
- /**
372
- * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
373
- * sepa, signet, wire
374
- */
375
- type?:
376
- | 'ach'
377
- | 'au_becs'
378
- | 'bacs'
379
- | 'book'
380
- | 'card'
381
- | 'check'
382
- | 'cross_border'
383
- | 'eft'
384
- | 'interac'
385
- | 'masav'
386
- | 'neft'
387
- | 'nics'
388
- | 'provxchange'
389
- | 'rtp'
390
- | 'se_bankgirot'
391
- | 'sen'
392
- | 'sepa'
393
- | 'sic'
394
- | 'signet'
395
- | 'wire'
396
- | 'zengin';
310
+ /**
311
+ * Specify counterparty_id to see expected_payments for a specific account.
312
+ */
313
+ counterparty_id?: string;
314
+ /**
315
+ * Used to return expected payments created after some datetime
316
+ */
317
+ created_at_lower_bound?: string;
318
+ /**
319
+ * Used to return expected payments created before some datetime
320
+ */
321
+ created_at_upper_bound?: string;
322
+ /**
323
+ * One of credit, debit
324
+ */
325
+ direction?: 'credit' | 'debit';
326
+ /**
327
+ * Specify internal_account_id to see expected_payments for a specific account.
328
+ */
329
+ internal_account_id?: string;
330
+ /**
331
+ * For example, if you want to query for records with metadata key `Type` and value
332
+ * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
333
+ * parameters.
334
+ */
335
+ metadata?: Record<string, string>;
336
+ /**
337
+ * One of unreconciled, reconciled, or archived.
338
+ */
339
+ status?: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
340
+ /**
341
+ * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
342
+ * sepa, signet, wire
343
+ */
344
+ type?: 'ach' | 'au_becs' | 'bacs' | 'book' | 'card' | 'check' | 'cross_border' | 'eft' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'se_bankgirot' | 'sen' | 'sepa' | 'sic' | 'signet' | 'wire' | 'zengin';
397
345
  }
398
346
  export declare namespace ExpectedPayments {
399
- export import ExpectedPayment = API.ExpectedPayment;
400
- export import ExpectedPaymentType = API.ExpectedPaymentType;
401
- type ExpectedPaymentsPage = _ExpectedPaymentsPage;
402
- export import ExpectedPaymentCreateParams = API.ExpectedPaymentCreateParams;
403
- export import ExpectedPaymentUpdateParams = API.ExpectedPaymentUpdateParams;
404
- export import ExpectedPaymentListParams = API.ExpectedPaymentListParams;
347
+ export import ExpectedPayment = API.ExpectedPayment;
348
+ export import ExpectedPaymentType = API.ExpectedPaymentType;
349
+ type ExpectedPaymentsPage = _ExpectedPaymentsPage;
350
+ export import ExpectedPaymentCreateParams = API.ExpectedPaymentCreateParams;
351
+ export import ExpectedPaymentUpdateParams = API.ExpectedPaymentUpdateParams;
352
+ export import ExpectedPaymentListParams = API.ExpectedPaymentListParams;
405
353
  }
406
354
  export {};
407
- //# sourceMappingURL=expected-payments.d.ts.map
355
+ //# sourceMappingURL=expected-payments.d.ts.map