increase 0.211.0 → 0.213.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (552) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/package.json +1 -1
  3. package/resources/account-numbers.d.ts +30 -0
  4. package/resources/account-numbers.d.ts.map +1 -1
  5. package/resources/account-numbers.js +22 -0
  6. package/resources/account-numbers.js.map +1 -1
  7. package/resources/account-numbers.mjs +22 -0
  8. package/resources/account-numbers.mjs.map +1 -1
  9. package/resources/account-statements.d.ts +16 -0
  10. package/resources/account-statements.d.ts.map +1 -1
  11. package/resources/account-statements.js +8 -0
  12. package/resources/account-statements.js.map +1 -1
  13. package/resources/account-statements.mjs +8 -0
  14. package/resources/account-statements.mjs.map +1 -1
  15. package/resources/account-transfers.d.ts +43 -0
  16. package/resources/account-transfers.d.ts.map +1 -1
  17. package/resources/account-transfers.js +35 -0
  18. package/resources/account-transfers.js.map +1 -1
  19. package/resources/account-transfers.mjs +35 -0
  20. package/resources/account-transfers.mjs.map +1 -1
  21. package/resources/accounts.d.ts +43 -0
  22. package/resources/accounts.d.ts.map +1 -1
  23. package/resources/accounts.js +28 -0
  24. package/resources/accounts.js.map +1 -1
  25. package/resources/accounts.mjs +28 -0
  26. package/resources/accounts.mjs.map +1 -1
  27. package/resources/ach-prenotifications.d.ts +26 -0
  28. package/resources/ach-prenotifications.d.ts.map +1 -1
  29. package/resources/ach-prenotifications.js +18 -0
  30. package/resources/ach-prenotifications.js.map +1 -1
  31. package/resources/ach-prenotifications.mjs +18 -0
  32. package/resources/ach-prenotifications.mjs.map +1 -1
  33. package/resources/ach-transfers.d.ts +38 -0
  34. package/resources/ach-transfers.d.ts.map +1 -1
  35. package/resources/ach-transfers.js +30 -0
  36. package/resources/ach-transfers.js.map +1 -1
  37. package/resources/ach-transfers.mjs +30 -0
  38. package/resources/ach-transfers.mjs.map +1 -1
  39. package/resources/bookkeeping-accounts.d.ts +33 -0
  40. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  41. package/resources/bookkeeping-accounts.js +17 -0
  42. package/resources/bookkeeping-accounts.js.map +1 -1
  43. package/resources/bookkeeping-accounts.mjs +17 -0
  44. package/resources/bookkeeping-accounts.mjs.map +1 -1
  45. package/resources/bookkeeping-entries.d.ts +16 -0
  46. package/resources/bookkeeping-entries.d.ts.map +1 -1
  47. package/resources/bookkeeping-entries.js +8 -0
  48. package/resources/bookkeeping-entries.js.map +1 -1
  49. package/resources/bookkeeping-entries.mjs +8 -0
  50. package/resources/bookkeeping-entries.mjs.map +1 -1
  51. package/resources/bookkeeping-entry-sets.d.ts +35 -0
  52. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  53. package/resources/bookkeeping-entry-sets.js +27 -0
  54. package/resources/bookkeeping-entry-sets.js.map +1 -1
  55. package/resources/bookkeeping-entry-sets.mjs +27 -0
  56. package/resources/bookkeeping-entry-sets.mjs.map +1 -1
  57. package/resources/card-disputes.d.ts +24 -0
  58. package/resources/card-disputes.d.ts.map +1 -1
  59. package/resources/card-disputes.js +16 -0
  60. package/resources/card-disputes.js.map +1 -1
  61. package/resources/card-disputes.mjs +16 -0
  62. package/resources/card-disputes.mjs.map +1 -1
  63. package/resources/card-payments.d.ts +15 -0
  64. package/resources/card-payments.d.ts.map +1 -1
  65. package/resources/card-payments.js +7 -0
  66. package/resources/card-payments.js.map +1 -1
  67. package/resources/card-payments.mjs +7 -0
  68. package/resources/card-payments.mjs.map +1 -1
  69. package/resources/card-purchase-supplements.d.ts +16 -0
  70. package/resources/card-purchase-supplements.d.ts.map +1 -1
  71. package/resources/card-purchase-supplements.js +8 -0
  72. package/resources/card-purchase-supplements.js.map +1 -1
  73. package/resources/card-purchase-supplements.mjs +8 -0
  74. package/resources/card-purchase-supplements.mjs.map +1 -1
  75. package/resources/cards.d.ts +36 -0
  76. package/resources/cards.d.ts.map +1 -1
  77. package/resources/cards.js +28 -0
  78. package/resources/cards.js.map +1 -1
  79. package/resources/cards.mjs +28 -0
  80. package/resources/cards.mjs.map +1 -1
  81. package/resources/check-deposits.d.ts +55 -18
  82. package/resources/check-deposits.d.ts.map +1 -1
  83. package/resources/check-deposits.js +17 -0
  84. package/resources/check-deposits.js.map +1 -1
  85. package/resources/check-deposits.mjs +17 -0
  86. package/resources/check-deposits.mjs.map +1 -1
  87. package/resources/check-transfers.d.ts +48 -0
  88. package/resources/check-transfers.d.ts.map +1 -1
  89. package/resources/check-transfers.js +40 -0
  90. package/resources/check-transfers.js.map +1 -1
  91. package/resources/check-transfers.mjs +40 -0
  92. package/resources/check-transfers.mjs.map +1 -1
  93. package/resources/declined-transactions.d.ts +16 -0
  94. package/resources/declined-transactions.d.ts.map +1 -1
  95. package/resources/declined-transactions.js +8 -0
  96. package/resources/declined-transactions.js.map +1 -1
  97. package/resources/declined-transactions.mjs +8 -0
  98. package/resources/declined-transactions.mjs.map +1 -1
  99. package/resources/digital-card-profiles.d.ts +44 -0
  100. package/resources/digital-card-profiles.d.ts.map +1 -1
  101. package/resources/digital-card-profiles.js +36 -0
  102. package/resources/digital-card-profiles.js.map +1 -1
  103. package/resources/digital-card-profiles.mjs +36 -0
  104. package/resources/digital-card-profiles.mjs.map +1 -1
  105. package/resources/digital-wallet-tokens.d.ts +16 -0
  106. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  107. package/resources/digital-wallet-tokens.js +8 -0
  108. package/resources/digital-wallet-tokens.js.map +1 -1
  109. package/resources/digital-wallet-tokens.mjs +8 -0
  110. package/resources/digital-wallet-tokens.mjs.map +1 -1
  111. package/resources/documents.d.ts +15 -0
  112. package/resources/documents.d.ts.map +1 -1
  113. package/resources/documents.js +7 -0
  114. package/resources/documents.js.map +1 -1
  115. package/resources/documents.mjs +7 -0
  116. package/resources/documents.mjs.map +1 -1
  117. package/resources/entities.d.ts +110 -0
  118. package/resources/entities.d.ts.map +1 -1
  119. package/resources/entities.js +102 -0
  120. package/resources/entities.js.map +1 -1
  121. package/resources/entities.mjs +102 -0
  122. package/resources/entities.mjs.map +1 -1
  123. package/resources/event-subscriptions.d.ts +32 -0
  124. package/resources/event-subscriptions.d.ts.map +1 -1
  125. package/resources/event-subscriptions.js +24 -0
  126. package/resources/event-subscriptions.js.map +1 -1
  127. package/resources/event-subscriptions.mjs +24 -0
  128. package/resources/event-subscriptions.mjs.map +1 -1
  129. package/resources/events.d.ts +15 -0
  130. package/resources/events.d.ts.map +1 -1
  131. package/resources/events.js +7 -0
  132. package/resources/events.js.map +1 -1
  133. package/resources/events.mjs +7 -0
  134. package/resources/events.mjs.map +1 -1
  135. package/resources/exports.d.ts +22 -0
  136. package/resources/exports.d.ts.map +1 -1
  137. package/resources/exports.js +14 -0
  138. package/resources/exports.js.map +1 -1
  139. package/resources/exports.mjs +14 -0
  140. package/resources/exports.mjs.map +1 -1
  141. package/resources/external-accounts.d.ts +34 -0
  142. package/resources/external-accounts.d.ts.map +1 -1
  143. package/resources/external-accounts.js +26 -0
  144. package/resources/external-accounts.js.map +1 -1
  145. package/resources/external-accounts.mjs +26 -0
  146. package/resources/external-accounts.mjs.map +1 -1
  147. package/resources/file-links.d.ts +7 -0
  148. package/resources/file-links.d.ts.map +1 -1
  149. package/resources/file-links.js +7 -0
  150. package/resources/file-links.js.map +1 -1
  151. package/resources/file-links.mjs +7 -0
  152. package/resources/file-links.mjs.map +1 -1
  153. package/resources/files.d.ts +23 -0
  154. package/resources/files.d.ts.map +1 -1
  155. package/resources/files.js +15 -0
  156. package/resources/files.js.map +1 -1
  157. package/resources/files.mjs +15 -0
  158. package/resources/files.mjs.map +1 -1
  159. package/resources/groups.d.ts +5 -0
  160. package/resources/groups.d.ts.map +1 -1
  161. package/resources/groups.js +5 -0
  162. package/resources/groups.js.map +1 -1
  163. package/resources/groups.mjs +5 -0
  164. package/resources/groups.mjs.map +1 -1
  165. package/resources/inbound-ach-transfers.d.ts +41 -0
  166. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  167. package/resources/inbound-ach-transfers.js +33 -0
  168. package/resources/inbound-ach-transfers.js.map +1 -1
  169. package/resources/inbound-ach-transfers.mjs +33 -0
  170. package/resources/inbound-ach-transfers.mjs.map +1 -1
  171. package/resources/inbound-check-deposits.d.ts +33 -0
  172. package/resources/inbound-check-deposits.d.ts.map +1 -1
  173. package/resources/inbound-check-deposits.js +25 -0
  174. package/resources/inbound-check-deposits.js.map +1 -1
  175. package/resources/inbound-check-deposits.mjs +25 -0
  176. package/resources/inbound-check-deposits.mjs.map +1 -1
  177. package/resources/inbound-mail-items.d.ts +16 -0
  178. package/resources/inbound-mail-items.d.ts.map +1 -1
  179. package/resources/inbound-mail-items.js +8 -0
  180. package/resources/inbound-mail-items.js.map +1 -1
  181. package/resources/inbound-mail-items.mjs +8 -0
  182. package/resources/inbound-mail-items.mjs.map +1 -1
  183. package/resources/inbound-real-time-payments-transfers.d.ts +16 -0
  184. package/resources/inbound-real-time-payments-transfers.d.ts.map +1 -1
  185. package/resources/inbound-real-time-payments-transfers.js +8 -0
  186. package/resources/inbound-real-time-payments-transfers.js.map +1 -1
  187. package/resources/inbound-real-time-payments-transfers.mjs +8 -0
  188. package/resources/inbound-real-time-payments-transfers.mjs.map +1 -1
  189. package/resources/inbound-wire-drawdown-requests.d.ts +16 -0
  190. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  191. package/resources/inbound-wire-drawdown-requests.js +8 -0
  192. package/resources/inbound-wire-drawdown-requests.js.map +1 -1
  193. package/resources/inbound-wire-drawdown-requests.mjs +8 -0
  194. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
  195. package/resources/inbound-wire-transfers.d.ts +25 -0
  196. package/resources/inbound-wire-transfers.d.ts.map +1 -1
  197. package/resources/inbound-wire-transfers.js +17 -0
  198. package/resources/inbound-wire-transfers.js.map +1 -1
  199. package/resources/inbound-wire-transfers.mjs +17 -0
  200. package/resources/inbound-wire-transfers.mjs.map +1 -1
  201. package/resources/intrafi-account-enrollments.d.ts +33 -0
  202. package/resources/intrafi-account-enrollments.d.ts.map +1 -1
  203. package/resources/intrafi-account-enrollments.js +25 -0
  204. package/resources/intrafi-account-enrollments.js.map +1 -1
  205. package/resources/intrafi-account-enrollments.mjs +25 -0
  206. package/resources/intrafi-account-enrollments.mjs.map +1 -1
  207. package/resources/intrafi-balances.d.ts +8 -0
  208. package/resources/intrafi-balances.d.ts.map +1 -1
  209. package/resources/intrafi-balances.js +8 -0
  210. package/resources/intrafi-balances.js.map +1 -1
  211. package/resources/intrafi-balances.mjs +8 -0
  212. package/resources/intrafi-balances.mjs.map +1 -1
  213. package/resources/intrafi-exclusions.d.ts +33 -0
  214. package/resources/intrafi-exclusions.d.ts.map +1 -1
  215. package/resources/intrafi-exclusions.js +25 -0
  216. package/resources/intrafi-exclusions.js.map +1 -1
  217. package/resources/intrafi-exclusions.mjs +25 -0
  218. package/resources/intrafi-exclusions.mjs.map +1 -1
  219. package/resources/lockboxes.d.ts +29 -0
  220. package/resources/lockboxes.d.ts.map +1 -1
  221. package/resources/lockboxes.js +21 -0
  222. package/resources/lockboxes.js.map +1 -1
  223. package/resources/lockboxes.mjs +21 -0
  224. package/resources/lockboxes.mjs.map +1 -1
  225. package/resources/oauth-applications.d.ts +16 -0
  226. package/resources/oauth-applications.d.ts.map +1 -1
  227. package/resources/oauth-applications.js +8 -0
  228. package/resources/oauth-applications.js.map +1 -1
  229. package/resources/oauth-applications.mjs +8 -0
  230. package/resources/oauth-applications.mjs.map +1 -1
  231. package/resources/oauth-connections.d.ts +16 -0
  232. package/resources/oauth-connections.d.ts.map +1 -1
  233. package/resources/oauth-connections.js +8 -0
  234. package/resources/oauth-connections.js.map +1 -1
  235. package/resources/oauth-connections.mjs +8 -0
  236. package/resources/oauth-connections.mjs.map +1 -1
  237. package/resources/oauth-tokens.d.ts +7 -0
  238. package/resources/oauth-tokens.d.ts.map +1 -1
  239. package/resources/oauth-tokens.js +7 -0
  240. package/resources/oauth-tokens.js.map +1 -1
  241. package/resources/oauth-tokens.mjs +7 -0
  242. package/resources/oauth-tokens.mjs.map +1 -1
  243. package/resources/pending-transactions.d.ts +16 -0
  244. package/resources/pending-transactions.d.ts.map +1 -1
  245. package/resources/pending-transactions.js +8 -0
  246. package/resources/pending-transactions.js.map +1 -1
  247. package/resources/pending-transactions.mjs +8 -0
  248. package/resources/pending-transactions.mjs.map +1 -1
  249. package/resources/physical-card-profiles.d.ts +44 -0
  250. package/resources/physical-card-profiles.d.ts.map +1 -1
  251. package/resources/physical-card-profiles.js +36 -0
  252. package/resources/physical-card-profiles.js.map +1 -1
  253. package/resources/physical-card-profiles.mjs +36 -0
  254. package/resources/physical-card-profiles.mjs.map +1 -1
  255. package/resources/physical-cards.d.ts +46 -0
  256. package/resources/physical-cards.d.ts.map +1 -1
  257. package/resources/physical-cards.js +33 -0
  258. package/resources/physical-cards.js.map +1 -1
  259. package/resources/physical-cards.mjs +33 -0
  260. package/resources/physical-cards.mjs.map +1 -1
  261. package/resources/programs.d.ts +15 -0
  262. package/resources/programs.d.ts.map +1 -1
  263. package/resources/programs.js +7 -0
  264. package/resources/programs.js.map +1 -1
  265. package/resources/programs.mjs +7 -0
  266. package/resources/programs.mjs.map +1 -1
  267. package/resources/real-time-decisions.d.ts +16 -0
  268. package/resources/real-time-decisions.d.ts.map +1 -1
  269. package/resources/real-time-decisions.js +16 -0
  270. package/resources/real-time-decisions.js.map +1 -1
  271. package/resources/real-time-decisions.mjs +16 -0
  272. package/resources/real-time-decisions.mjs.map +1 -1
  273. package/resources/real-time-payments-transfers.d.ts +28 -0
  274. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  275. package/resources/real-time-payments-transfers.js +20 -0
  276. package/resources/real-time-payments-transfers.js.map +1 -1
  277. package/resources/real-time-payments-transfers.mjs +20 -0
  278. package/resources/real-time-payments-transfers.mjs.map +1 -1
  279. package/resources/routing-numbers.d.ts +10 -0
  280. package/resources/routing-numbers.d.ts.map +1 -1
  281. package/resources/routing-numbers.js +10 -0
  282. package/resources/routing-numbers.js.map +1 -1
  283. package/resources/routing-numbers.mjs +10 -0
  284. package/resources/routing-numbers.mjs.map +1 -1
  285. package/resources/simulations/account-statements.d.ts +8 -0
  286. package/resources/simulations/account-statements.d.ts.map +1 -1
  287. package/resources/simulations/account-statements.js +8 -0
  288. package/resources/simulations/account-statements.js.map +1 -1
  289. package/resources/simulations/account-statements.mjs +8 -0
  290. package/resources/simulations/account-statements.mjs.map +1 -1
  291. package/resources/simulations/account-transfers.d.ts +8 -0
  292. package/resources/simulations/account-transfers.d.ts.map +1 -1
  293. package/resources/simulations/account-transfers.js +8 -0
  294. package/resources/simulations/account-transfers.js.map +1 -1
  295. package/resources/simulations/account-transfers.mjs +8 -0
  296. package/resources/simulations/account-transfers.mjs.map +1 -1
  297. package/resources/simulations/ach-transfers.d.ts +44 -0
  298. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  299. package/resources/simulations/ach-transfers.js +44 -0
  300. package/resources/simulations/ach-transfers.js.map +1 -1
  301. package/resources/simulations/ach-transfers.mjs +44 -0
  302. package/resources/simulations/ach-transfers.mjs.map +1 -1
  303. package/resources/simulations/card-authorization-expirations.d.ts +10 -0
  304. package/resources/simulations/card-authorization-expirations.d.ts.map +1 -1
  305. package/resources/simulations/card-authorization-expirations.js +10 -0
  306. package/resources/simulations/card-authorization-expirations.js.map +1 -1
  307. package/resources/simulations/card-authorization-expirations.mjs +10 -0
  308. package/resources/simulations/card-authorization-expirations.mjs.map +1 -1
  309. package/resources/simulations/card-authorizations.d.ts +8 -0
  310. package/resources/simulations/card-authorizations.d.ts.map +1 -1
  311. package/resources/simulations/card-authorizations.js +8 -0
  312. package/resources/simulations/card-authorizations.js.map +1 -1
  313. package/resources/simulations/card-authorizations.mjs +8 -0
  314. package/resources/simulations/card-authorizations.mjs.map +1 -1
  315. package/resources/simulations/card-disputes.d.ts +9 -0
  316. package/resources/simulations/card-disputes.d.ts.map +1 -1
  317. package/resources/simulations/card-disputes.js +9 -0
  318. package/resources/simulations/card-disputes.js.map +1 -1
  319. package/resources/simulations/card-disputes.mjs +9 -0
  320. package/resources/simulations/card-disputes.mjs.map +1 -1
  321. package/resources/simulations/card-fuel-confirmations.d.ts +9 -0
  322. package/resources/simulations/card-fuel-confirmations.d.ts.map +1 -1
  323. package/resources/simulations/card-fuel-confirmations.js +9 -0
  324. package/resources/simulations/card-fuel-confirmations.js.map +1 -1
  325. package/resources/simulations/card-fuel-confirmations.mjs +9 -0
  326. package/resources/simulations/card-fuel-confirmations.mjs.map +1 -1
  327. package/resources/simulations/card-increments.d.ts +9 -0
  328. package/resources/simulations/card-increments.d.ts.map +1 -1
  329. package/resources/simulations/card-increments.js +9 -0
  330. package/resources/simulations/card-increments.js.map +1 -1
  331. package/resources/simulations/card-increments.mjs +9 -0
  332. package/resources/simulations/card-increments.mjs.map +1 -1
  333. package/resources/simulations/card-refunds.d.ts +8 -0
  334. package/resources/simulations/card-refunds.d.ts.map +1 -1
  335. package/resources/simulations/card-refunds.js +8 -0
  336. package/resources/simulations/card-refunds.js.map +1 -1
  337. package/resources/simulations/card-refunds.mjs +8 -0
  338. package/resources/simulations/card-refunds.mjs.map +1 -1
  339. package/resources/simulations/card-reversals.d.ts +8 -0
  340. package/resources/simulations/card-reversals.d.ts.map +1 -1
  341. package/resources/simulations/card-reversals.js +8 -0
  342. package/resources/simulations/card-reversals.js.map +1 -1
  343. package/resources/simulations/card-reversals.mjs +8 -0
  344. package/resources/simulations/card-reversals.mjs.map +1 -1
  345. package/resources/simulations/card-settlements.d.ts +10 -0
  346. package/resources/simulations/card-settlements.d.ts.map +1 -1
  347. package/resources/simulations/card-settlements.js +10 -0
  348. package/resources/simulations/card-settlements.js.map +1 -1
  349. package/resources/simulations/card-settlements.mjs +10 -0
  350. package/resources/simulations/card-settlements.mjs.map +1 -1
  351. package/resources/simulations/check-deposits.d.ts +24 -0
  352. package/resources/simulations/check-deposits.d.ts.map +1 -1
  353. package/resources/simulations/check-deposits.js +24 -0
  354. package/resources/simulations/check-deposits.js.map +1 -1
  355. package/resources/simulations/check-deposits.mjs +24 -0
  356. package/resources/simulations/check-deposits.mjs.map +1 -1
  357. package/resources/simulations/check-transfers.d.ts +8 -0
  358. package/resources/simulations/check-transfers.d.ts.map +1 -1
  359. package/resources/simulations/check-transfers.js +8 -0
  360. package/resources/simulations/check-transfers.js.map +1 -1
  361. package/resources/simulations/check-transfers.mjs +8 -0
  362. package/resources/simulations/check-transfers.mjs.map +1 -1
  363. package/resources/simulations/digital-wallet-token-requests.d.ts +8 -0
  364. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  365. package/resources/simulations/digital-wallet-token-requests.js +8 -0
  366. package/resources/simulations/digital-wallet-token-requests.js.map +1 -1
  367. package/resources/simulations/digital-wallet-token-requests.mjs +8 -0
  368. package/resources/simulations/digital-wallet-token-requests.mjs.map +1 -1
  369. package/resources/simulations/documents.d.ts +7 -0
  370. package/resources/simulations/documents.d.ts.map +1 -1
  371. package/resources/simulations/documents.js +7 -0
  372. package/resources/simulations/documents.js.map +1 -1
  373. package/resources/simulations/documents.mjs +7 -0
  374. package/resources/simulations/documents.mjs.map +1 -1
  375. package/resources/simulations/inbound-ach-transfers.d.ts +10 -0
  376. package/resources/simulations/inbound-ach-transfers.d.ts.map +1 -1
  377. package/resources/simulations/inbound-ach-transfers.js +10 -0
  378. package/resources/simulations/inbound-ach-transfers.js.map +1 -1
  379. package/resources/simulations/inbound-ach-transfers.mjs +10 -0
  380. package/resources/simulations/inbound-ach-transfers.mjs.map +1 -1
  381. package/resources/simulations/inbound-check-deposits.d.ts +11 -0
  382. package/resources/simulations/inbound-check-deposits.d.ts.map +1 -1
  383. package/resources/simulations/inbound-check-deposits.js +11 -0
  384. package/resources/simulations/inbound-check-deposits.js.map +1 -1
  385. package/resources/simulations/inbound-check-deposits.mjs +11 -0
  386. package/resources/simulations/inbound-check-deposits.mjs.map +1 -1
  387. package/resources/simulations/inbound-funds-holds.d.ts +8 -0
  388. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  389. package/resources/simulations/inbound-funds-holds.js +8 -0
  390. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  391. package/resources/simulations/inbound-funds-holds.mjs +8 -0
  392. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  393. package/resources/simulations/inbound-mail-items.d.ts +9 -0
  394. package/resources/simulations/inbound-mail-items.d.ts.map +1 -1
  395. package/resources/simulations/inbound-mail-items.js +9 -0
  396. package/resources/simulations/inbound-mail-items.js.map +1 -1
  397. package/resources/simulations/inbound-mail-items.mjs +9 -0
  398. package/resources/simulations/inbound-mail-items.mjs.map +1 -1
  399. package/resources/simulations/inbound-real-time-payments-transfers.d.ts +12 -0
  400. package/resources/simulations/inbound-real-time-payments-transfers.d.ts.map +1 -1
  401. package/resources/simulations/inbound-real-time-payments-transfers.js +12 -0
  402. package/resources/simulations/inbound-real-time-payments-transfers.js.map +1 -1
  403. package/resources/simulations/inbound-real-time-payments-transfers.mjs +12 -0
  404. package/resources/simulations/inbound-real-time-payments-transfers.mjs.map +1 -1
  405. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +18 -0
  406. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  407. package/resources/simulations/inbound-wire-drawdown-requests.js +18 -0
  408. package/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -1
  409. package/resources/simulations/inbound-wire-drawdown-requests.mjs +18 -0
  410. package/resources/simulations/inbound-wire-drawdown-requests.mjs.map +1 -1
  411. package/resources/simulations/inbound-wire-transfers.d.ts +10 -0
  412. package/resources/simulations/inbound-wire-transfers.d.ts.map +1 -1
  413. package/resources/simulations/inbound-wire-transfers.js +10 -0
  414. package/resources/simulations/inbound-wire-transfers.js.map +1 -1
  415. package/resources/simulations/inbound-wire-transfers.mjs +10 -0
  416. package/resources/simulations/inbound-wire-transfers.mjs.map +1 -1
  417. package/resources/simulations/interest-payments.d.ts +9 -0
  418. package/resources/simulations/interest-payments.d.ts.map +1 -1
  419. package/resources/simulations/interest-payments.js +9 -0
  420. package/resources/simulations/interest-payments.js.map +1 -1
  421. package/resources/simulations/interest-payments.mjs +9 -0
  422. package/resources/simulations/interest-payments.mjs.map +1 -1
  423. package/resources/simulations/physical-cards.d.ts +9 -0
  424. package/resources/simulations/physical-cards.d.ts.map +1 -1
  425. package/resources/simulations/physical-cards.js +9 -0
  426. package/resources/simulations/physical-cards.js.map +1 -1
  427. package/resources/simulations/physical-cards.mjs +9 -0
  428. package/resources/simulations/physical-cards.mjs.map +1 -1
  429. package/resources/simulations/programs.d.ts +7 -0
  430. package/resources/simulations/programs.d.ts.map +1 -1
  431. package/resources/simulations/programs.js +7 -0
  432. package/resources/simulations/programs.js.map +1 -1
  433. package/resources/simulations/programs.mjs +7 -0
  434. package/resources/simulations/programs.mjs.map +1 -1
  435. package/resources/simulations/real-time-payments-transfers.d.ts +8 -0
  436. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  437. package/resources/simulations/real-time-payments-transfers.js +8 -0
  438. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  439. package/resources/simulations/real-time-payments-transfers.mjs +8 -0
  440. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  441. package/resources/simulations/wire-transfers.d.ts +16 -0
  442. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  443. package/resources/simulations/wire-transfers.js +16 -0
  444. package/resources/simulations/wire-transfers.js.map +1 -1
  445. package/resources/simulations/wire-transfers.mjs +16 -0
  446. package/resources/simulations/wire-transfers.mjs.map +1 -1
  447. package/resources/supplemental-documents.d.ts +19 -0
  448. package/resources/supplemental-documents.d.ts.map +1 -1
  449. package/resources/supplemental-documents.js +19 -0
  450. package/resources/supplemental-documents.js.map +1 -1
  451. package/resources/supplemental-documents.mjs +19 -0
  452. package/resources/supplemental-documents.mjs.map +1 -1
  453. package/resources/transactions.d.ts +45 -18
  454. package/resources/transactions.d.ts.map +1 -1
  455. package/resources/transactions.js +7 -0
  456. package/resources/transactions.js.map +1 -1
  457. package/resources/transactions.mjs +7 -0
  458. package/resources/transactions.mjs.map +1 -1
  459. package/resources/wire-drawdown-requests.d.ts +30 -0
  460. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  461. package/resources/wire-drawdown-requests.js +22 -0
  462. package/resources/wire-drawdown-requests.js.map +1 -1
  463. package/resources/wire-drawdown-requests.mjs +22 -0
  464. package/resources/wire-drawdown-requests.mjs.map +1 -1
  465. package/resources/wire-transfers.d.ts +39 -0
  466. package/resources/wire-transfers.d.ts.map +1 -1
  467. package/resources/wire-transfers.js +31 -0
  468. package/resources/wire-transfers.js.map +1 -1
  469. package/resources/wire-transfers.mjs +31 -0
  470. package/resources/wire-transfers.mjs.map +1 -1
  471. package/src/resources/account-numbers.ts +30 -0
  472. package/src/resources/account-statements.ts +16 -0
  473. package/src/resources/account-transfers.ts +43 -0
  474. package/src/resources/accounts.ts +43 -0
  475. package/src/resources/ach-prenotifications.ts +26 -0
  476. package/src/resources/ach-transfers.ts +38 -0
  477. package/src/resources/bookkeeping-accounts.ts +33 -0
  478. package/src/resources/bookkeeping-entries.ts +16 -0
  479. package/src/resources/bookkeeping-entry-sets.ts +35 -0
  480. package/src/resources/card-disputes.ts +24 -0
  481. package/src/resources/card-payments.ts +15 -0
  482. package/src/resources/card-purchase-supplements.ts +16 -0
  483. package/src/resources/cards.ts +36 -0
  484. package/src/resources/check-deposits.ts +55 -18
  485. package/src/resources/check-transfers.ts +48 -0
  486. package/src/resources/declined-transactions.ts +16 -0
  487. package/src/resources/digital-card-profiles.ts +44 -0
  488. package/src/resources/digital-wallet-tokens.ts +16 -0
  489. package/src/resources/documents.ts +15 -0
  490. package/src/resources/entities.ts +110 -0
  491. package/src/resources/event-subscriptions.ts +32 -0
  492. package/src/resources/events.ts +15 -0
  493. package/src/resources/exports.ts +22 -0
  494. package/src/resources/external-accounts.ts +34 -0
  495. package/src/resources/file-links.ts +7 -0
  496. package/src/resources/files.ts +23 -0
  497. package/src/resources/groups.ts +5 -0
  498. package/src/resources/inbound-ach-transfers.ts +41 -0
  499. package/src/resources/inbound-check-deposits.ts +33 -0
  500. package/src/resources/inbound-mail-items.ts +16 -0
  501. package/src/resources/inbound-real-time-payments-transfers.ts +16 -0
  502. package/src/resources/inbound-wire-drawdown-requests.ts +16 -0
  503. package/src/resources/inbound-wire-transfers.ts +25 -0
  504. package/src/resources/intrafi-account-enrollments.ts +33 -0
  505. package/src/resources/intrafi-balances.ts +8 -0
  506. package/src/resources/intrafi-exclusions.ts +33 -0
  507. package/src/resources/lockboxes.ts +29 -0
  508. package/src/resources/oauth-applications.ts +16 -0
  509. package/src/resources/oauth-connections.ts +16 -0
  510. package/src/resources/oauth-tokens.ts +7 -0
  511. package/src/resources/pending-transactions.ts +16 -0
  512. package/src/resources/physical-card-profiles.ts +44 -0
  513. package/src/resources/physical-cards.ts +47 -0
  514. package/src/resources/programs.ts +15 -0
  515. package/src/resources/real-time-decisions.ts +16 -0
  516. package/src/resources/real-time-payments-transfers.ts +28 -0
  517. package/src/resources/routing-numbers.ts +10 -0
  518. package/src/resources/simulations/account-statements.ts +8 -0
  519. package/src/resources/simulations/account-transfers.ts +8 -0
  520. package/src/resources/simulations/ach-transfers.ts +44 -0
  521. package/src/resources/simulations/card-authorization-expirations.ts +10 -0
  522. package/src/resources/simulations/card-authorizations.ts +8 -0
  523. package/src/resources/simulations/card-disputes.ts +9 -0
  524. package/src/resources/simulations/card-fuel-confirmations.ts +9 -0
  525. package/src/resources/simulations/card-increments.ts +9 -0
  526. package/src/resources/simulations/card-refunds.ts +8 -0
  527. package/src/resources/simulations/card-reversals.ts +8 -0
  528. package/src/resources/simulations/card-settlements.ts +10 -0
  529. package/src/resources/simulations/check-deposits.ts +24 -0
  530. package/src/resources/simulations/check-transfers.ts +8 -0
  531. package/src/resources/simulations/digital-wallet-token-requests.ts +8 -0
  532. package/src/resources/simulations/documents.ts +7 -0
  533. package/src/resources/simulations/inbound-ach-transfers.ts +10 -0
  534. package/src/resources/simulations/inbound-check-deposits.ts +11 -0
  535. package/src/resources/simulations/inbound-funds-holds.ts +8 -0
  536. package/src/resources/simulations/inbound-mail-items.ts +9 -0
  537. package/src/resources/simulations/inbound-real-time-payments-transfers.ts +12 -0
  538. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +18 -0
  539. package/src/resources/simulations/inbound-wire-transfers.ts +10 -0
  540. package/src/resources/simulations/interest-payments.ts +9 -0
  541. package/src/resources/simulations/physical-cards.ts +9 -0
  542. package/src/resources/simulations/programs.ts +7 -0
  543. package/src/resources/simulations/real-time-payments-transfers.ts +8 -0
  544. package/src/resources/simulations/wire-transfers.ts +16 -0
  545. package/src/resources/supplemental-documents.ts +19 -0
  546. package/src/resources/transactions.ts +45 -18
  547. package/src/resources/wire-drawdown-requests.ts +30 -0
  548. package/src/resources/wire-transfers.ts +39 -0
  549. package/src/version.ts +1 -1
  550. package/version.d.ts +1 -1
  551. package/version.js +1 -1
  552. package/version.mjs +1 -1
