@whop/sdk 0.0.27 → 0.0.28

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 (459) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/client.d.mts +4 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +4 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +7 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +7 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/access-tokens.d.mts +19 -20
  12. package/resources/access-tokens.d.mts.map +1 -1
  13. package/resources/access-tokens.d.ts +19 -20
  14. package/resources/access-tokens.d.ts.map +1 -1
  15. package/resources/access-tokens.js +4 -4
  16. package/resources/access-tokens.mjs +4 -4
  17. package/resources/account-links.d.mts +15 -13
  18. package/resources/account-links.d.mts.map +1 -1
  19. package/resources/account-links.d.ts +15 -13
  20. package/resources/account-links.d.ts.map +1 -1
  21. package/resources/account-links.js +2 -3
  22. package/resources/account-links.js.map +1 -1
  23. package/resources/account-links.mjs +2 -3
  24. package/resources/account-links.mjs.map +1 -1
  25. package/resources/ai-chats.d.mts +38 -26
  26. package/resources/ai-chats.d.mts.map +1 -1
  27. package/resources/ai-chats.d.ts +38 -26
  28. package/resources/ai-chats.d.ts.map +1 -1
  29. package/resources/ai-chats.js +5 -5
  30. package/resources/ai-chats.mjs +5 -5
  31. package/resources/app-builds.d.mts +35 -33
  32. package/resources/app-builds.d.mts.map +1 -1
  33. package/resources/app-builds.d.ts +35 -33
  34. package/resources/app-builds.d.ts.map +1 -1
  35. package/resources/app-builds.js +7 -4
  36. package/resources/app-builds.js.map +1 -1
  37. package/resources/app-builds.mjs +7 -4
  38. package/resources/app-builds.mjs.map +1 -1
  39. package/resources/apps.d.mts +81 -56
  40. package/resources/apps.d.mts.map +1 -1
  41. package/resources/apps.d.ts +81 -56
  42. package/resources/apps.d.ts.map +1 -1
  43. package/resources/apps.js +7 -4
  44. package/resources/apps.js.map +1 -1
  45. package/resources/apps.mjs +7 -4
  46. package/resources/apps.mjs.map +1 -1
  47. package/resources/authorized-users.d.mts +32 -26
  48. package/resources/authorized-users.d.mts.map +1 -1
  49. package/resources/authorized-users.d.ts +32 -26
  50. package/resources/authorized-users.d.ts.map +1 -1
  51. package/resources/authorized-users.js +3 -2
  52. package/resources/authorized-users.js.map +1 -1
  53. package/resources/authorized-users.mjs +3 -2
  54. package/resources/authorized-users.mjs.map +1 -1
  55. package/resources/chat-channels.d.mts +27 -19
  56. package/resources/chat-channels.d.mts.map +1 -1
  57. package/resources/chat-channels.d.ts +27 -19
  58. package/resources/chat-channels.d.ts.map +1 -1
  59. package/resources/chat-channels.js +5 -3
  60. package/resources/chat-channels.js.map +1 -1
  61. package/resources/chat-channels.mjs +5 -3
  62. package/resources/chat-channels.mjs.map +1 -1
  63. package/resources/checkout-configurations.d.mts +55 -46
  64. package/resources/checkout-configurations.d.mts.map +1 -1
  65. package/resources/checkout-configurations.d.ts +55 -46
  66. package/resources/checkout-configurations.d.ts.map +1 -1
  67. package/resources/checkout-configurations.js +3 -2
  68. package/resources/checkout-configurations.js.map +1 -1
  69. package/resources/checkout-configurations.mjs +3 -2
  70. package/resources/checkout-configurations.mjs.map +1 -1
  71. package/resources/companies.d.mts +65 -46
  72. package/resources/companies.d.mts.map +1 -1
  73. package/resources/companies.d.ts +65 -46
  74. package/resources/companies.d.ts.map +1 -1
  75. package/resources/companies.js +7 -8
  76. package/resources/companies.js.map +1 -1
  77. package/resources/companies.mjs +7 -8
  78. package/resources/companies.mjs.map +1 -1
  79. package/resources/company-token-transactions.d.mts +80 -57
  80. package/resources/company-token-transactions.d.mts.map +1 -1
  81. package/resources/company-token-transactions.d.ts +80 -57
  82. package/resources/company-token-transactions.d.ts.map +1 -1
  83. package/resources/company-token-transactions.js +6 -3
  84. package/resources/company-token-transactions.js.map +1 -1
  85. package/resources/company-token-transactions.mjs +6 -3
  86. package/resources/company-token-transactions.mjs.map +1 -1
  87. package/resources/course-chapters.d.mts +24 -19
  88. package/resources/course-chapters.d.mts.map +1 -1
  89. package/resources/course-chapters.d.ts +24 -19
  90. package/resources/course-chapters.d.ts.map +1 -1
  91. package/resources/course-chapters.js +5 -5
  92. package/resources/course-chapters.mjs +5 -5
  93. package/resources/course-lesson-interactions.d.mts +7 -6
  94. package/resources/course-lesson-interactions.d.mts.map +1 -1
  95. package/resources/course-lesson-interactions.d.ts +7 -6
  96. package/resources/course-lesson-interactions.d.ts.map +1 -1
  97. package/resources/course-lesson-interactions.js +3 -2
  98. package/resources/course-lesson-interactions.js.map +1 -1
  99. package/resources/course-lesson-interactions.mjs +3 -2
  100. package/resources/course-lesson-interactions.mjs.map +1 -1
  101. package/resources/course-lessons.d.mts +126 -84
  102. package/resources/course-lessons.d.mts.map +1 -1
  103. package/resources/course-lessons.d.ts +126 -84
  104. package/resources/course-lessons.d.ts.map +1 -1
  105. package/resources/course-lessons.js +12 -8
  106. package/resources/course-lessons.js.map +1 -1
  107. package/resources/course-lessons.mjs +12 -8
  108. package/resources/course-lessons.mjs.map +1 -1
  109. package/resources/course-students.d.mts +38 -29
  110. package/resources/course-students.d.mts.map +1 -1
  111. package/resources/course-students.d.ts +38 -29
  112. package/resources/course-students.d.ts.map +1 -1
  113. package/resources/course-students.js +3 -2
  114. package/resources/course-students.js.map +1 -1
  115. package/resources/course-students.mjs +3 -2
  116. package/resources/course-students.mjs.map +1 -1
  117. package/resources/courses.d.mts +132 -91
  118. package/resources/courses.d.mts.map +1 -1
  119. package/resources/courses.d.ts +132 -91
  120. package/resources/courses.d.ts.map +1 -1
  121. package/resources/courses.js +9 -5
  122. package/resources/courses.js.map +1 -1
  123. package/resources/courses.mjs +9 -5
  124. package/resources/courses.mjs.map +1 -1
  125. package/resources/disputes.d.mts +156 -102
  126. package/resources/disputes.d.mts.map +1 -1
  127. package/resources/disputes.d.ts +156 -102
  128. package/resources/disputes.d.ts.map +1 -1
  129. package/resources/disputes.js +4 -2
  130. package/resources/disputes.js.map +1 -1
  131. package/resources/disputes.mjs +4 -2
  132. package/resources/disputes.mjs.map +1 -1
  133. package/resources/dm-channels.d.mts +29 -16
  134. package/resources/dm-channels.d.mts.map +1 -1
  135. package/resources/dm-channels.d.ts +29 -16
  136. package/resources/dm-channels.d.ts.map +1 -1
  137. package/resources/dm-channels.js +9 -5
  138. package/resources/dm-channels.js.map +1 -1
  139. package/resources/dm-channels.mjs +9 -5
  140. package/resources/dm-channels.mjs.map +1 -1
  141. package/resources/dm-members.d.mts +30 -21
  142. package/resources/dm-members.d.mts.map +1 -1
  143. package/resources/dm-members.d.ts +30 -21
  144. package/resources/dm-members.d.ts.map +1 -1
  145. package/resources/dm-members.js +9 -5
  146. package/resources/dm-members.js.map +1 -1
  147. package/resources/dm-members.mjs +9 -5
  148. package/resources/dm-members.mjs.map +1 -1
  149. package/resources/entries.d.mts +29 -21
  150. package/resources/entries.d.mts.map +1 -1
  151. package/resources/entries.d.ts +29 -21
  152. package/resources/entries.d.ts.map +1 -1
  153. package/resources/entries.js +7 -4
  154. package/resources/entries.js.map +1 -1
  155. package/resources/entries.mjs +7 -4
  156. package/resources/entries.mjs.map +1 -1
  157. package/resources/experiences.d.mts +53 -45
  158. package/resources/experiences.d.mts.map +1 -1
  159. package/resources/experiences.d.ts +53 -45
  160. package/resources/experiences.d.ts.map +1 -1
  161. package/resources/experiences.js +6 -5
  162. package/resources/experiences.js.map +1 -1
  163. package/resources/experiences.mjs +6 -5
  164. package/resources/experiences.mjs.map +1 -1
  165. package/resources/fee-markups.d.mts +32 -21
  166. package/resources/fee-markups.d.mts.map +1 -1
  167. package/resources/fee-markups.d.ts +32 -21
  168. package/resources/fee-markups.d.ts.map +1 -1
  169. package/resources/fee-markups.js +6 -3
  170. package/resources/fee-markups.js.map +1 -1
  171. package/resources/fee-markups.mjs +6 -3
  172. package/resources/fee-markups.mjs.map +1 -1
  173. package/resources/files.d.mts +21 -17
  174. package/resources/files.d.mts.map +1 -1
  175. package/resources/files.d.ts +21 -17
  176. package/resources/files.d.ts.map +1 -1
  177. package/resources/files.js +3 -2
  178. package/resources/files.js.map +1 -1
  179. package/resources/files.mjs +3 -2
  180. package/resources/files.mjs.map +1 -1
  181. package/resources/forum-posts.d.mts +62 -43
  182. package/resources/forum-posts.d.mts.map +1 -1
  183. package/resources/forum-posts.d.ts +62 -43
  184. package/resources/forum-posts.d.ts.map +1 -1
  185. package/resources/forum-posts.js +8 -4
  186. package/resources/forum-posts.js.map +1 -1
  187. package/resources/forum-posts.mjs +8 -4
  188. package/resources/forum-posts.mjs.map +1 -1
  189. package/resources/forums.d.mts +20 -12
  190. package/resources/forums.d.mts.map +1 -1
  191. package/resources/forums.d.ts +20 -12
  192. package/resources/forums.d.ts.map +1 -1
  193. package/resources/forums.js +5 -3
  194. package/resources/forums.js.map +1 -1
  195. package/resources/forums.mjs +5 -3
  196. package/resources/forums.mjs.map +1 -1
  197. package/resources/index.d.mts +2 -2
  198. package/resources/index.d.mts.map +1 -1
  199. package/resources/index.d.ts +2 -2
  200. package/resources/index.d.ts.map +1 -1
  201. package/resources/index.js.map +1 -1
  202. package/resources/index.mjs.map +1 -1
  203. package/resources/invoices.d.mts +108 -80
  204. package/resources/invoices.d.mts.map +1 -1
  205. package/resources/invoices.d.ts +108 -80
  206. package/resources/invoices.d.ts.map +1 -1
  207. package/resources/invoices.js +7 -4
  208. package/resources/invoices.js.map +1 -1
  209. package/resources/invoices.mjs +7 -4
  210. package/resources/invoices.mjs.map +1 -1
  211. package/resources/leads.d.mts +64 -42
  212. package/resources/leads.d.mts.map +1 -1
  213. package/resources/leads.d.ts +64 -42
  214. package/resources/leads.d.ts.map +1 -1
  215. package/resources/leads.js +6 -4
  216. package/resources/leads.js.map +1 -1
  217. package/resources/leads.mjs +6 -4
  218. package/resources/leads.mjs.map +1 -1
  219. package/resources/ledger-accounts.d.mts +10 -8
  220. package/resources/ledger-accounts.d.mts.map +1 -1
  221. package/resources/ledger-accounts.d.ts +10 -8
  222. package/resources/ledger-accounts.d.ts.map +1 -1
  223. package/resources/ledger-accounts.js +1 -1
  224. package/resources/ledger-accounts.mjs +1 -1
  225. package/resources/members.d.mts +18 -19
  226. package/resources/members.d.mts.map +1 -1
  227. package/resources/members.d.ts +18 -19
  228. package/resources/members.d.ts.map +1 -1
  229. package/resources/members.js +3 -2
  230. package/resources/members.js.map +1 -1
  231. package/resources/members.mjs +3 -2
  232. package/resources/members.mjs.map +1 -1
  233. package/resources/memberships.d.mts +69 -51
  234. package/resources/memberships.d.mts.map +1 -1
  235. package/resources/memberships.d.ts +69 -51
  236. package/resources/memberships.d.ts.map +1 -1
  237. package/resources/memberships.js +12 -8
  238. package/resources/memberships.js.map +1 -1
  239. package/resources/memberships.mjs +12 -8
  240. package/resources/memberships.mjs.map +1 -1
  241. package/resources/messages.d.mts +46 -32
  242. package/resources/messages.d.mts.map +1 -1
  243. package/resources/messages.d.ts +46 -32
  244. package/resources/messages.d.ts.map +1 -1
  245. package/resources/messages.js +9 -5
  246. package/resources/messages.js.map +1 -1
  247. package/resources/messages.mjs +9 -5
  248. package/resources/messages.mjs.map +1 -1
  249. package/resources/notifications.d.mts +33 -25
  250. package/resources/notifications.d.mts.map +1 -1
  251. package/resources/notifications.d.ts +33 -25
  252. package/resources/notifications.d.ts.map +1 -1
  253. package/resources/notifications.js +2 -1
  254. package/resources/notifications.js.map +1 -1
  255. package/resources/notifications.mjs +2 -1
  256. package/resources/notifications.mjs.map +1 -1
  257. package/resources/payment-methods.d.mts +212 -114
  258. package/resources/payment-methods.d.mts.map +1 -1
  259. package/resources/payment-methods.d.ts +212 -114
  260. package/resources/payment-methods.d.ts.map +1 -1
  261. package/resources/payment-methods.js +5 -10
  262. package/resources/payment-methods.js.map +1 -1
  263. package/resources/payment-methods.mjs +5 -10
  264. package/resources/payment-methods.mjs.map +1 -1
  265. package/resources/payments.d.mts +73 -40
  266. package/resources/payments.d.mts.map +1 -1
  267. package/resources/payments.d.ts +73 -40
  268. package/resources/payments.d.ts.map +1 -1
  269. package/resources/payments.js +23 -10
  270. package/resources/payments.js.map +1 -1
  271. package/resources/payments.mjs +23 -10
  272. package/resources/payments.mjs.map +1 -1
  273. package/resources/payout-methods.d.mts +44 -29
  274. package/resources/payout-methods.d.mts.map +1 -1
  275. package/resources/payout-methods.d.ts +44 -29
  276. package/resources/payout-methods.d.ts.map +1 -1
  277. package/resources/payout-methods.js +3 -2
  278. package/resources/payout-methods.js.map +1 -1
  279. package/resources/payout-methods.mjs +3 -2
  280. package/resources/payout-methods.mjs.map +1 -1
  281. package/resources/plans.d.mts +121 -90
  282. package/resources/plans.d.mts.map +1 -1
  283. package/resources/plans.d.ts +121 -90
  284. package/resources/plans.d.ts.map +1 -1
  285. package/resources/plans.js +9 -5
  286. package/resources/plans.js.map +1 -1
  287. package/resources/plans.mjs +9 -5
  288. package/resources/plans.mjs.map +1 -1
  289. package/resources/products.d.mts +76 -65
  290. package/resources/products.d.mts.map +1 -1
  291. package/resources/products.d.ts +76 -65
  292. package/resources/products.d.ts.map +1 -1
  293. package/resources/products.js +7 -5
  294. package/resources/products.js.map +1 -1
  295. package/resources/products.mjs +7 -5
  296. package/resources/products.mjs.map +1 -1
  297. package/resources/promo-codes.d.mts +41 -31
  298. package/resources/promo-codes.d.mts.map +1 -1
  299. package/resources/promo-codes.d.ts +41 -31
  300. package/resources/promo-codes.d.ts.map +1 -1
  301. package/resources/promo-codes.js +7 -4
  302. package/resources/promo-codes.js.map +1 -1
  303. package/resources/promo-codes.mjs +7 -4
  304. package/resources/promo-codes.mjs.map +1 -1
  305. package/resources/reactions.d.mts +24 -18
  306. package/resources/reactions.d.mts.map +1 -1
  307. package/resources/reactions.d.ts +24 -18
  308. package/resources/reactions.d.ts.map +1 -1
  309. package/resources/reactions.js +7 -4
  310. package/resources/reactions.js.map +1 -1
  311. package/resources/reactions.mjs +7 -4
  312. package/resources/reactions.mjs.map +1 -1
  313. package/resources/refunds.d.mts +43 -29
  314. package/resources/refunds.d.mts.map +1 -1
  315. package/resources/refunds.d.ts +43 -29
  316. package/resources/refunds.d.ts.map +1 -1
  317. package/resources/refunds.js +3 -2
  318. package/resources/refunds.js.map +1 -1
  319. package/resources/refunds.mjs +3 -2
  320. package/resources/refunds.mjs.map +1 -1
  321. package/resources/reviews.d.mts +66 -50
  322. package/resources/reviews.d.mts.map +1 -1
  323. package/resources/reviews.d.ts +66 -50
  324. package/resources/reviews.d.ts.map +1 -1
  325. package/resources/reviews.js +3 -2
  326. package/resources/reviews.js.map +1 -1
  327. package/resources/reviews.mjs +3 -2
  328. package/resources/reviews.mjs.map +1 -1
  329. package/resources/setup-intents.d.mts +61 -43
  330. package/resources/setup-intents.d.mts.map +1 -1
  331. package/resources/setup-intents.d.ts +61 -43
  332. package/resources/setup-intents.d.ts.map +1 -1
  333. package/resources/setup-intents.js +4 -10
  334. package/resources/setup-intents.js.map +1 -1
  335. package/resources/setup-intents.mjs +4 -10
  336. package/resources/setup-intents.mjs.map +1 -1
  337. package/resources/shared.d.mts +695 -388
  338. package/resources/shared.d.mts.map +1 -1
  339. package/resources/shared.d.ts +695 -388
  340. package/resources/shared.d.ts.map +1 -1
  341. package/resources/shipments.d.mts +26 -17
  342. package/resources/shipments.d.mts.map +1 -1
  343. package/resources/shipments.d.ts +26 -17
  344. package/resources/shipments.d.ts.map +1 -1
  345. package/resources/shipments.js +5 -3
  346. package/resources/shipments.js.map +1 -1
  347. package/resources/shipments.mjs +5 -3
  348. package/resources/shipments.mjs.map +1 -1
  349. package/resources/support-channels.d.mts +27 -19
  350. package/resources/support-channels.d.mts.map +1 -1
  351. package/resources/support-channels.d.ts +27 -19
  352. package/resources/support-channels.d.ts.map +1 -1
  353. package/resources/support-channels.js +5 -4
  354. package/resources/support-channels.js.map +1 -1
  355. package/resources/support-channels.mjs +5 -4
  356. package/resources/support-channels.mjs.map +1 -1
  357. package/resources/topups.d.mts +11 -9
  358. package/resources/topups.d.mts.map +1 -1
  359. package/resources/topups.d.ts +11 -9
  360. package/resources/topups.d.ts.map +1 -1
  361. package/resources/topups.js +2 -1
  362. package/resources/topups.js.map +1 -1
  363. package/resources/topups.mjs +2 -1
  364. package/resources/topups.mjs.map +1 -1
  365. package/resources/transfers.d.mts +35 -29
  366. package/resources/transfers.d.mts.map +1 -1
  367. package/resources/transfers.d.ts +35 -29
  368. package/resources/transfers.d.ts.map +1 -1
  369. package/resources/transfers.js +5 -3
  370. package/resources/transfers.js.map +1 -1
  371. package/resources/transfers.mjs +5 -3
  372. package/resources/transfers.mjs.map +1 -1
  373. package/resources/users.d.mts +20 -16
  374. package/resources/users.d.mts.map +1 -1
  375. package/resources/users.d.ts +20 -16
  376. package/resources/users.d.ts.map +1 -1
  377. package/resources/users.js +4 -3
  378. package/resources/users.js.map +1 -1
  379. package/resources/users.mjs +4 -3
  380. package/resources/users.mjs.map +1 -1
  381. package/resources/verifications.d.mts +6 -4
  382. package/resources/verifications.d.mts.map +1 -1
  383. package/resources/verifications.d.ts +6 -4
  384. package/resources/verifications.d.ts.map +1 -1
  385. package/resources/verifications.js +1 -1
  386. package/resources/verifications.mjs +1 -1
  387. package/resources/webhooks.d.mts +136 -95
  388. package/resources/webhooks.d.mts.map +1 -1
  389. package/resources/webhooks.d.ts +136 -95
  390. package/resources/webhooks.d.ts.map +1 -1
  391. package/resources/webhooks.js +3 -2
  392. package/resources/webhooks.js.map +1 -1
  393. package/resources/webhooks.mjs +3 -2
  394. package/resources/webhooks.mjs.map +1 -1
  395. package/resources/withdrawals.d.mts +53 -44
  396. package/resources/withdrawals.d.mts.map +1 -1
  397. package/resources/withdrawals.d.ts +53 -44
  398. package/resources/withdrawals.d.ts.map +1 -1
  399. package/resources/withdrawals.js +3 -2
  400. package/resources/withdrawals.js.map +1 -1
  401. package/resources/withdrawals.mjs +3 -2
  402. package/resources/withdrawals.mjs.map +1 -1
  403. package/src/client.ts +13 -3
  404. package/src/resources/access-tokens.ts +19 -20
  405. package/src/resources/account-links.ts +15 -13
  406. package/src/resources/ai-chats.ts +39 -26
  407. package/src/resources/app-builds.ts +35 -33
  408. package/src/resources/apps.ts +84 -56
  409. package/src/resources/authorized-users.ts +32 -26
  410. package/src/resources/chat-channels.ts +27 -19
  411. package/src/resources/checkout-configurations.ts +56 -46
  412. package/src/resources/companies.ts +68 -46
  413. package/src/resources/company-token-transactions.ts +81 -58
  414. package/src/resources/course-chapters.ts +24 -19
  415. package/src/resources/course-lesson-interactions.ts +7 -6
  416. package/src/resources/course-lessons.ts +126 -84
  417. package/src/resources/course-students.ts +38 -29
  418. package/src/resources/courses.ts +132 -91
  419. package/src/resources/disputes.ts +156 -102
  420. package/src/resources/dm-channels.ts +29 -16
  421. package/src/resources/dm-members.ts +30 -21
  422. package/src/resources/entries.ts +29 -21
  423. package/src/resources/experiences.ts +53 -45
  424. package/src/resources/fee-markups.ts +32 -21
  425. package/src/resources/files.ts +21 -17
  426. package/src/resources/forum-posts.ts +63 -43
  427. package/src/resources/forums.ts +20 -12
  428. package/src/resources/index.ts +2 -1
  429. package/src/resources/invoices.ts +112 -80
  430. package/src/resources/leads.ts +64 -42
  431. package/src/resources/ledger-accounts.ts +10 -8
  432. package/src/resources/members.ts +18 -19
  433. package/src/resources/memberships.ts +69 -51
  434. package/src/resources/messages.ts +46 -32
  435. package/src/resources/notifications.ts +33 -25
  436. package/src/resources/payment-methods.ts +212 -114
  437. package/src/resources/payments.ts +77 -39
  438. package/src/resources/payout-methods.ts +44 -29
  439. package/src/resources/plans.ts +121 -90
  440. package/src/resources/products.ts +215 -68
  441. package/src/resources/promo-codes.ts +41 -31
  442. package/src/resources/reactions.ts +24 -18
  443. package/src/resources/refunds.ts +44 -29
  444. package/src/resources/reviews.ts +66 -50
  445. package/src/resources/setup-intents.ts +61 -43
  446. package/src/resources/shared.ts +2637 -387
  447. package/src/resources/shipments.ts +26 -17
  448. package/src/resources/support-channels.ts +27 -19
  449. package/src/resources/topups.ts +11 -9
  450. package/src/resources/transfers.ts +35 -29
  451. package/src/resources/users.ts +20 -16
  452. package/src/resources/verifications.ts +6 -4
  453. package/src/resources/webhooks.ts +136 -95
  454. package/src/resources/withdrawals.ts +53 -43
  455. package/src/version.ts +1 -1
  456. package/version.d.mts +1 -1
  457. package/version.d.ts +1 -1
  458. package/version.js +1 -1
  459. package/version.mjs +1 -1
