@whop/sdk 0.0.26 → 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 (463) hide show
  1. package/CHANGELOG.md +78 -0
  2. package/client.d.mts +10 -9
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +10 -9
  5. package/client.d.ts.map +1 -1
  6. package/client.js +16 -2
  7. package/client.js.map +1 -1
  8. package/client.mjs +16 -2
  9. package/client.mjs.map +1 -1
  10. package/package.json +3 -3
  11. package/resources/access-tokens.d.mts +34 -54
  12. package/resources/access-tokens.d.mts.map +1 -1
  13. package/resources/access-tokens.d.ts +34 -54
  14. package/resources/access-tokens.d.ts.map +1 -1
  15. package/resources/access-tokens.js +6 -8
  16. package/resources/access-tokens.js.map +1 -1
  17. package/resources/access-tokens.mjs +6 -8
  18. package/resources/access-tokens.mjs.map +1 -1
  19. package/resources/account-links.d.mts +15 -13
  20. package/resources/account-links.d.mts.map +1 -1
  21. package/resources/account-links.d.ts +15 -13
  22. package/resources/account-links.d.ts.map +1 -1
  23. package/resources/account-links.js +2 -3
  24. package/resources/account-links.js.map +1 -1
  25. package/resources/account-links.mjs +2 -3
  26. package/resources/account-links.mjs.map +1 -1
  27. package/resources/ai-chats.d.mts +70 -30
  28. package/resources/ai-chats.d.mts.map +1 -1
  29. package/resources/ai-chats.d.ts +70 -30
  30. package/resources/ai-chats.d.ts.map +1 -1
  31. package/resources/ai-chats.js +6 -6
  32. package/resources/ai-chats.js.map +1 -1
  33. package/resources/ai-chats.mjs +6 -6
  34. package/resources/ai-chats.mjs.map +1 -1
  35. package/resources/app-builds.d.mts +37 -35
  36. package/resources/app-builds.d.mts.map +1 -1
  37. package/resources/app-builds.d.ts +37 -35
  38. package/resources/app-builds.d.ts.map +1 -1
  39. package/resources/app-builds.js +7 -4
  40. package/resources/app-builds.js.map +1 -1
  41. package/resources/app-builds.mjs +7 -4
  42. package/resources/app-builds.mjs.map +1 -1
  43. package/resources/apps.d.mts +86 -60
  44. package/resources/apps.d.mts.map +1 -1
  45. package/resources/apps.d.ts +86 -60
  46. package/resources/apps.d.ts.map +1 -1
  47. package/resources/apps.js +7 -4
  48. package/resources/apps.js.map +1 -1
  49. package/resources/apps.mjs +7 -4
  50. package/resources/apps.mjs.map +1 -1
  51. package/resources/authorized-users.d.mts +38 -32
  52. package/resources/authorized-users.d.mts.map +1 -1
  53. package/resources/authorized-users.d.ts +38 -32
  54. package/resources/authorized-users.d.ts.map +1 -1
  55. package/resources/authorized-users.js +3 -2
  56. package/resources/authorized-users.js.map +1 -1
  57. package/resources/authorized-users.mjs +3 -2
  58. package/resources/authorized-users.mjs.map +1 -1
  59. package/resources/chat-channels.d.mts +28 -20
  60. package/resources/chat-channels.d.mts.map +1 -1
  61. package/resources/chat-channels.d.ts +28 -20
  62. package/resources/chat-channels.d.ts.map +1 -1
  63. package/resources/chat-channels.js +5 -3
  64. package/resources/chat-channels.js.map +1 -1
  65. package/resources/chat-channels.mjs +5 -3
  66. package/resources/chat-channels.mjs.map +1 -1
  67. package/resources/checkout-configurations.d.mts +75 -58
  68. package/resources/checkout-configurations.d.mts.map +1 -1
  69. package/resources/checkout-configurations.d.ts +75 -58
  70. package/resources/checkout-configurations.d.ts.map +1 -1
  71. package/resources/checkout-configurations.js +3 -2
  72. package/resources/checkout-configurations.js.map +1 -1
  73. package/resources/checkout-configurations.mjs +3 -2
  74. package/resources/checkout-configurations.mjs.map +1 -1
  75. package/resources/companies.d.mts +88 -56
  76. package/resources/companies.d.mts.map +1 -1
  77. package/resources/companies.d.ts +88 -56
  78. package/resources/companies.d.ts.map +1 -1
  79. package/resources/companies.js +9 -7
  80. package/resources/companies.js.map +1 -1
  81. package/resources/companies.mjs +9 -7
  82. package/resources/companies.mjs.map +1 -1
  83. package/resources/company-token-transactions.d.mts +90 -67
  84. package/resources/company-token-transactions.d.mts.map +1 -1
  85. package/resources/company-token-transactions.d.ts +90 -67
  86. package/resources/company-token-transactions.d.ts.map +1 -1
  87. package/resources/company-token-transactions.js +6 -3
  88. package/resources/company-token-transactions.js.map +1 -1
  89. package/resources/company-token-transactions.mjs +6 -3
  90. package/resources/company-token-transactions.mjs.map +1 -1
  91. package/resources/course-chapters.d.mts +27 -22
  92. package/resources/course-chapters.d.mts.map +1 -1
  93. package/resources/course-chapters.d.ts +27 -22
  94. package/resources/course-chapters.d.ts.map +1 -1
  95. package/resources/course-chapters.js +5 -5
  96. package/resources/course-chapters.mjs +5 -5
  97. package/resources/course-lesson-interactions.d.mts +7 -6
  98. package/resources/course-lesson-interactions.d.mts.map +1 -1
  99. package/resources/course-lesson-interactions.d.ts +7 -6
  100. package/resources/course-lesson-interactions.d.ts.map +1 -1
  101. package/resources/course-lesson-interactions.js +3 -2
  102. package/resources/course-lesson-interactions.js.map +1 -1
  103. package/resources/course-lesson-interactions.mjs +3 -2
  104. package/resources/course-lesson-interactions.mjs.map +1 -1
  105. package/resources/course-lessons.d.mts +141 -99
  106. package/resources/course-lessons.d.mts.map +1 -1
  107. package/resources/course-lessons.d.ts +141 -99
  108. package/resources/course-lessons.d.ts.map +1 -1
  109. package/resources/course-lessons.js +12 -8
  110. package/resources/course-lessons.js.map +1 -1
  111. package/resources/course-lessons.mjs +12 -8
  112. package/resources/course-lessons.mjs.map +1 -1
  113. package/resources/course-students.d.mts +44 -35
  114. package/resources/course-students.d.mts.map +1 -1
  115. package/resources/course-students.d.ts +44 -35
  116. package/resources/course-students.d.ts.map +1 -1
  117. package/resources/course-students.js +3 -2
  118. package/resources/course-students.js.map +1 -1
  119. package/resources/course-students.mjs +3 -2
  120. package/resources/course-students.mjs.map +1 -1
  121. package/resources/courses.d.mts +140 -99
  122. package/resources/courses.d.mts.map +1 -1
  123. package/resources/courses.d.ts +140 -99
  124. package/resources/courses.d.ts.map +1 -1
  125. package/resources/courses.js +9 -5
  126. package/resources/courses.js.map +1 -1
  127. package/resources/courses.mjs +9 -5
  128. package/resources/courses.mjs.map +1 -1
  129. package/resources/disputes.d.mts +176 -120
  130. package/resources/disputes.d.mts.map +1 -1
  131. package/resources/disputes.d.ts +176 -120
  132. package/resources/disputes.d.ts.map +1 -1
  133. package/resources/disputes.js +4 -2
  134. package/resources/disputes.js.map +1 -1
  135. package/resources/disputes.mjs +4 -2
  136. package/resources/disputes.mjs.map +1 -1
  137. package/resources/dm-channels.d.mts +29 -16
  138. package/resources/dm-channels.d.mts.map +1 -1
  139. package/resources/dm-channels.d.ts +29 -16
  140. package/resources/dm-channels.d.ts.map +1 -1
  141. package/resources/dm-channels.js +9 -5
  142. package/resources/dm-channels.js.map +1 -1
  143. package/resources/dm-channels.mjs +9 -5
  144. package/resources/dm-channels.mjs.map +1 -1
  145. package/resources/dm-members.d.mts +30 -21
  146. package/resources/dm-members.d.mts.map +1 -1
  147. package/resources/dm-members.d.ts +30 -21
  148. package/resources/dm-members.d.ts.map +1 -1
  149. package/resources/dm-members.js +9 -5
  150. package/resources/dm-members.js.map +1 -1
  151. package/resources/dm-members.mjs +9 -5
  152. package/resources/dm-members.mjs.map +1 -1
  153. package/resources/entries.d.mts +35 -27
  154. package/resources/entries.d.mts.map +1 -1
  155. package/resources/entries.d.ts +35 -27
  156. package/resources/entries.d.ts.map +1 -1
  157. package/resources/entries.js +7 -4
  158. package/resources/entries.js.map +1 -1
  159. package/resources/entries.mjs +7 -4
  160. package/resources/entries.mjs.map +1 -1
  161. package/resources/experiences.d.mts +58 -49
  162. package/resources/experiences.d.mts.map +1 -1
  163. package/resources/experiences.d.ts +58 -49
  164. package/resources/experiences.d.ts.map +1 -1
  165. package/resources/experiences.js +6 -5
  166. package/resources/experiences.js.map +1 -1
  167. package/resources/experiences.mjs +6 -5
  168. package/resources/experiences.mjs.map +1 -1
  169. package/resources/fee-markups.d.mts +38 -27
  170. package/resources/fee-markups.d.mts.map +1 -1
  171. package/resources/fee-markups.d.ts +38 -27
  172. package/resources/fee-markups.d.ts.map +1 -1
  173. package/resources/fee-markups.js +6 -3
  174. package/resources/fee-markups.js.map +1 -1
  175. package/resources/fee-markups.mjs +6 -3
  176. package/resources/fee-markups.mjs.map +1 -1
  177. package/resources/files.d.mts +23 -19
  178. package/resources/files.d.mts.map +1 -1
  179. package/resources/files.d.ts +23 -19
  180. package/resources/files.d.ts.map +1 -1
  181. package/resources/files.js +3 -2
  182. package/resources/files.js.map +1 -1
  183. package/resources/files.mjs +3 -2
  184. package/resources/files.mjs.map +1 -1
  185. package/resources/forum-posts.d.mts +68 -45
  186. package/resources/forum-posts.d.mts.map +1 -1
  187. package/resources/forum-posts.d.ts +68 -45
  188. package/resources/forum-posts.d.ts.map +1 -1
  189. package/resources/forum-posts.js +8 -4
  190. package/resources/forum-posts.js.map +1 -1
  191. package/resources/forum-posts.mjs +8 -4
  192. package/resources/forum-posts.mjs.map +1 -1
  193. package/resources/forums.d.mts +21 -13
  194. package/resources/forums.d.mts.map +1 -1
  195. package/resources/forums.d.ts +21 -13
  196. package/resources/forums.d.ts.map +1 -1
  197. package/resources/forums.js +5 -3
  198. package/resources/forums.js.map +1 -1
  199. package/resources/forums.mjs +5 -3
  200. package/resources/forums.mjs.map +1 -1
  201. package/resources/index.d.mts +3 -3
  202. package/resources/index.d.mts.map +1 -1
  203. package/resources/index.d.ts +3 -3
  204. package/resources/index.d.ts.map +1 -1
  205. package/resources/index.js.map +1 -1
  206. package/resources/index.mjs.map +1 -1
  207. package/resources/invoices.d.mts +136 -100
  208. package/resources/invoices.d.mts.map +1 -1
  209. package/resources/invoices.d.ts +136 -100
  210. package/resources/invoices.d.ts.map +1 -1
  211. package/resources/invoices.js +7 -4
  212. package/resources/invoices.js.map +1 -1
  213. package/resources/invoices.mjs +7 -4
  214. package/resources/invoices.mjs.map +1 -1
  215. package/resources/leads.d.mts +76 -54
  216. package/resources/leads.d.mts.map +1 -1
  217. package/resources/leads.d.ts +76 -54
  218. package/resources/leads.d.ts.map +1 -1
  219. package/resources/leads.js +6 -4
  220. package/resources/leads.js.map +1 -1
  221. package/resources/leads.mjs +6 -4
  222. package/resources/leads.mjs.map +1 -1
  223. package/resources/ledger-accounts.d.mts +19 -15
  224. package/resources/ledger-accounts.d.mts.map +1 -1
  225. package/resources/ledger-accounts.d.ts +19 -15
  226. package/resources/ledger-accounts.d.ts.map +1 -1
  227. package/resources/ledger-accounts.js +1 -1
  228. package/resources/ledger-accounts.mjs +1 -1
  229. package/resources/members.d.mts +27 -28
  230. package/resources/members.d.mts.map +1 -1
  231. package/resources/members.d.ts +27 -28
  232. package/resources/members.d.ts.map +1 -1
  233. package/resources/members.js +3 -2
  234. package/resources/members.js.map +1 -1
  235. package/resources/members.mjs +3 -2
  236. package/resources/members.mjs.map +1 -1
  237. package/resources/memberships.d.mts +85 -62
  238. package/resources/memberships.d.mts.map +1 -1
  239. package/resources/memberships.d.ts +85 -62
  240. package/resources/memberships.d.ts.map +1 -1
  241. package/resources/memberships.js +12 -8
  242. package/resources/memberships.js.map +1 -1
  243. package/resources/memberships.mjs +12 -8
  244. package/resources/memberships.mjs.map +1 -1
  245. package/resources/messages.d.mts +53 -35
  246. package/resources/messages.d.mts.map +1 -1
  247. package/resources/messages.d.ts +53 -35
  248. package/resources/messages.d.ts.map +1 -1
  249. package/resources/messages.js +9 -5
  250. package/resources/messages.js.map +1 -1
  251. package/resources/messages.mjs +9 -5
  252. package/resources/messages.mjs.map +1 -1
  253. package/resources/notifications.d.mts +33 -25
  254. package/resources/notifications.d.mts.map +1 -1
  255. package/resources/notifications.d.ts +33 -25
  256. package/resources/notifications.d.ts.map +1 -1
  257. package/resources/notifications.js +2 -1
  258. package/resources/notifications.js.map +1 -1
  259. package/resources/notifications.mjs +2 -1
  260. package/resources/notifications.mjs.map +1 -1
  261. package/resources/payment-methods.d.mts +212 -114
  262. package/resources/payment-methods.d.mts.map +1 -1
  263. package/resources/payment-methods.d.ts +212 -114
  264. package/resources/payment-methods.d.ts.map +1 -1
  265. package/resources/payment-methods.js +5 -10
  266. package/resources/payment-methods.js.map +1 -1
  267. package/resources/payment-methods.mjs +5 -10
  268. package/resources/payment-methods.mjs.map +1 -1
  269. package/resources/payments.d.mts +96 -56
  270. package/resources/payments.d.mts.map +1 -1
  271. package/resources/payments.d.ts +96 -56
  272. package/resources/payments.d.ts.map +1 -1
  273. package/resources/payments.js +23 -10
  274. package/resources/payments.js.map +1 -1
  275. package/resources/payments.mjs +23 -10
  276. package/resources/payments.mjs.map +1 -1
  277. package/resources/payout-methods.d.mts +50 -35
  278. package/resources/payout-methods.d.mts.map +1 -1
  279. package/resources/payout-methods.d.ts +50 -35
  280. package/resources/payout-methods.d.ts.map +1 -1
  281. package/resources/payout-methods.js +3 -2
  282. package/resources/payout-methods.js.map +1 -1
  283. package/resources/payout-methods.mjs +3 -2
  284. package/resources/payout-methods.mjs.map +1 -1
  285. package/resources/plans.d.mts +136 -95
  286. package/resources/plans.d.mts.map +1 -1
  287. package/resources/plans.d.ts +136 -95
  288. package/resources/plans.d.ts.map +1 -1
  289. package/resources/plans.js +9 -5
  290. package/resources/plans.js.map +1 -1
  291. package/resources/plans.mjs +9 -5
  292. package/resources/plans.mjs.map +1 -1
  293. package/resources/products.d.mts +80 -67
  294. package/resources/products.d.mts.map +1 -1
  295. package/resources/products.d.ts +80 -67
  296. package/resources/products.d.ts.map +1 -1
  297. package/resources/products.js +7 -5
  298. package/resources/products.js.map +1 -1
  299. package/resources/products.mjs +7 -5
  300. package/resources/products.mjs.map +1 -1
  301. package/resources/promo-codes.d.mts +60 -40
  302. package/resources/promo-codes.d.mts.map +1 -1
  303. package/resources/promo-codes.d.ts +60 -40
  304. package/resources/promo-codes.d.ts.map +1 -1
  305. package/resources/promo-codes.js +7 -4
  306. package/resources/promo-codes.js.map +1 -1
  307. package/resources/promo-codes.mjs +7 -4
  308. package/resources/promo-codes.mjs.map +1 -1
  309. package/resources/reactions.d.mts +25 -19
  310. package/resources/reactions.d.mts.map +1 -1
  311. package/resources/reactions.d.ts +25 -19
  312. package/resources/reactions.d.ts.map +1 -1
  313. package/resources/reactions.js +7 -4
  314. package/resources/reactions.js.map +1 -1
  315. package/resources/reactions.mjs +7 -4
  316. package/resources/reactions.mjs.map +1 -1
  317. package/resources/refunds.d.mts +57 -39
  318. package/resources/refunds.d.mts.map +1 -1
  319. package/resources/refunds.d.ts +57 -39
  320. package/resources/refunds.d.ts.map +1 -1
  321. package/resources/refunds.js +3 -2
  322. package/resources/refunds.js.map +1 -1
  323. package/resources/refunds.mjs +3 -2
  324. package/resources/refunds.mjs.map +1 -1
  325. package/resources/reviews.d.mts +76 -60
  326. package/resources/reviews.d.mts.map +1 -1
  327. package/resources/reviews.d.ts +76 -60
  328. package/resources/reviews.d.ts.map +1 -1
  329. package/resources/reviews.js +3 -2
  330. package/resources/reviews.js.map +1 -1
  331. package/resources/reviews.mjs +3 -2
  332. package/resources/reviews.mjs.map +1 -1
  333. package/resources/setup-intents.d.mts +77 -61
  334. package/resources/setup-intents.d.mts.map +1 -1
  335. package/resources/setup-intents.d.ts +77 -61
  336. package/resources/setup-intents.d.ts.map +1 -1
  337. package/resources/setup-intents.js +4 -10
  338. package/resources/setup-intents.js.map +1 -1
  339. package/resources/setup-intents.mjs +4 -10
  340. package/resources/setup-intents.mjs.map +1 -1
  341. package/resources/shared.d.mts +854 -509
  342. package/resources/shared.d.mts.map +1 -1
  343. package/resources/shared.d.ts +854 -509
  344. package/resources/shared.d.ts.map +1 -1
  345. package/resources/shipments.d.mts +30 -21
  346. package/resources/shipments.d.mts.map +1 -1
  347. package/resources/shipments.d.ts +30 -21
  348. package/resources/shipments.d.ts.map +1 -1
  349. package/resources/shipments.js +5 -3
  350. package/resources/shipments.js.map +1 -1
  351. package/resources/shipments.mjs +5 -3
  352. package/resources/shipments.mjs.map +1 -1
  353. package/resources/support-channels.d.mts +28 -20
  354. package/resources/support-channels.d.mts.map +1 -1
  355. package/resources/support-channels.d.ts +28 -20
  356. package/resources/support-channels.d.ts.map +1 -1
  357. package/resources/support-channels.js +5 -4
  358. package/resources/support-channels.js.map +1 -1
  359. package/resources/support-channels.mjs +5 -4
  360. package/resources/support-channels.mjs.map +1 -1
  361. package/resources/topups.d.mts +13 -9
  362. package/resources/topups.d.mts.map +1 -1
  363. package/resources/topups.d.ts +13 -9
  364. package/resources/topups.d.ts.map +1 -1
  365. package/resources/topups.js +2 -1
  366. package/resources/topups.js.map +1 -1
  367. package/resources/topups.mjs +2 -1
  368. package/resources/topups.mjs.map +1 -1
  369. package/resources/transfers.d.mts +37 -28
  370. package/resources/transfers.d.mts.map +1 -1
  371. package/resources/transfers.d.ts +37 -28
  372. package/resources/transfers.d.ts.map +1 -1
  373. package/resources/transfers.js +5 -3
  374. package/resources/transfers.js.map +1 -1
  375. package/resources/transfers.mjs +5 -3
  376. package/resources/transfers.mjs.map +1 -1
  377. package/resources/users.d.mts +60 -18
  378. package/resources/users.d.mts.map +1 -1
  379. package/resources/users.d.ts +60 -18
  380. package/resources/users.d.ts.map +1 -1
  381. package/resources/users.js +13 -2
  382. package/resources/users.js.map +1 -1
  383. package/resources/users.mjs +13 -2
  384. package/resources/users.mjs.map +1 -1
  385. package/resources/verifications.d.mts +7 -5
  386. package/resources/verifications.d.mts.map +1 -1
  387. package/resources/verifications.d.ts +7 -5
  388. package/resources/verifications.d.ts.map +1 -1
  389. package/resources/verifications.js +1 -1
  390. package/resources/verifications.mjs +1 -1
  391. package/resources/webhooks.d.mts +188 -133
  392. package/resources/webhooks.d.mts.map +1 -1
  393. package/resources/webhooks.d.ts +188 -133
  394. package/resources/webhooks.d.ts.map +1 -1
  395. package/resources/webhooks.js +3 -2
  396. package/resources/webhooks.js.map +1 -1
  397. package/resources/webhooks.mjs +3 -2
  398. package/resources/webhooks.mjs.map +1 -1
  399. package/resources/withdrawals.d.mts +60 -47
  400. package/resources/withdrawals.d.mts.map +1 -1
  401. package/resources/withdrawals.d.ts +60 -47
  402. package/resources/withdrawals.d.ts.map +1 -1
  403. package/resources/withdrawals.js +3 -2
  404. package/resources/withdrawals.js.map +1 -1
  405. package/resources/withdrawals.mjs +3 -2
  406. package/resources/withdrawals.mjs.map +1 -1
  407. package/src/client.ts +33 -11
  408. package/src/resources/access-tokens.ts +37 -59
  409. package/src/resources/account-links.ts +15 -13
  410. package/src/resources/ai-chats.ts +76 -30
  411. package/src/resources/app-builds.ts +37 -35
  412. package/src/resources/apps.ts +89 -60
  413. package/src/resources/authorized-users.ts +38 -32
  414. package/src/resources/chat-channels.ts +28 -20
  415. package/src/resources/checkout-configurations.ts +76 -58
  416. package/src/resources/companies.ts +94 -57
  417. package/src/resources/company-token-transactions.ts +91 -68
  418. package/src/resources/course-chapters.ts +27 -22
  419. package/src/resources/course-lesson-interactions.ts +7 -6
  420. package/src/resources/course-lessons.ts +141 -99
  421. package/src/resources/course-students.ts +44 -35
  422. package/src/resources/courses.ts +140 -99
  423. package/src/resources/disputes.ts +176 -120
  424. package/src/resources/dm-channels.ts +29 -16
  425. package/src/resources/dm-members.ts +30 -21
  426. package/src/resources/entries.ts +35 -27
  427. package/src/resources/experiences.ts +58 -49
  428. package/src/resources/fee-markups.ts +38 -27
  429. package/src/resources/files.ts +23 -19
  430. package/src/resources/forum-posts.ts +69 -45
  431. package/src/resources/forums.ts +21 -13
  432. package/src/resources/index.ts +4 -2
  433. package/src/resources/invoices.ts +140 -100
  434. package/src/resources/leads.ts +76 -54
  435. package/src/resources/ledger-accounts.ts +19 -15
  436. package/src/resources/members.ts +27 -28
  437. package/src/resources/memberships.ts +86 -62
  438. package/src/resources/messages.ts +53 -35
  439. package/src/resources/notifications.ts +33 -25
  440. package/src/resources/payment-methods.ts +212 -114
  441. package/src/resources/payments.ts +103 -55
  442. package/src/resources/payout-methods.ts +50 -35
  443. package/src/resources/plans.ts +136 -95
  444. package/src/resources/products.ts +219 -70
  445. package/src/resources/promo-codes.ts +60 -40
  446. package/src/resources/reactions.ts +25 -19
  447. package/src/resources/refunds.ts +59 -39
  448. package/src/resources/reviews.ts +76 -60
  449. package/src/resources/setup-intents.ts +77 -61
  450. package/src/resources/shared.ts +2797 -508
  451. package/src/resources/shipments.ts +30 -21
  452. package/src/resources/support-channels.ts +28 -20
  453. package/src/resources/topups.ts +13 -9
  454. package/src/resources/transfers.ts +37 -28
  455. package/src/resources/users.ts +72 -18
  456. package/src/resources/verifications.ts +7 -5
  457. package/src/resources/webhooks.ts +188 -133
  458. package/src/resources/withdrawals.ts +60 -46
  459. package/src/version.ts +1 -1
  460. package/version.d.mts +1 -1
  461. package/version.d.ts +1 -1
  462. package/version.js +1 -1
  463. package/version.mjs +1 -1