@@ -12,6 +12,14 @@ export class ACHTransfers extends APIResource {
12
12
  * within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal
13
13
  * Reserve, this endpoint allows you to skip that delay and add the acknowledgment
14
14
  * subresource to the ACH Transfer.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const achTransfer =
19
+ * await client.simulations.achTransfers.acknowledge(
20
+ * 'ach_transfer_uoxatyh3lt5evrsdvo7q',
21
+ * );
22
+ * ```
15
23
  */
16
24
  acknowledge(
17
25
  achTransferId: string,
@@ -23,6 +31,18 @@ export class ACHTransfers extends APIResource {
23
31
  /**
24
32
  * Simulates receiving a Notification of Change for an
25
33
  * [ACH Transfer](#ach-transfers).
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const achTransfer =
38
+ * await client.simulations.achTransfers.createNotificationOfChange(
39
+ * 'ach_transfer_uoxatyh3lt5evrsdvo7q',
40
+ * {
41
+ * change_code: 'incorrect_routing_number',
42
+ * corrected_data: '123456789',
43
+ * },
44
+ * );
45
+ * ```
26
46
  */
27
47
  createNotificationOfChange(
28
48
  achTransferId: string,
@@ -39,6 +59,14 @@ export class ACHTransfers extends APIResource {
39
59
  * Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
40
60
  * due to an error condition. This will also create a Transaction to account for
41
61
  * the returned funds. This transfer must first have a `status` of `submitted`.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const achTransfer =
66
+ * await client.simulations.achTransfers.return(
67
+ * 'ach_transfer_uoxatyh3lt5evrsdvo7q',
68
+ * );
69
+ * ```
42
70
  */
43
71
  return(
44
72
  achTransferId: string,
@@ -55,6 +83,14 @@ export class ACHTransfers extends APIResource {
55
83
  * `pending_submission`, the simulation will also submit the transfer. Without this
56
84
  * simulation the transfer will eventually settle on its own following the same
57
85
  * Federal Reserve timeline as in production.
86
+ *
87
+ * @example
88
+ * ```ts
89
+ * const achTransfer =
90
+ * await client.simulations.achTransfers.settle(
91
+ * 'ach_transfer_uoxatyh3lt5evrsdvo7q',
92
+ * );
93
+ * ```
58
94
  */
59
95
  settle(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfersAPI.ACHTransfer> {
60
96
  return this._client.post(`/simulations/ach_transfers/${achTransferId}/settle`, options);
@@ -67,6 +103,14 @@ export class ACHTransfers extends APIResource {
67
103
  * Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are
68
104
  * not submitted to the Federal Reserve, this endpoint allows you to skip that
69
105
  * delay and transition the ACH Transfer to a status of `submitted`.
106
+ *
107
+ * @example
108
+ * ```ts
109
+ * const achTransfer =
110
+ * await client.simulations.achTransfers.submit(
111
+ * 'ach_transfer_uoxatyh3lt5evrsdvo7q',
112
+ * );
113
+ * ```
70
114
  */
71
115
  submit(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfersAPI.ACHTransfer> {
72
116
  return this._client.post(`/simulations/ach_transfers/${achTransferId}/submit`, options);
@@ -7,6 +7,16 @@ import * as CardPaymentsAPI from '../card-payments';
7
7
  export class CardAuthorizationExpirations extends APIResource {
8
8
  /**
9
9
  * Simulates expiring a Card Authorization immediately.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const cardPayment =
14
+ * await client.simulations.cardAuthorizationExpirations.create(
15
+ * {
16
+ * card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
17
+ * },
18
+ * );
19
+ * ```
10
20
  */
11
21
  create(
12
22
  body: CardAuthorizationExpirationCreateParams,
@@ -14,6 +14,14 @@ export class CardAuthorizations extends APIResource {
14
14
  * `card_decline`. You can pass either a Card id or a
15
15
  * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
16
16
  * ways purchases can be made.
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const cardAuthorization =
21
+ * await client.simulations.cardAuthorizations.create({
22
+ * amount: 1000,
23
+ * });
24
+ * ```
17
25
  */
18
26
  create(
19
27
  body: CardAuthorizationCreateParams,
@@ -10,6 +10,15 @@ export class CardDisputes extends APIResource {
10
10
  * will be reviewed. Since no review happens in sandbox, this endpoint simulates
11
11
  * moving a Card Dispute into a rejected or accepted state. A Card Dispute can only
12
12
  * be actioned one time and must have a status of `pending_reviewing`.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const cardDispute =
17
+ * await client.simulations.cardDisputes.action(
18
+ * 'card_dispute_h9sc95nbl1cgltpp7men',
19
+ * { status: 'rejected' },
20
+ * );
21
+ * ```
13
22
  */
14
23
  action(
15
24
  cardDisputeId: string,
@@ -9,6 +9,15 @@ export class CardFuelConfirmations extends APIResource {
9
9
  * Simulates the fuel confirmation of an authorization by a card acquirer. This
10
10
  * happens asynchronously right after a fuel pump transaction is completed. A fuel
11
11
  * confirmation can only happen once per authorization.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const cardPayment =
16
+ * await client.simulations.cardFuelConfirmations.create({
17
+ * amount: 5000,
18
+ * card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
19
+ * });
20
+ * ```
12
21
  */
13
22
  create(
14
23
  body: CardFuelConfirmationCreateParams,
@@ -8,6 +8,15 @@ export class CardIncrements extends APIResource {
8
8
  /**
9
9
  * Simulates the increment of an authorization by a card acquirer. An authorization
10
10
  * can be incremented multiple times.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const cardPayment =
15
+ * await client.simulations.cardIncrements.create({
16
+ * amount: 500,
17
+ * card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
18
+ * });
19
+ * ```
11
20
  */
12
21
  create(
13
22
  body: CardIncrementCreateParams,
@@ -8,6 +8,14 @@ export class CardRefunds extends APIResource {
8
8
  /**
9
9
  * Simulates refunding a card transaction. The full value of the original sandbox
10
10
  * transaction is refunded.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const transaction =
15
+ * await client.simulations.cardRefunds.create({
16
+ * transaction_id: 'transaction_uyrp7fld2ium70oa7oi',
17
+ * });
18
+ * ```
11
19
  */
12
20
  create(
13
21
  body: CardRefundCreateParams,
@@ -10,6 +10,14 @@ export class CardReversals extends APIResource {
10
10
  * can be partially reversed multiple times, up until the total authorized amount.
11
11
  * Marks the pending transaction as complete if the authorization is fully
12
12
  * reversed.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const cardPayment =
17
+ * await client.simulations.cardReversals.create({
18
+ * card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
19
+ * });
20
+ * ```
13
21
  */
14
22
  create(
15
23
  body: CardReversalCreateParams,
@@ -11,6 +11,16 @@ export class CardSettlements extends APIResource {
11
11
  * simulates that event, which may occur many days after the purchase in
12
12
  * production. The amount settled can be different from the amount originally
13
13
  * authorized, for example, when adding a tip to a restaurant bill.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const transaction =
18
+ * await client.simulations.cardSettlements.create({
19
+ * card_id: 'card_oubs0hwk5rn6knuecxg2',
20
+ * pending_transaction_id:
21
+ * 'pending_transaction_k1sfetcau2qbvjbzgju4',
22
+ * });
23
+ * ```
14
24
  */
15
25
  create(
16
26
  body: CardSettlementCreateParams,
@@ -9,6 +9,14 @@ export class CheckDeposits extends APIResource {
9
9
  * Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
10
10
  * factors like poor image quality. This Check Deposit must first have a `status`
11
11
  * of `pending`.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const checkDeposit =
16
+ * await client.simulations.checkDeposits.reject(
17
+ * 'check_deposit_f06n9gpg7sxn8t19lfc1',
18
+ * );
19
+ * ```
12
20
  */
13
21
  reject(
14
22
  checkDepositId: string,
@@ -20,6 +28,14 @@ export class CheckDeposits extends APIResource {
20
28
  /**
21
29
  * Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit
22
30
  * must first have a `status` of `submitted`.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * const checkDeposit =
35
+ * await client.simulations.checkDeposits.return(
36
+ * 'check_deposit_f06n9gpg7sxn8t19lfc1',
37
+ * );
38
+ * ```
23
39
  */
24
40
  return(
25
41
  checkDepositId: string,
@@ -31,6 +47,14 @@ export class CheckDeposits extends APIResource {
31
47
  /**
32
48
  * Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
33
49
  * Reserve. This Check Deposit must first have a `status` of `pending`.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * const checkDeposit =
54
+ * await client.simulations.checkDeposits.submit(
55
+ * 'check_deposit_f06n9gpg7sxn8t19lfc1',
56
+ * );
57
+ * ```
34
58
  */
35
59
  submit(
36
60
  checkDepositId: string,
@@ -10,6 +10,14 @@ export class CheckTransfers extends APIResource {
10
10
  * periodically throughout the day in production but can be sped up in sandbox.
11
11
  * This transfer must first have a `status` of `pending_approval` or
12
12
  * `pending_submission`.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const checkTransfer =
17
+ * await client.simulations.checkTransfers.mail(
18
+ * 'check_transfer_30b43acfu9vw8fyc4f5',
19
+ * );
20
+ * ```
13
21
  */
14
22
  mail(
15
23
  checkTransferId: string,
@@ -7,6 +7,14 @@ export class DigitalWalletTokenRequests extends APIResource {
7
7
  /**
8
8
  * Simulates a user attempting add a [Card](#cards) to a digital wallet such as
9
9
  * Apple Pay.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const digitalWalletTokenRequest =
14
+ * await client.simulations.digitalWalletTokenRequests.create(
15
+ * { card_id: 'card_oubs0hwk5rn6knuecxg2' },
16
+ * );
17
+ * ```
10
18
  */
11
19
  create(
12
20
  body: DigitalWalletTokenRequestCreateParams,
@@ -7,6 +7,13 @@ import * as DocumentsAPI from '../documents';
7
7
  export class Documents extends APIResource {
8
8
  /**
9
9
  * Simulates an tax document being created for an account.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const document = await client.simulations.documents.create({
14
+ * account_id: 'account_in71c4amph0vgo2qllky',
15
+ * });
16
+ * ```
10
17
  */
11
18
  create(body: DocumentCreateParams, options?: Core.RequestOptions): Core.APIPromise<DocumentsAPI.Document> {
12
19
  return this._client.post('/simulations/documents', { body, ...options });
@@ -16,6 +16,16 @@ export class InboundACHTransfers extends APIResource {
16
16
  * contain either a [Transaction](#transactions) or a
17
17
  * [Declined Transaction](#declined-transactions) depending on whether or not the
18
18
  * transfer is allowed.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const inboundACHTransfer =
23
+ * await client.simulations.inboundACHTransfers.create({
24
+ * account_number_id:
25
+ * 'account_number_v18nkfqm6afpsrvy82b2',
26
+ * amount: 1000,
27
+ * });
28
+ * ```
19
29
  */
20
30
  create(
21
31
  body: InboundACHTransferCreateParams,
@@ -12,6 +12,17 @@ export class InboundCheckDeposits extends APIResource {
12
12
  * Deposit as we would in production and either create a Transaction or a Declined
13
13
  * Transaction as a result. You can inspect the resulting Inbound Check Deposit
14
14
  * object to see the result.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const inboundCheckDeposit =
19
+ * await client.simulations.inboundCheckDeposits.create({
20
+ * account_number_id:
21
+ * 'account_number_v18nkfqm6afpsrvy82b2',
22
+ * amount: 1000,
23
+ * check_number: '1234567890',
24
+ * });
25
+ * ```
15
26
  */
16
27
  create(
17
28
  body: InboundCheckDepositCreateParams,
@@ -7,6 +7,14 @@ export class InboundFundsHolds extends APIResource {
7
7
  /**
8
8
  * This endpoint simulates immediately releasing an Inbound Funds Hold, which might
9
9
  * be created as a result of e.g., an ACH debit.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const response =
14
+ * await client.simulations.inboundFundsHolds.release(
15
+ * 'inbound_funds_hold_9vuasmywdo7xb3zt4071',
16
+ * );
17
+ * ```
10
18
  */
11
19
  release(
12
20
  inboundFundsHoldId: string,
@@ -8,6 +8,15 @@ export class InboundMailItems extends APIResource {
8
8
  /**
9
9
  * Simulates an inbound mail item to your account, as if someone had mailed a
10
10
  * physical check to one of your account's Lockboxes.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const inboundMailItem =
15
+ * await client.simulations.inboundMailItems.create({
16
+ * amount: 1000,
17
+ * lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
18
+ * });
19
+ * ```
11
20
  */
12
21
  create(
13
22
  body: InboundMailItemCreateParams,
@@ -9,6 +9,18 @@ export class InboundRealTimePaymentsTransfers extends APIResource {
9
9
  * Simulates an
10
10
  * [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to
11
11
  * your account. Real-Time Payments are a beta feature.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const inboundRealTimePaymentsTransfer =
16
+ * await client.simulations.inboundRealTimePaymentsTransfers.create(
17
+ * {
18
+ * account_number_id:
19
+ * 'account_number_v18nkfqm6afpsrvy82b2',
20
+ * amount: 1000,
21
+ * },
22
+ * );
23
+ * ```
12
24
  */
13
25
  create(
14
26
  body: InboundRealTimePaymentsTransferCreateParams,
@@ -8,6 +8,24 @@ export class InboundWireDrawdownRequests extends APIResource {
8
8
  /**
9
9
  * Simulates receiving an
10
10
  * [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const inboundWireDrawdownRequest =
15
+ * await client.simulations.inboundWireDrawdownRequests.create(
16
+ * {
17
+ * amount: 10000,
18
+ * beneficiary_account_number: '987654321',
19
+ * beneficiary_routing_number: '101050001',
20
+ * currency: 'USD',
21
+ * message_to_recipient: 'Invoice 29582',
22
+ * originator_account_number: '987654321',
23
+ * originator_routing_number: '101050001',
24
+ * recipient_account_number_id:
25
+ * 'account_number_v18nkfqm6afpsrvy82b2',
26
+ * },
27
+ * );
28
+ * ```
11
29
  */
12
30
  create(
13
31
  body: InboundWireDrawdownRequestCreateParams,
@@ -7,6 +7,16 @@ import * as InboundWireTransfersAPI from '../inbound-wire-transfers';
7
7
  export class InboundWireTransfers extends APIResource {
8
8
  /**
9
9
  * Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const inboundWireTransfer =
14
+ * await client.simulations.inboundWireTransfers.create({
15
+ * account_number_id:
16
+ * 'account_number_v18nkfqm6afpsrvy82b2',
17
+ * amount: 1000,
18
+ * });
19
+ * ```
10
20
  */
11
21
  create(
12
22
  body: InboundWireTransferCreateParams,
@@ -8,6 +8,15 @@ export class InterestPayments extends APIResource {
8
8
  /**
9
9
  * Simulates an interest payment to your account. In production, this happens
10
10
  * automatically on the first of each month.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const transaction =
15
+ * await client.simulations.interestPayments.create({
16
+ * account_id: 'account_in71c4amph0vgo2qllky',
17
+ * amount: 1000,
18
+ * });
19
+ * ```
11
20
  */
12
21
  create(
13
22
  body: InterestPaymentCreateParams,
@@ -9,6 +9,15 @@ export class PhysicalCards extends APIResource {
9
9
  * This endpoint allows you to simulate advancing the shipment status of a Physical
10
10
  * Card, to simulate e.g., that a physical card was attempted shipped but then
11
11
  * failed delivery.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const physicalCard =
16
+ * await client.simulations.physicalCards.advanceShipment(
17
+ * 'physical_card_ode8duyq5v2ynhjoharl',
18
+ * { shipment_status: 'shipped' },
19
+ * );
20
+ * ```
12
21
  */
13
22
  advanceShipment(
14
23
  physicalCardId: string,
@@ -10,6 +10,13 @@ export class Programs extends APIResource {
10
10
  * group has one program called Commercial Banking. Note that when your group
11
11
  * operates more than one program, `program_id` is a required field when creating
12
12
  * accounts.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const program = await client.simulations.programs.create({
17
+ * name: 'For Benefit Of',
18
+ * });
19
+ * ```
13
20
  */
14
21
  create(body: ProgramCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProgramsAPI.Program> {
15
22
  return this._client.post('/simulations/programs', { body, ...options });
@@ -10,6 +10,14 @@ export class RealTimePaymentsTransfers extends APIResource {
10
10
  * [Real-Time Payments Transfer](#real-time-payments-transfers) and handling the
11
11
  * response from the destination financial institution. This transfer must first
12
12
  * have a `status` of `pending_submission`.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const realTimePaymentsTransfer =
17
+ * await client.simulations.realTimePaymentsTransfers.complete(
18
+ * 'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
19
+ * );
20
+ * ```
13
21
  */
14
22
  complete(
15
23
  realTimePaymentsTransferId: string,
@@ -10,6 +10,14 @@ export class WireTransfers extends APIResource {
10
10
  * Reserve due to error conditions. This will also create a
11
11
  * [Transaction](#transaction) to account for the returned funds. This Wire
12
12
  * Transfer must first have a `status` of `complete`.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const wireTransfer =
17
+ * await client.simulations.wireTransfers.reverse(
18
+ * 'wire_transfer_5akynk7dqsq25qwk9q2u',
19
+ * );
20
+ * ```
13
21
  */
14
22
  reverse(
15
23
  wireTransferId: string,
@@ -22,6 +30,14 @@ export class WireTransfers extends APIResource {
22
30
  * Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal
23
31
  * Reserve. This transfer must first have a `status` of `pending_approval` or
24
32
  * `pending_creating`.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const wireTransfer =
37
+ * await client.simulations.wireTransfers.submit(
38
+ * 'wire_transfer_5akynk7dqsq25qwk9q2u',
39
+ * );
40
+ * ```
25
41
  */
26
42
  submit(
27
43
  wireTransferId: string,
@@ -7,6 +7,15 @@ import { Page, type PageParams } from '../pagination';
7
7
  export class SupplementalDocuments extends APIResource {
8
8
  /**
9
9
  * Create a supplemental document for an Entity
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const entitySupplementalDocument =
14
+ * await client.supplementalDocuments.create({
15
+ * entity_id: 'entity_n8y8tnk2p9339ti393yi',
16
+ * file_id: 'file_makxrc67oh9l6sg7w9yc',
17
+ * });
18
+ * ```
10
19
  */
11
20
  create(
12
21
  body: SupplementalDocumentCreateParams,
@@ -17,6 +26,16 @@ export class SupplementalDocuments extends APIResource {
17
26
 
18
27
  /**
19
28
  * List Entity Supplemental Document Submissions
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * // Automatically fetches more pages as needed.
33
+ * for await (const entitySupplementalDocument of client.supplementalDocuments.list(
34
+ * { entity_id: 'entity_id' },
35
+ * )) {
36
+ * // ...
37
+ * }
38
+ * ```
20
39
  */
21
40
  list(
22
41
  query: SupplementalDocumentListParams,
@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
8
8
  export class Transactions extends APIResource {
9
9
  /**
10
10
  * Retrieve a Transaction
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const transaction = await client.transactions.retrieve(
15
+ * 'transaction_uyrp7fld2ium70oa7oi',
16
+ * );
17
+ * ```
11
18
  */
12
19
  retrieve(transactionId: string, options?: Core.RequestOptions): Core.APIPromise<Transaction> {
13
20
  return this._client.get(`/transactions/${transactionId}`, options);
@@ -15,6 +22,14 @@ export class Transactions extends APIResource {
15
22
 
16
23
  /**
17
24
  * List Transactions
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * // Automatically fetches more pages as needed.
29
+ * for await (const transaction of client.transactions.list()) {
30
+ * // ...
31
+ * }
32
+ * ```
18
33
  */
19
34
  list(
20
35
  query?: TransactionListParams,
@@ -2510,34 +2525,46 @@ export namespace Transaction {
2510
2525
  * against.
2511
2526
  *
2512
2527
  * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
2513
- * - `closed_account` - The account is closed.
2514
- * - `duplicate_submission` - The check has already been deposited.
2515
- * - `insufficient_funds` - Insufficient funds
2516
- * - `no_account` - No account was found matching the check details.
2517
- * - `not_authorized` - The check was not authorized.
2518
- * - `stale_dated` - The check is too old.
2519
- * - `stop_payment` - The payment has been stopped by the account holder.
2528
+ * - `closed_account` - The account is closed. (Check21 return code `D`)
2529
+ * - `duplicate_submission` - The check has already been deposited. (Check21 return
2530
+ * code `Y`)
2531
+ * - `insufficient_funds` - Insufficient funds (Check21 return code `A`)
2532
+ * - `no_account` - No account was found matching the check details. (Check21
2533
+ * return code `E`)
2534
+ * - `not_authorized` - The check was not authorized. (Check21 return code `Q`)
2535
+ * - `stale_dated` - The check is too old. (Check21 return code `G`)
2536
+ * - `stop_payment` - The payment has been stopped by the account holder. (Check21
2537
+ * return code `C`)
2520
2538
  * - `unknown_reason` - The reason for the return is unknown.
2521
2539
  * - `unmatched_details` - The image doesn't match the details submitted.
2522
- * - `unreadable_image` - The image could not be read.
2523
- * - `endorsement_irregular` - The check endorsement was irregular.
2540
+ * - `unreadable_image` - The image could not be read. (Check21 return code `U`)
2541
+ * - `endorsement_irregular` - The check endorsement was irregular. (Check21 return
2542
+ * code `J`)
2524
2543
  * - `altered_or_fictitious_item` - The check present was either altered or fake.
2544
+ * (Check21 return code `N`)
2525
2545
  * - `frozen_or_blocked_account` - The account this check is drawn on is frozen.
2526
- * - `post_dated` - The check is post dated.
2527
- * - `endorsement_missing` - The endorsement was missing.
2528
- * - `signature_missing` - The check signature was missing.
2546
+ * (Check21 return code `F`)
2547
+ * - `post_dated` - The check is post dated. (Check21 return code `H`)
2548
+ * - `endorsement_missing` - The endorsement was missing. (Check21 return code `I`)
2549
+ * - `signature_missing` - The check signature was missing. (Check21 return code
2550
+ * `K`)
2529
2551
  * - `stop_payment_suspect` - The bank suspects a stop payment will be placed.
2530
- * - `unusable_image` - The bank cannot read the image.
2552
+ * (Check21 return code `T`)
2553
+ * - `unusable_image` - The bank cannot read the image. (Check21 return code `U`)
2531
2554
  * - `image_fails_security_check` - The check image fails the bank's security
2532
- * check.
2533
- * - `cannot_determine_amount` - The bank cannot determine the amount.
2555
+ * check. (Check21 return code `V`)
2556
+ * - `cannot_determine_amount` - The bank cannot determine the amount. (Check21
2557
+ * return code `W`)
2534
2558
  * - `signature_irregular` - The signature is inconsistent with prior signatures.
2559
+ * (Check21 return code `L`)
2535
2560
  * - `non_cash_item` - The check is a non-cash item and cannot be drawn against the
2536
- * account.
2537
- * - `unable_to_process` - The bank is unable to process this check.
2561
+ * account. (Check21 return code `M`)
2562
+ * - `unable_to_process` - The bank is unable to process this check. (Check21
2563
+ * return code `O`)
2538
2564
  * - `item_exceeds_dollar_limit` - The check exceeds the bank or customer's limit.
2565
+ * (Check21 return code `P`)
2539
2566
  * - `branch_or_account_sold` - The bank sold this account and no longer services
2540
- * this customer.
2567
+ * this customer. (Check21 return code `R`)
2541
2568
  */
2542
2569
  return_reason:
2543
2570
  | 'ach_conversion_not_supported'