@@ -6,11 +6,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
6
6
  import { RequestOptions } from "../internal/request-options.js";
7
7
  export declare class PaymentMethods extends APIResource {
8
8
  /**
9
- * A payment method is a stored representation of how a customer intends to pay,
10
- * such as a card, bank account, or digital wallet. It holds the necessary billing
11
- * details and can be attached to a member for future one-time or recurring
12
- * charges. This lets you reuse the same payment credentials across multiple
13
- * payments. You must provide exactly one of company_id or member_id.
9
+ * Retrieves the details of an existing payment method.
14
10
  *
15
11
  * Required permissions:
16
12
  *
@@ -18,11 +14,10 @@ export declare class PaymentMethods extends APIResource {
18
14
  */
19
15
  retrieve(id: string, query?: PaymentMethodRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PaymentMethodRetrieveResponse>;
20
16
  /**
21
- * A payment method is a stored representation of how a customer intends to pay,
22
- * such as a card, bank account, or digital wallet. It holds the necessary billing
23
- * details and can be attached to a member for future one-time or recurring
24
- * charges. This lets you reuse the same payment credentials across multiple
25
- * payments.
17
+ * Returns a paginated list of payment methods for a member or company, with
18
+ * optional filtering by creation date. A payment method is a stored representation
19
+ * of how a customer intends to pay, such as a card, bank account, or digital
20
+ * wallet.
26
21
  *
27
22
  * Required permissions:
28
23
  *
@@ -32,24 +27,29 @@ export declare class PaymentMethods extends APIResource {
32
27
  }
33
28
  export type PaymentMethodListResponsesCursorPage = CursorPage<PaymentMethodListResponse>;
34
29
  /**
35
- * A payment method with no additional properties
30
+ * A saved payment method with no type-specific details available.
36
31
  */
37
32
  export type PaymentMethodRetrieveResponse = PaymentMethodRetrieveResponse.BasePaymentMethod | PaymentMethodRetrieveResponse.CardPaymentMethod | PaymentMethodRetrieveResponse.UsBankAccountPaymentMethod | PaymentMethodRetrieveResponse.CashappPaymentMethod | PaymentMethodRetrieveResponse.IdealPaymentMethod | PaymentMethodRetrieveResponse.SepaDebitPaymentMethod;
38
33
  export declare namespace PaymentMethodRetrieveResponse {
39
34
  /**
40
- * A payment method with no additional properties
35
+ * A saved payment method with no type-specific details available.
41
36
  */
42
37
  interface BasePaymentMethod {
43
38
  /**
44
- * The ID of the payment method
39
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
40
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
41
+ * as a String; however, it is not intended to be human-readable. When expected as
42
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
43
+ * input value will be accepted as an ID.
45
44
  */
46
45
  id: string;
47
46
  /**
48
- * When the payment method was created
47
+ * The time of the event in ISO 8601 UTC format with millisecond precision
49
48
  */
50
49
  created_at: string;
51
50
  /**
52
- * The type of the payment method
51
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
52
+ * cashapp, ideal, sepa_debit).
53
53
  */
54
54
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
55
55
  /**
@@ -58,23 +58,30 @@ export declare namespace PaymentMethodRetrieveResponse {
58
58
  typename: 'BasePaymentMethod';
59
59
  }
60
60
  /**
61
- * The card for the payment method
61
+ * A saved card payment method, including brand, last four digits, and expiration
62
+ * details.
62
63
  */
63
64
  interface CardPaymentMethod {
64
65
  /**
65
- * The ID of the payment method
66
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
67
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
68
+ * as a String; however, it is not intended to be human-readable. When expected as
69
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
70
+ * input value will be accepted as an ID.
66
71
  */
67
72
  id: string;
68
73
  /**
69
- * The card details associated with this payment method
74
+ * The card-specific details for this payment method, including brand, last four
75
+ * digits, and expiration.
70
76
  */
71
77
  card: CardPaymentMethod.Card;
72
78
  /**
73
- * When the payment method was created
79
+ * The time of the event in ISO 8601 UTC format with millisecond precision
74
80
  */
75
81
  created_at: string;
76
82
  /**
77
- * The type of the payment method
83
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
84
+ * cashapp, ideal, sepa_debit).
78
85
  */
79
86
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
80
87
  /**
@@ -84,7 +91,8 @@ export declare namespace PaymentMethodRetrieveResponse {
84
91
  }
85
92
  namespace CardPaymentMethod {
86
93
  /**
87
- * The card details associated with this payment method
94
+ * The card-specific details for this payment method, including brand, last four
95
+ * digits, and expiration.
88
96
  */
89
97
  interface Card {
90
98
  /**
@@ -92,33 +100,40 @@ export declare namespace PaymentMethodRetrieveResponse {
92
100
  */
93
101
  brand: PaymentsAPI.CardBrands | null;
94
102
  /**
95
- * Card expiration month, like 03 for March.
103
+ * The two-digit expiration month of the card (1-12). Null if not available.
96
104
  */
97
105
  exp_month: number | null;
98
106
  /**
99
- * Card expiration year, like 27 for 2027.
107
+ * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
108
+ * available.
100
109
  */
101
110
  exp_year: number | null;
102
111
  /**
103
- * Last four digits of the card.
112
+ * The last four digits of the card number. Null if not available.
104
113
  */
105
114
  last4: string | null;
106
115
  }
107
116
  }
108
117
  /**
109
- * The bank account for the payment method
118
+ * A saved US bank account payment method, including bank name, last four digits,
119
+ * and account type.
110
120
  */
111
121
  interface UsBankAccountPaymentMethod {
112
122
  /**
113
- * The ID of the payment method
123
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
124
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
125
+ * as a String; however, it is not intended to be human-readable. When expected as
126
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
127
+ * input value will be accepted as an ID.
114
128
  */
115
129
  id: string;
116
130
  /**
117
- * When the payment method was created
131
+ * The time of the event in ISO 8601 UTC format with millisecond precision
118
132
  */
119
133
  created_at: string;
120
134
  /**
121
- * The type of the payment method
135
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
136
+ * cashapp, ideal, sepa_debit).
122
137
  */
123
138
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
124
139
  /**
@@ -126,47 +141,56 @@ export declare namespace PaymentMethodRetrieveResponse {
126
141
  */
127
142
  typename: 'UsBankAccountPaymentMethod';
128
143
  /**
129
- * The bank details associated with this payment method
144
+ * The bank account-specific details for this payment method, including bank name
145
+ * and last four digits.
130
146
  */
131
147
  us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
132
148
  }
133
149
  namespace UsBankAccountPaymentMethod {
134
150
  /**
135
- * The bank details associated with this payment method
151
+ * The bank account-specific details for this payment method, including bank name
152
+ * and last four digits.
136
153
  */
137
154
  interface UsBankAccount {
138
155
  /**
139
- * The type of account
156
+ * The type of bank account (e.g., checking, savings).
140
157
  */
141
158
  account_type: string;
142
159
  /**
143
- * The name of the bank
160
+ * The name of the financial institution holding the account.
144
161
  */
145
162
  bank_name: string;
146
163
  /**
147
- * The last 4 digits of the account number
164
+ * The last four digits of the bank account number.
148
165
  */
149
166
  last4: string;
150
167
  }
151
168
  }
152
169
  /**
153
- * The Cash App details for the payment method
170
+ * A saved Cash App payment method, including the buyer's cashtag and unique
171
+ * identifier.
154
172
  */
155
173
  interface CashappPaymentMethod {
156
174
  /**
157
- * The ID of the payment method
175
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
176
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
177
+ * as a String; however, it is not intended to be human-readable. When expected as
178
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
179
+ * input value will be accepted as an ID.
158
180
  */
159
181
  id: string;
160
182
  /**
161
- * The Cash App details associated with this payment method
183
+ * The Cash App-specific details for this payment method, including cashtag and
184
+ * buyer ID.
162
185
  */
163
186
  cashapp: CashappPaymentMethod.Cashapp;
164
187
  /**
165
- * When the payment method was created
188
+ * The time of the event in ISO 8601 UTC format with millisecond precision
166
189
  */
167
190
  created_at: string;
168
191
  /**
169
- * The type of the payment method
192
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
193
+ * cashapp, ideal, sepa_debit).
170
194
  */
171
195
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
172
196
  /**
@@ -176,37 +200,44 @@ export declare namespace PaymentMethodRetrieveResponse {
176
200
  }
177
201
  namespace CashappPaymentMethod {
178
202
  /**
179
- * The Cash App details associated with this payment method
203
+ * The Cash App-specific details for this payment method, including cashtag and
204
+ * buyer ID.
180
205
  */
181
206
  interface Cashapp {
182
207
  /**
183
- * A unique and immutable identifier assigned by Cash App to every buyer.
208
+ * The unique and immutable identifier assigned by Cash App to the buyer. Null if
209
+ * not available.
184
210
  */
185
211
  buyer_id: string | null;
186
212
  /**
187
- * A public identifier for buyers using Cash App.
213
+ * The public cashtag handle of the buyer on Cash App. Null if not available.
188
214
  */
189
215
  cashtag: string | null;
190
216
  }
191
217
  }
192
218
  /**
193
- * The iDEAL details for the payment method
219
+ * A saved iDEAL payment method, including the customer's bank name and BIC code.
194
220
  */
195
221
  interface IdealPaymentMethod {
196
222
  /**
197
- * The ID of the payment method
223
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
224
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
225
+ * as a String; however, it is not intended to be human-readable. When expected as
226
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
227
+ * input value will be accepted as an ID.
198
228
  */
199
229
  id: string;
200
230
  /**
201
- * When the payment method was created
231
+ * The time of the event in ISO 8601 UTC format with millisecond precision
202
232
  */
203
233
  created_at: string;
204
234
  /**
205
- * The iDEAL details associated with this payment method
235
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
206
236
  */
207
237
  ideal: IdealPaymentMethod.Ideal;
208
238
  /**
209
- * The type of the payment method
239
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
240
+ * cashapp, ideal, sepa_debit).
210
241
  */
211
242
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
212
243
  /**
@@ -216,37 +247,46 @@ export declare namespace PaymentMethodRetrieveResponse {
216
247
  }
217
248
  namespace IdealPaymentMethod {
218
249
  /**
219
- * The iDEAL details associated with this payment method
250
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
220
251
  */
221
252
  interface Ideal {
222
253
  /**
223
- * The customer's bank.
254
+ * The name of the customer's bank used for the iDEAL transaction. Null if not
255
+ * available.
224
256
  */
225
257
  bank: string | null;
226
258
  /**
227
- * The Bank Identifier Code of the customer's bank.
259
+ * The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not
260
+ * available.
228
261
  */
229
262
  bic: string | null;
230
263
  }
231
264
  }
232
265
  /**
233
- * The SEPA Direct Debit details for the payment method
266
+ * A saved SEPA Direct Debit payment method, including the bank code, country, and
267
+ * last four IBAN digits.
234
268
  */
235
269
  interface SepaDebitPaymentMethod {
236
270
  /**
237
- * The ID of the payment method
271
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
272
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
273
+ * as a String; however, it is not intended to be human-readable. When expected as
274
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
275
+ * input value will be accepted as an ID.
238
276
  */
239
277
  id: string;
240
278
  /**
241
- * When the payment method was created
279
+ * The time of the event in ISO 8601 UTC format with millisecond precision
242
280
  */
243
281
  created_at: string;
244
282
  /**
245
- * The type of the payment method
283
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
284
+ * cashapp, ideal, sepa_debit).
246
285
  */
247
286
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
248
287
  /**
249
- * The SEPA Direct Debit details associated with this payment method
288
+ * The SEPA Direct Debit-specific details for this payment method, including bank
289
+ * code and last four IBAN digits.
250
290
  */
251
291
  sepa_debit: SepaDebitPaymentMethod.SepaDebit;
252
292
  /**
@@ -256,47 +296,57 @@ export declare namespace PaymentMethodRetrieveResponse {
256
296
  }
257
297
  namespace SepaDebitPaymentMethod {
258
298
  /**
259
- * The SEPA Direct Debit details associated with this payment method
299
+ * The SEPA Direct Debit-specific details for this payment method, including bank
300
+ * code and last four IBAN digits.
260
301
  */
261
302
  interface SepaDebit {
262
303
  /**
263
- * Bank code of the bank associated with the account.
304
+ * The bank code of the financial institution associated with this SEPA account.
305
+ * Null if not available.
264
306
  */
265
307
  bank_code: string | null;
266
308
  /**
267
- * Branch code of the bank associated with the account.
309
+ * The branch code of the financial institution associated with this SEPA account.
310
+ * Null if not available.
268
311
  */
269
312
  branch_code: string | null;
270
313
  /**
271
- * Two-letter ISO code representing the country the bank account is located in.
314
+ * The two-letter ISO country code where the bank account is located. Null if not
315
+ * available.
272
316
  */
273
317
  country: string | null;
274
318
  /**
275
- * Last four digits of the IBAN.
319
+ * The last four digits of the IBAN associated with this SEPA account. Null if not
320
+ * available.
276
321
  */
277
322
  last4: string | null;
278
323
  }
279
324
  }
280
325
  }
281
326
  /**
282
- * A payment method with no additional properties
327
+ * A saved payment method with no type-specific details available.
283
328
  */
284
329
  export type PaymentMethodListResponse = PaymentMethodListResponse.BasePaymentMethod | PaymentMethodListResponse.CardPaymentMethod | PaymentMethodListResponse.UsBankAccountPaymentMethod | PaymentMethodListResponse.CashappPaymentMethod | PaymentMethodListResponse.IdealPaymentMethod | PaymentMethodListResponse.SepaDebitPaymentMethod;
285
330
  export declare namespace PaymentMethodListResponse {
286
331
  /**
287
- * A payment method with no additional properties
332
+ * A saved payment method with no type-specific details available.
288
333
  */
289
334
  interface BasePaymentMethod {
290
335
  /**
291
- * The ID of the payment method
336
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
337
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
338
+ * as a String; however, it is not intended to be human-readable. When expected as
339
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
340
+ * input value will be accepted as an ID.
292
341
  */
293
342
  id: string;
294
343
  /**
295
- * When the payment method was created
344
+ * The time of the event in ISO 8601 UTC format with millisecond precision
296
345
  */
297
346
  created_at: string;
298
347
  /**
299
- * The type of the payment method
348
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
349
+ * cashapp, ideal, sepa_debit).
300
350
  */
301
351
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
302
352
  /**
@@ -305,23 +355,30 @@ export declare namespace PaymentMethodListResponse {
305
355
  typename: 'BasePaymentMethod';
306
356
  }
307
357
  /**
308
- * The card for the payment method
358
+ * A saved card payment method, including brand, last four digits, and expiration
359
+ * details.
309
360
  */
310
361
  interface CardPaymentMethod {
311
362
  /**
312
- * The ID of the payment method
363
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
364
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
365
+ * as a String; however, it is not intended to be human-readable. When expected as
366
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
367
+ * input value will be accepted as an ID.
313
368
  */
314
369
  id: string;
315
370
  /**
316
- * The card details associated with this payment method
371
+ * The card-specific details for this payment method, including brand, last four
372
+ * digits, and expiration.
317
373
  */
318
374
  card: CardPaymentMethod.Card;
319
375
  /**
320
- * When the payment method was created
376
+ * The time of the event in ISO 8601 UTC format with millisecond precision
321
377
  */
322
378
  created_at: string;
323
379
  /**
324
- * The type of the payment method
380
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
381
+ * cashapp, ideal, sepa_debit).
325
382
  */
326
383
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
327
384
  /**
@@ -331,7 +388,8 @@ export declare namespace PaymentMethodListResponse {
331
388
  }
332
389
  namespace CardPaymentMethod {
333
390
  /**
334
- * The card details associated with this payment method
391
+ * The card-specific details for this payment method, including brand, last four
392
+ * digits, and expiration.
335
393
  */
336
394
  interface Card {
337
395
  /**
@@ -339,33 +397,40 @@ export declare namespace PaymentMethodListResponse {
339
397
  */
340
398
  brand: PaymentsAPI.CardBrands | null;
341
399
  /**
342
- * Card expiration month, like 03 for March.
400
+ * The two-digit expiration month of the card (1-12). Null if not available.
343
401
  */
344
402
  exp_month: number | null;
345
403
  /**
346
- * Card expiration year, like 27 for 2027.
404
+ * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
405
+ * available.
347
406
  */
348
407
  exp_year: number | null;
349
408
  /**
350
- * Last four digits of the card.
409
+ * The last four digits of the card number. Null if not available.
351
410
  */
352
411
  last4: string | null;
353
412
  }
354
413
  }
355
414
  /**
356
- * The bank account for the payment method
415
+ * A saved US bank account payment method, including bank name, last four digits,
416
+ * and account type.
357
417
  */
358
418
  interface UsBankAccountPaymentMethod {
359
419
  /**
360
- * The ID of the payment method
420
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
421
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
422
+ * as a String; however, it is not intended to be human-readable. When expected as
423
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
424
+ * input value will be accepted as an ID.
361
425
  */
362
426
  id: string;
363
427
  /**
364
- * When the payment method was created
428
+ * The time of the event in ISO 8601 UTC format with millisecond precision
365
429
  */
366
430
  created_at: string;
367
431
  /**
368
- * The type of the payment method
432
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
433
+ * cashapp, ideal, sepa_debit).
369
434
  */
370
435
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
371
436
  /**
@@ -373,47 +438,56 @@ export declare namespace PaymentMethodListResponse {
373
438
  */
374
439
  typename: 'UsBankAccountPaymentMethod';
375
440
  /**
376
- * The bank details associated with this payment method
441
+ * The bank account-specific details for this payment method, including bank name
442
+ * and last four digits.
377
443
  */
378
444
  us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
379
445
  }
380
446
  namespace UsBankAccountPaymentMethod {
381
447
  /**
382
- * The bank details associated with this payment method
448
+ * The bank account-specific details for this payment method, including bank name
449
+ * and last four digits.
383
450
  */
384
451
  interface UsBankAccount {
385
452
  /**
386
- * The type of account
453
+ * The type of bank account (e.g., checking, savings).
387
454
  */
388
455
  account_type: string;
389
456
  /**
390
- * The name of the bank
457
+ * The name of the financial institution holding the account.
391
458
  */
392
459
  bank_name: string;
393
460
  /**
394
- * The last 4 digits of the account number
461
+ * The last four digits of the bank account number.
395
462
  */
396
463
  last4: string;
397
464
  }
398
465
  }
399
466
  /**
400
- * The Cash App details for the payment method
467
+ * A saved Cash App payment method, including the buyer's cashtag and unique
468
+ * identifier.
401
469
  */
402
470
  interface CashappPaymentMethod {
403
471
  /**
404
- * The ID of the payment method
472
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
473
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
474
+ * as a String; however, it is not intended to be human-readable. When expected as
475
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
476
+ * input value will be accepted as an ID.
405
477
  */
406
478
  id: string;
407
479
  /**
408
- * The Cash App details associated with this payment method
480
+ * The Cash App-specific details for this payment method, including cashtag and
481
+ * buyer ID.
409
482
  */
410
483
  cashapp: CashappPaymentMethod.Cashapp;
411
484
  /**
412
- * When the payment method was created
485
+ * The time of the event in ISO 8601 UTC format with millisecond precision
413
486
  */
414
487
  created_at: string;
415
488
  /**
416
- * The type of the payment method
489
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
490
+ * cashapp, ideal, sepa_debit).
417
491
  */
418
492
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
419
493
  /**
@@ -423,37 +497,44 @@ export declare namespace PaymentMethodListResponse {
423
497
  }
424
498
  namespace CashappPaymentMethod {
425
499
  /**
426
- * The Cash App details associated with this payment method
500
+ * The Cash App-specific details for this payment method, including cashtag and
501
+ * buyer ID.
427
502
  */
428
503
  interface Cashapp {
429
504
  /**
430
- * A unique and immutable identifier assigned by Cash App to every buyer.
505
+ * The unique and immutable identifier assigned by Cash App to the buyer. Null if
506
+ * not available.
431
507
  */
432
508
  buyer_id: string | null;
433
509
  /**
434
- * A public identifier for buyers using Cash App.
510
+ * The public cashtag handle of the buyer on Cash App. Null if not available.
435
511
  */
436
512
  cashtag: string | null;
437
513
  }
438
514
  }
439
515
  /**
440
- * The iDEAL details for the payment method
516
+ * A saved iDEAL payment method, including the customer's bank name and BIC code.
441
517
  */
442
518
  interface IdealPaymentMethod {
443
519
  /**
444
- * The ID of the payment method
520
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
521
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
522
+ * as a String; however, it is not intended to be human-readable. When expected as
523
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
524
+ * input value will be accepted as an ID.
445
525
  */
446
526
  id: string;
447
527
  /**
448
- * When the payment method was created
528
+ * The time of the event in ISO 8601 UTC format with millisecond precision
449
529
  */
450
530
  created_at: string;
451
531
  /**
452
- * The iDEAL details associated with this payment method
532
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
453
533
  */
454
534
  ideal: IdealPaymentMethod.Ideal;
455
535
  /**
456
- * The type of the payment method
536
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
537
+ * cashapp, ideal, sepa_debit).
457
538
  */
458
539
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
459
540
  /**
@@ -463,37 +544,46 @@ export declare namespace PaymentMethodListResponse {
463
544
  }
464
545
  namespace IdealPaymentMethod {
465
546
  /**
466
- * The iDEAL details associated with this payment method
547
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
467
548
  */
468
549
  interface Ideal {
469
550
  /**
470
- * The customer's bank.
551
+ * The name of the customer's bank used for the iDEAL transaction. Null if not
552
+ * available.
471
553
  */
472
554
  bank: string | null;
473
555
  /**
474
- * The Bank Identifier Code of the customer's bank.
556
+ * The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not
557
+ * available.
475
558
  */
476
559
  bic: string | null;
477
560
  }
478
561
  }
479
562
  /**
480
- * The SEPA Direct Debit details for the payment method
563
+ * A saved SEPA Direct Debit payment method, including the bank code, country, and
564
+ * last four IBAN digits.
481
565
  */
482
566
  interface SepaDebitPaymentMethod {
483
567
  /**
484
- * The ID of the payment method
568
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
569
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
570
+ * as a String; however, it is not intended to be human-readable. When expected as
571
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
572
+ * input value will be accepted as an ID.
485
573
  */
486
574
  id: string;
487
575
  /**
488
- * When the payment method was created
576
+ * The time of the event in ISO 8601 UTC format with millisecond precision
489
577
  */
490
578
  created_at: string;
491
579
  /**
492
- * The type of the payment method
580
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
581
+ * cashapp, ideal, sepa_debit).
493
582
  */
494
583
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
495
584
  /**
496
- * The SEPA Direct Debit details associated with this payment method
585
+ * The SEPA Direct Debit-specific details for this payment method, including bank
586
+ * code and last four IBAN digits.
497
587
  */
498
588
  sepa_debit: SepaDebitPaymentMethod.SepaDebit;
499
589
  /**
@@ -503,23 +593,28 @@ export declare namespace PaymentMethodListResponse {
503
593
  }
504
594
  namespace SepaDebitPaymentMethod {
505
595
  /**
506
- * The SEPA Direct Debit details associated with this payment method
596
+ * The SEPA Direct Debit-specific details for this payment method, including bank
597
+ * code and last four IBAN digits.
507
598
  */
508
599
  interface SepaDebit {
509
600
  /**
510
- * Bank code of the bank associated with the account.
601
+ * The bank code of the financial institution associated with this SEPA account.
602
+ * Null if not available.
511
603
  */
512
604
  bank_code: string | null;
513
605
  /**
514
- * Branch code of the bank associated with the account.
606
+ * The branch code of the financial institution associated with this SEPA account.
607
+ * Null if not available.
515
608
  */
516
609
  branch_code: string | null;
517
610
  /**
518
- * Two-letter ISO code representing the country the bank account is located in.
611
+ * The two-letter ISO country code where the bank account is located. Null if not
612
+ * available.
519
613
  */
520
614
  country: string | null;
521
615
  /**
522
- * Last four digits of the IBAN.
616
+ * The last four digits of the IBAN associated with this SEPA account. Null if not
617
+ * available.
523
618
  */
524
619
  last4: string | null;
525
620
  }
@@ -527,11 +622,13 @@ export declare namespace PaymentMethodListResponse {
527
622
  }
528
623
  export interface PaymentMethodRetrieveParams {
529
624
  /**
530
- * The ID of the Company. Provide either this or member_id (not both).
625
+ * The unique identifier of the company. Provide either this or member_id, not
626
+ * both.
531
627
  */
532
628
  company_id?: string | null;
533
629
  /**
534
- * The ID of the Member. Provide either this or company_id (not both).
630
+ * The unique identifier of the member. Provide either this or company_id, not
631
+ * both.
535
632
  */
536
633
  member_id?: string | null;
537
634
  }
@@ -541,15 +638,16 @@ export interface PaymentMethodListParams extends CursorPageParams {
541
638
  */
542
639
  before?: string | null;
543
640
  /**
544
- * The ID of the Company. Provide either this or member_id (not both).
641
+ * The unique identifier of the company. Provide either this or member_id, not
642
+ * both.
545
643
  */
546
644
  company_id?: string | null;
547
645
  /**
548
- * The minimum creation date to filter by
646
+ * Only return payment methods created after this timestamp.
549
647
  */
550
648
  created_after?: string | null;
551
649
  /**
552
- * The maximum creation date to filter by
650
+ * Only return payment methods created before this timestamp.
553
651
  */
554
652
  created_before?: string | null;
555
653
  /**
@@ -565,7 +663,7 @@ export interface PaymentMethodListParams extends CursorPageParams {
565
663
  */
566
664
  last?: number | null;
567
665
  /**
568
- * The ID of the Member to list payment methods for
666
+ * The unique identifier of the member to list payment methods for.
569
667
  */
570
668
  member_id?: string | null;
571
669
  }