@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
4
4
  import { RequestOptions } from "../internal/request-options.mjs";
5
5
  export declare class DmMembers extends APIResource {
6
6
  /**
7
- * Adds a user to a DM channel
7
+ * Add a new user to an existing DM channel. Only an admin of the channel can add
8
+ * members.
8
9
  *
9
10
  * Required permissions:
10
11
  *
@@ -20,7 +21,7 @@ export declare class DmMembers extends APIResource {
20
21
  */
21
22
  create(body: DmMemberCreateParams, options?: RequestOptions): APIPromise<DmMember>;
22
23
  /**
23
- * Retrieves a DM channel member
24
+ * Retrieves the details of an existing DM member.
24
25
  *
25
26
  * Required permissions:
26
27
  *
@@ -33,7 +34,8 @@ export declare class DmMembers extends APIResource {
33
34
  */
34
35
  retrieve(id: string, options?: RequestOptions): APIPromise<DmMember>;
35
36
  /**
36
- * Updates a DM channel member's settings
37
+ * Update a DM channel member's settings, such as their notification preferences or
38
+ * membership status.
37
39
  *
38
40
  * Required permissions:
39
41
  *
@@ -46,7 +48,8 @@ export declare class DmMembers extends APIResource {
46
48
  */
47
49
  update(id: string, body?: DmMemberUpdateParams | null | undefined, options?: RequestOptions): APIPromise<DmMember>;
48
50
  /**
49
- * Lists members of a DM channel
51
+ * Returns a paginated list of members in a specific DM channel, sorted by the date
52
+ * they were added.
50
53
  *
51
54
  * Required permissions:
52
55
  *
@@ -64,7 +67,8 @@ export declare class DmMembers extends APIResource {
64
67
  */
65
68
  list(query: DmMemberListParams, options?: RequestOptions): PagePromise<DmMemberListResponsesCursorPage, DmMemberListResponse>;
66
69
  /**
67
- * Removes a user from a DM channel
70
+ * Remove a user from a DM channel. An admin can remove any member, and a member
71
+ * can remove themselves.
68
72
  *
69
73
  * Required permissions:
70
74
  *
@@ -87,7 +91,8 @@ export type DmFeedMemberNotificationPreferences = 'all' | 'mentions' | 'none';
87
91
  */
88
92
  export type DmFeedMemberStatuses = 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
89
93
  /**
90
- * Represents a member of a DM channel
94
+ * A user's membership record in a messaging channel, including notification
95
+ * preferences and read state.
91
96
  */
92
97
  export interface DmMember {
93
98
  /**
@@ -95,29 +100,31 @@ export interface DmMember {
95
100
  */
96
101
  id: string;
97
102
  /**
98
- * The ID of the DM channel
103
+ * The unique identifier of the messaging channel this membership belongs to.
99
104
  */
100
105
  channel_id: string;
101
106
  /**
102
- * Timestamp when the member last viewed the channel (in milliseconds since Unix
103
- * epoch)
107
+ * The timestamp when this member last viewed the channel, as a Unix timestamp in
108
+ * milliseconds. Null if the member has never viewed the channel.
104
109
  */
105
110
  last_viewed_at: string | null;
106
111
  /**
107
- * The notification preference for this member (all, mentions, none)
112
+ * The notification level for this channel: all, mentions, or none.
108
113
  */
109
114
  notification_preference: DmFeedMemberNotificationPreferences;
110
115
  /**
111
- * The status of the membership (requested, accepted, rejected)
116
+ * The current state of this membership: requested, accepted, hidden, closed, or
117
+ * archived.
112
118
  */
113
119
  status: DmFeedMemberStatuses;
114
120
  /**
115
- * The ID of the user who is a member of the channel
121
+ * The unique identifier of the user who holds this channel membership.
116
122
  */
117
123
  user_id: string;
118
124
  }
119
125
  /**
120
- * Represents a member of a DM channel
126
+ * A user's membership record in a messaging channel, including notification
127
+ * preferences and read state.
121
128
  */
122
129
  export interface DmMemberListResponse {
123
130
  /**
@@ -125,20 +132,21 @@ export interface DmMemberListResponse {
125
132
  */
126
133
  id: string;
127
134
  /**
128
- * The ID of the DM channel
135
+ * The unique identifier of the messaging channel this membership belongs to.
129
136
  */
130
137
  channel_id: string;
131
138
  /**
132
- * Timestamp when the member last viewed the channel (in milliseconds since Unix
133
- * epoch)
139
+ * The timestamp when this member last viewed the channel, as a Unix timestamp in
140
+ * milliseconds. Null if the member has never viewed the channel.
134
141
  */
135
142
  last_viewed_at: string | null;
136
143
  /**
137
- * The status of the membership (requested, accepted, rejected)
144
+ * The current state of this membership: requested, accepted, hidden, closed, or
145
+ * archived.
138
146
  */
139
147
  status: DmFeedMemberStatuses;
140
148
  /**
141
- * The ID of the user who is a member of the channel
149
+ * The unique identifier of the user who holds this channel membership.
142
150
  */
143
151
  user_id: string;
144
152
  }
@@ -148,11 +156,12 @@ export interface DmMemberListResponse {
148
156
  export type DmMemberDeleteResponse = boolean;
149
157
  export interface DmMemberCreateParams {
150
158
  /**
151
- * The ID of the DM channel to add the member to
159
+ * The unique identifier of the DM channel to add the new member to.
152
160
  */
153
161
  channel_id: string;
154
162
  /**
155
- * The ID of the user to add to the channel
163
+ * The unique identifier of the user to add to the DM channel. For example,
164
+ * 'user_xxxxx'.
156
165
  */
157
166
  user_id: string;
158
167
  }
@@ -168,7 +177,7 @@ export interface DmMemberUpdateParams {
168
177
  }
169
178
  export interface DmMemberListParams extends CursorPageParams {
170
179
  /**
171
- * The ID of the DM channel to list members for
180
+ * The unique identifier of the DM channel to list members for.
172
181
  */
173
182
  channel_id: string;
174
183
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"dm-members.d.mts","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,kBAAkB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAIrE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjF;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE,mCAAmC,CAAC;IAE7D;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,uBAAuB,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"dm-members.d.mts","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,kBAAkB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAIrE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjF;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/F;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE,mCAAmC,CAAC;IAE7D;;;OAGG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,uBAAuB,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
4
4
  import { RequestOptions } from "../internal/request-options.js";
5
5
  export declare class DmMembers extends APIResource {
6
6
  /**
7
- * Adds a user to a DM channel
7
+ * Add a new user to an existing DM channel. Only an admin of the channel can add
8
+ * members.
8
9
  *
9
10
  * Required permissions:
10
11
  *
@@ -20,7 +21,7 @@ export declare class DmMembers extends APIResource {
20
21
  */
21
22
  create(body: DmMemberCreateParams, options?: RequestOptions): APIPromise<DmMember>;
22
23
  /**
23
- * Retrieves a DM channel member
24
+ * Retrieves the details of an existing DM member.
24
25
  *
25
26
  * Required permissions:
26
27
  *
@@ -33,7 +34,8 @@ export declare class DmMembers extends APIResource {
33
34
  */
34
35
  retrieve(id: string, options?: RequestOptions): APIPromise<DmMember>;
35
36
  /**
36
- * Updates a DM channel member's settings
37
+ * Update a DM channel member's settings, such as their notification preferences or
38
+ * membership status.
37
39
  *
38
40
  * Required permissions:
39
41
  *
@@ -46,7 +48,8 @@ export declare class DmMembers extends APIResource {
46
48
  */
47
49
  update(id: string, body?: DmMemberUpdateParams | null | undefined, options?: RequestOptions): APIPromise<DmMember>;
48
50
  /**
49
- * Lists members of a DM channel
51
+ * Returns a paginated list of members in a specific DM channel, sorted by the date
52
+ * they were added.
50
53
  *
51
54
  * Required permissions:
52
55
  *
@@ -64,7 +67,8 @@ export declare class DmMembers extends APIResource {
64
67
  */
65
68
  list(query: DmMemberListParams, options?: RequestOptions): PagePromise<DmMemberListResponsesCursorPage, DmMemberListResponse>;
66
69
  /**
67
- * Removes a user from a DM channel
70
+ * Remove a user from a DM channel. An admin can remove any member, and a member
71
+ * can remove themselves.
68
72
  *
69
73
  * Required permissions:
70
74
  *
@@ -87,7 +91,8 @@ export type DmFeedMemberNotificationPreferences = 'all' | 'mentions' | 'none';
87
91
  */
88
92
  export type DmFeedMemberStatuses = 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
89
93
  /**
90
- * Represents a member of a DM channel
94
+ * A user's membership record in a messaging channel, including notification
95
+ * preferences and read state.
91
96
  */
92
97
  export interface DmMember {
93
98
  /**
@@ -95,29 +100,31 @@ export interface DmMember {
95
100
  */
96
101
  id: string;
97
102
  /**
98
- * The ID of the DM channel
103
+ * The unique identifier of the messaging channel this membership belongs to.
99
104
  */
100
105
  channel_id: string;
101
106
  /**
102
- * Timestamp when the member last viewed the channel (in milliseconds since Unix
103
- * epoch)
107
+ * The timestamp when this member last viewed the channel, as a Unix timestamp in
108
+ * milliseconds. Null if the member has never viewed the channel.
104
109
  */
105
110
  last_viewed_at: string | null;
106
111
  /**
107
- * The notification preference for this member (all, mentions, none)
112
+ * The notification level for this channel: all, mentions, or none.
108
113
  */
109
114
  notification_preference: DmFeedMemberNotificationPreferences;
110
115
  /**
111
- * The status of the membership (requested, accepted, rejected)
116
+ * The current state of this membership: requested, accepted, hidden, closed, or
117
+ * archived.
112
118
  */
113
119
  status: DmFeedMemberStatuses;
114
120
  /**
115
- * The ID of the user who is a member of the channel
121
+ * The unique identifier of the user who holds this channel membership.
116
122
  */
117
123
  user_id: string;
118
124
  }
119
125
  /**
120
- * Represents a member of a DM channel
126
+ * A user's membership record in a messaging channel, including notification
127
+ * preferences and read state.
121
128
  */
122
129
  export interface DmMemberListResponse {
123
130
  /**
@@ -125,20 +132,21 @@ export interface DmMemberListResponse {
125
132
  */
126
133
  id: string;
127
134
  /**
128
- * The ID of the DM channel
135
+ * The unique identifier of the messaging channel this membership belongs to.
129
136
  */
130
137
  channel_id: string;
131
138
  /**
132
- * Timestamp when the member last viewed the channel (in milliseconds since Unix
133
- * epoch)
139
+ * The timestamp when this member last viewed the channel, as a Unix timestamp in
140
+ * milliseconds. Null if the member has never viewed the channel.
134
141
  */
135
142
  last_viewed_at: string | null;
136
143
  /**
137
- * The status of the membership (requested, accepted, rejected)
144
+ * The current state of this membership: requested, accepted, hidden, closed, or
145
+ * archived.
138
146
  */
139
147
  status: DmFeedMemberStatuses;
140
148
  /**
141
- * The ID of the user who is a member of the channel
149
+ * The unique identifier of the user who holds this channel membership.
142
150
  */
143
151
  user_id: string;
144
152
  }
@@ -148,11 +156,12 @@ export interface DmMemberListResponse {
148
156
  export type DmMemberDeleteResponse = boolean;
149
157
  export interface DmMemberCreateParams {
150
158
  /**
151
- * The ID of the DM channel to add the member to
159
+ * The unique identifier of the DM channel to add the new member to.
152
160
  */
153
161
  channel_id: string;
154
162
  /**
155
- * The ID of the user to add to the channel
163
+ * The unique identifier of the user to add to the DM channel. For example,
164
+ * 'user_xxxxx'.
156
165
  */
157
166
  user_id: string;
158
167
  }
@@ -168,7 +177,7 @@ export interface DmMemberUpdateParams {
168
177
  }
169
178
  export interface DmMemberListParams extends CursorPageParams {
170
179
  /**
171
- * The ID of the DM channel to list members for
180
+ * The unique identifier of the DM channel to list members for.
172
181
  */
173
182
  channel_id: string;
174
183
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"dm-members.d.ts","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,kBAAkB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAIrE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjF;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE,mCAAmC,CAAC;IAE7D;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,uBAAuB,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"dm-members.d.ts","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,kBAAkB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAIrE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjF;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/F;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE,mCAAmC,CAAC;IAE7D;;;OAGG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,uBAAuB,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
7
7
  const path_1 = require("../internal/utils/path.js");
8
8
  class DmMembers extends resource_1.APIResource {
9
9
  /**
10
- * Adds a user to a DM channel
10
+ * Add a new user to an existing DM channel. Only an admin of the channel can add
11
+ * members.
11
12
  *
12
13
  * Required permissions:
13
14
  *
@@ -25,7 +26,7 @@ class DmMembers extends resource_1.APIResource {
25
26
  return this._client.post('/dm_members', { body, ...options });
26
27
  }
27
28
  /**
28
- * Retrieves a DM channel member
29
+ * Retrieves the details of an existing DM member.
29
30
  *
30
31
  * Required permissions:
31
32
  *
@@ -40,7 +41,8 @@ class DmMembers extends resource_1.APIResource {
40
41
  return this._client.get((0, path_1.path) `/dm_members/${id}`, options);
41
42
  }
42
43
  /**
43
- * Updates a DM channel member's settings
44
+ * Update a DM channel member's settings, such as their notification preferences or
45
+ * membership status.
44
46
  *
45
47
  * Required permissions:
46
48
  *
@@ -55,7 +57,8 @@ class DmMembers extends resource_1.APIResource {
55
57
  return this._client.patch((0, path_1.path) `/dm_members/${id}`, { body, ...options });
56
58
  }
57
59
  /**
58
- * Lists members of a DM channel
60
+ * Returns a paginated list of members in a specific DM channel, sorted by the date
61
+ * they were added.
59
62
  *
60
63
  * Required permissions:
61
64
  *
@@ -75,7 +78,8 @@ class DmMembers extends resource_1.APIResource {
75
78
  return this._client.getAPIList('/dm_members', (pagination_1.CursorPage), { query, ...options });
76
79
  }
77
80
  /**
78
- * Removes a user from a DM channel
81
+ * Remove a user from a DM channel. An admin can remove any member, and a member
82
+ * can remove themselves.
79
83
  *
80
84
  * Required permissions:
81
85
  *
@@ -1 +1 @@
1
- {"version":3,"file":"dm-members.js","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AA/FD,8BA+FC"}
1
+ {"version":3,"file":"dm-members.js","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAnGD,8BAmGC"}
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
4
4
  import { path } from "../internal/utils/path.mjs";
5
5
  export class DmMembers extends APIResource {
6
6
  /**
7
- * Adds a user to a DM channel
7
+ * Add a new user to an existing DM channel. Only an admin of the channel can add
8
+ * members.
8
9
  *
9
10
  * Required permissions:
10
11
  *
@@ -22,7 +23,7 @@ export class DmMembers extends APIResource {
22
23
  return this._client.post('/dm_members', { body, ...options });
23
24
  }
24
25
  /**
25
- * Retrieves a DM channel member
26
+ * Retrieves the details of an existing DM member.
26
27
  *
27
28
  * Required permissions:
28
29
  *
@@ -37,7 +38,8 @@ export class DmMembers extends APIResource {
37
38
  return this._client.get(path `/dm_members/${id}`, options);
38
39
  }
39
40
  /**
40
- * Updates a DM channel member's settings
41
+ * Update a DM channel member's settings, such as their notification preferences or
42
+ * membership status.
41
43
  *
42
44
  * Required permissions:
43
45
  *
@@ -52,7 +54,8 @@ export class DmMembers extends APIResource {
52
54
  return this._client.patch(path `/dm_members/${id}`, { body, ...options });
53
55
  }
54
56
  /**
55
- * Lists members of a DM channel
57
+ * Returns a paginated list of members in a specific DM channel, sorted by the date
58
+ * they were added.
56
59
  *
57
60
  * Required permissions:
58
61
  *
@@ -72,7 +75,8 @@ export class DmMembers extends APIResource {
72
75
  return this._client.getAPIList('/dm_members', (CursorPage), { query, ...options });
73
76
  }
74
77
  /**
75
- * Removes a user from a DM channel
78
+ * Remove a user from a DM channel. An admin can remove any member, and a member
79
+ * can remove themselves.
76
80
  *
77
81
  * Required permissions:
78
82
  *
@@ -1 +1 @@
1
- {"version":3,"file":"dm-members.mjs","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
1
+ {"version":3,"file":"dm-members.mjs","sourceRoot":"","sources":["../src/resources/dm-members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
5
5
  import { RequestOptions } from "../internal/request-options.mjs";
6
6
  export declare class Entries extends APIResource {
7
7
  /**
8
- * Retrieves an entry by ID
8
+ * Retrieves the details of an existing waitlist entry.
9
9
  *
10
10
  * Required permissions:
11
11
  *
@@ -14,7 +14,8 @@ export declare class Entries extends APIResource {
14
14
  */
15
15
  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Entry>;
16
16
  /**
17
- * Lists entries for a company
17
+ * Returns a paginated list of waitlist entries for a company, with optional
18
+ * filtering by product, plan, status, and creation date.
18
19
  *
19
20
  * Required permissions:
20
21
  *
@@ -23,7 +24,8 @@ export declare class Entries extends APIResource {
23
24
  */
24
25
  list(query: EntryListParams, options?: RequestOptions): PagePromise<EntryListResponsesCursorPage, EntryListResponse>;
25
26
  /**
26
- * Approve an entry
27
+ * Approve a pending waitlist entry, triggering the checkout process to grant the
28
+ * user access to the plan.
27
29
  *
28
30
  * Required permissions:
29
31
  *
@@ -31,7 +33,8 @@ export declare class Entries extends APIResource {
31
33
  */
32
34
  approve(id: string, options?: RequestOptions): APIPromise<EntryApproveResponse>;
33
35
  /**
34
- * Deny an entry
36
+ * Deny a pending waitlist entry, preventing the user from gaining access to the
37
+ * plan.
35
38
  *
36
39
  * Required permissions:
37
40
  *
@@ -43,75 +46,80 @@ export declare class Entries extends APIResource {
43
46
  }
44
47
  export type EntryListResponsesCursorPage = CursorPage<EntryListResponse>;
45
48
  /**
46
- * An object representing an entry in a waitlist.
49
+ * An entry represents a user's signup for a waitlisted plan.
47
50
  */
48
51
  export interface EntryListResponse {
49
52
  /**
50
- * The internal ID of the entry.
53
+ * The unique identifier for the entry.
51
54
  */
52
55
  id: string;
53
56
  /**
54
- * When the entry was created.
57
+ * The datetime the entry was created.
55
58
  */
56
59
  created_at: string | null;
57
60
  /**
58
- * The waitlist plan the entry if for.
61
+ * The waitlisted plan that this entry is a signup for.
59
62
  */
60
63
  plan: EntryListResponse.Plan | null;
61
64
  /**
62
- * The product tied to this entry, if there is one.
65
+ * The product associated with this entry's waitlisted plan. Null if the plan is
66
+ * not tied to a product.
63
67
  */
64
68
  product: EntryListResponse.Product | null;
65
69
  /**
66
- * The status of the entry.
70
+ * The current status of the waitlist entry (e.g., drafted, pending, approved,
71
+ * denied).
67
72
  */
68
73
  status: Shared.EntryStatus;
69
74
  /**
70
- * The user who created the entry.
75
+ * The user who submitted this waitlist entry.
71
76
  */
72
77
  user: EntryListResponse.User;
73
78
  }
74
79
  export declare namespace EntryListResponse {
75
80
  /**
76
- * The waitlist plan the entry if for.
81
+ * The waitlisted plan that this entry is a signup for.
77
82
  */
78
83
  interface Plan {
79
84
  /**
80
- * The internal ID of the plan.
85
+ * The unique identifier for the plan.
81
86
  */
82
87
  id: string;
83
88
  }
84
89
  /**
85
- * The product tied to this entry, if there is one.
90
+ * The product associated with this entry's waitlisted plan. Null if the plan is
91
+ * not tied to a product.
86
92
  */
87
93
  interface Product {
88
94
  /**
89
- * The internal ID of the public product.
95
+ * The unique identifier for the product.
90
96
  */
91
97
  id: string;
92
98
  /**
93
- * The title of the product. Use for Whop 4.0.
99
+ * The display name of the product shown to customers on the product page and in
100
+ * search results.
94
101
  */
95
102
  title: string;
96
103
  }
97
104
  /**
98
- * The user who created the entry.
105
+ * The user who submitted this waitlist entry.
99
106
  */
100
107
  interface User {
101
108
  /**
102
- * The internal ID of the user.
109
+ * The unique identifier for the user.
103
110
  */
104
111
  id: string;
105
112
  /**
106
- * The email of the user
113
+ * The user's email address. Requires the member:email:read permission to access.
114
+ * Null if not authorized.
107
115
  */
108
116
  email: string | null;
109
117
  /**
110
- * The name of the user from their Whop account.
118
+ * The user's display name shown on their public profile.
111
119
  */
112
120
  name: string | null;
113
121
  /**
114
- * The username of the user from their Whop account.
122
+ * The user's unique username shown on their public profile.
115
123
  */
116
124
  username: string;
117
125
  }
@@ -127,7 +135,7 @@ export interface EntryApproveResponse {
127
135
  }
128
136
  export interface EntryListParams extends CursorPageParams {
129
137
  /**
130
- * The ID of the company
138
+ * The unique identifier of the company to list waitlist entries for.
131
139
  */
132
140
  company_id: string;
133
141
  /**
@@ -135,11 +143,11 @@ export interface EntryListParams extends CursorPageParams {
135
143
  */
136
144
  before?: string | null;
137
145
  /**
138
- * The minimum creation date to filter by
146
+ * Only return entries created after this timestamp.
139
147
  */
140
148
  created_after?: string | null;
141
149
  /**
142
- * The maximum creation date to filter by
150
+ * Only return entries created before this timestamp.
143
151
  */
144
152
  created_before?: string | null;
145
153
  /**
@@ -159,15 +167,15 @@ export interface EntryListParams extends CursorPageParams {
159
167
  */
160
168
  order?: 'id' | 'created_at' | null;
161
169
  /**
162
- * The plan IDs to filter the entries by
170
+ * Filter entries to only those for specific plans.
163
171
  */
164
172
  plan_ids?: Array<string> | null;
165
173
  /**
166
- * The product IDs to filter the entries by
174
+ * Filter entries to only those for specific products.
167
175
  */
168
176
  product_ids?: Array<string> | null;
169
177
  /**
170
- * The statuses to filter the entries by
178
+ * Filter entries by their current status.
171
179
  */
172
180
  statuses?: Array<Shared.EntryStatus> | null;
173
181
  }
@@ -1 +1 @@
1
- {"version":3,"file":"entries.d.mts","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;IAIxE;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,eAAe,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IAI/D;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI/E;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;CAGrE;AAED,MAAM,MAAM,4BAA4B,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;CAC9B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
1
+ {"version":3,"file":"entries.d.mts","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;IAIxE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,eAAe,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IAI/D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI/E;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;CAGrE;AAED,MAAM,MAAM,4BAA4B,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,OAAO,EAAE,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;CAC9B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}