@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
@@ -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 PayoutMethods extends APIResource {
7
7
  /**
8
- * Retrieves a payout method by ID
8
+ * Retrieves the details of an existing payout method.
9
9
  *
10
10
  * Required permissions:
11
11
  *
@@ -13,7 +13,8 @@ export declare class PayoutMethods extends APIResource {
13
13
  */
14
14
  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse>;
15
15
  /**
16
- * Lists payout destinations for a company
16
+ * Returns a list of active payout methods configured for a company, ordered by
17
+ * most recently created.
17
18
  *
18
19
  * Required permissions:
19
20
  *
@@ -27,7 +28,8 @@ export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListRes
27
28
  */
28
29
  export type PayoutDestinationCategory = 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
29
30
  /**
30
- * An object representing an user's setup payout destination.
31
+ * A configured payout destination where a user receives earned funds, such as a
32
+ * bank account or digital wallet.
31
33
  */
32
34
  export interface PayoutMethodRetrieveResponse {
33
35
  /**
@@ -35,12 +37,13 @@ export interface PayoutMethodRetrieveResponse {
35
37
  */
36
38
  id: string;
37
39
  /**
38
- * A reference to identify the payout destination, such as the last 4 digits of an
39
- * account number or an email address.
40
+ * A masked identifier for the payout destination, such as the last four digits of
41
+ * a bank account or an email address. Null if no reference is available.
40
42
  */
41
43
  account_reference: string | null;
42
44
  /**
43
- * The company associated with the payout token
45
+ * The company associated with this payout destination. Null if not linked to a
46
+ * specific company.
44
47
  */
45
48
  company: PayoutMethodRetrieveResponse.Company | null;
46
49
  /**
@@ -48,31 +51,35 @@ export interface PayoutMethodRetrieveResponse {
48
51
  */
49
52
  created_at: string;
50
53
  /**
51
- * The currency code of the payout destination. This is the currency that payouts
52
- * will be made in for this token.
54
+ * The three-letter ISO currency code that payouts are delivered in for this
55
+ * destination.
53
56
  */
54
57
  currency: string;
55
58
  /**
56
- * The payout destination associated with the payout token
59
+ * The payout destination configuration linked to this token. Null if not yet
60
+ * configured.
57
61
  */
58
62
  destination: PayoutMethodRetrieveResponse.Destination | null;
59
63
  /**
60
- * The name of the bank or financial institution.
64
+ * The name of the bank or financial institution receiving payouts. Null if not
65
+ * applicable or not provided.
61
66
  */
62
67
  institution_name: string | null;
63
68
  /**
64
- * Whether this payout token is the default for the payout account
69
+ * Whether this is the default payout destination for the associated payout
70
+ * account.
65
71
  */
66
72
  is_default: boolean;
67
73
  /**
68
- * An optional nickname for the payout token to help the user identify it. This is
69
- * not used by the provider and is only for the user's reference.
74
+ * A user-defined label to help identify this payout destination. Not sent to the
75
+ * provider. Null if no nickname has been set.
70
76
  */
71
77
  nickname: string | null;
72
78
  }
73
79
  export declare namespace PayoutMethodRetrieveResponse {
74
80
  /**
75
- * The company associated with the payout token
81
+ * The company associated with this payout destination. Null if not linked to a
82
+ * specific company.
76
83
  */
77
84
  interface Company {
78
85
  /**
@@ -81,7 +88,8 @@ export declare namespace PayoutMethodRetrieveResponse {
81
88
  id: string;
82
89
  }
83
90
  /**
84
- * The payout destination associated with the payout token
91
+ * The payout destination configuration linked to this token. Null if not yet
92
+ * configured.
85
93
  */
86
94
  interface Destination {
87
95
  /**
@@ -99,7 +107,8 @@ export declare namespace PayoutMethodRetrieveResponse {
99
107
  }
100
108
  }
101
109
  /**
102
- * An object representing an user's setup payout destination.
110
+ * A configured payout destination where a user receives earned funds, such as a
111
+ * bank account or digital wallet.
103
112
  */
104
113
  export interface PayoutMethodListResponse {
105
114
  /**
@@ -107,12 +116,13 @@ export interface PayoutMethodListResponse {
107
116
  */
108
117
  id: string;
109
118
  /**
110
- * A reference to identify the payout destination, such as the last 4 digits of an
111
- * account number or an email address.
119
+ * A masked identifier for the payout destination, such as the last four digits of
120
+ * a bank account or an email address. Null if no reference is available.
112
121
  */
113
122
  account_reference: string | null;
114
123
  /**
115
- * The company associated with the payout token
124
+ * The company associated with this payout destination. Null if not linked to a
125
+ * specific company.
116
126
  */
117
127
  company: PayoutMethodListResponse.Company | null;
118
128
  /**
@@ -120,31 +130,35 @@ export interface PayoutMethodListResponse {
120
130
  */
121
131
  created_at: string;
122
132
  /**
123
- * The currency code of the payout destination. This is the currency that payouts
124
- * will be made in for this token.
133
+ * The three-letter ISO currency code that payouts are delivered in for this
134
+ * destination.
125
135
  */
126
136
  currency: string;
127
137
  /**
128
- * The payout destination associated with the payout token
138
+ * The payout destination configuration linked to this token. Null if not yet
139
+ * configured.
129
140
  */
130
141
  destination: PayoutMethodListResponse.Destination | null;
131
142
  /**
132
- * The name of the bank or financial institution.
143
+ * The name of the bank or financial institution receiving payouts. Null if not
144
+ * applicable or not provided.
133
145
  */
134
146
  institution_name: string | null;
135
147
  /**
136
- * Whether this payout token is the default for the payout account
148
+ * Whether this is the default payout destination for the associated payout
149
+ * account.
137
150
  */
138
151
  is_default: boolean;
139
152
  /**
140
- * An optional nickname for the payout token to help the user identify it. This is
141
- * not used by the provider and is only for the user's reference.
153
+ * A user-defined label to help identify this payout destination. Not sent to the
154
+ * provider. Null if no nickname has been set.
142
155
  */
143
156
  nickname: string | null;
144
157
  }
145
158
  export declare namespace PayoutMethodListResponse {
146
159
  /**
147
- * The company associated with the payout token
160
+ * The company associated with this payout destination. Null if not linked to a
161
+ * specific company.
148
162
  */
149
163
  interface Company {
150
164
  /**
@@ -153,7 +167,8 @@ export declare namespace PayoutMethodListResponse {
153
167
  id: string;
154
168
  }
155
169
  /**
156
- * The payout destination associated with the payout token
170
+ * The payout destination configuration linked to this token. Null if not yet
171
+ * configured.
157
172
  */
158
173
  interface Destination {
159
174
  /**
@@ -172,7 +187,7 @@ export declare namespace PayoutMethodListResponse {
172
187
  }
173
188
  export interface PayoutMethodListParams extends CursorPageParams {
174
189
  /**
175
- * The company ID to list payout methods for.
190
+ * The unique identifier of the company to list payout methods for.
176
191
  */
177
192
  company_id: string;
178
193
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"payout-methods.d.mts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
1
+ {"version":3,"file":"payout-methods.d.mts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
5
5
  import { RequestOptions } from "../internal/request-options.js";
6
6
  export declare class PayoutMethods extends APIResource {
7
7
  /**
8
- * Retrieves a payout method by ID
8
+ * Retrieves the details of an existing payout method.
9
9
  *
10
10
  * Required permissions:
11
11
  *
@@ -13,7 +13,8 @@ export declare class PayoutMethods extends APIResource {
13
13
  */
14
14
  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse>;
15
15
  /**
16
- * Lists payout destinations for a company
16
+ * Returns a list of active payout methods configured for a company, ordered by
17
+ * most recently created.
17
18
  *
18
19
  * Required permissions:
19
20
  *
@@ -27,7 +28,8 @@ export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListRes
27
28
  */
28
29
  export type PayoutDestinationCategory = 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
29
30
  /**
30
- * An object representing an user's setup payout destination.
31
+ * A configured payout destination where a user receives earned funds, such as a
32
+ * bank account or digital wallet.
31
33
  */
32
34
  export interface PayoutMethodRetrieveResponse {
33
35
  /**
@@ -35,12 +37,13 @@ export interface PayoutMethodRetrieveResponse {
35
37
  */
36
38
  id: string;
37
39
  /**
38
- * A reference to identify the payout destination, such as the last 4 digits of an
39
- * account number or an email address.
40
+ * A masked identifier for the payout destination, such as the last four digits of
41
+ * a bank account or an email address. Null if no reference is available.
40
42
  */
41
43
  account_reference: string | null;
42
44
  /**
43
- * The company associated with the payout token
45
+ * The company associated with this payout destination. Null if not linked to a
46
+ * specific company.
44
47
  */
45
48
  company: PayoutMethodRetrieveResponse.Company | null;
46
49
  /**
@@ -48,31 +51,35 @@ export interface PayoutMethodRetrieveResponse {
48
51
  */
49
52
  created_at: string;
50
53
  /**
51
- * The currency code of the payout destination. This is the currency that payouts
52
- * will be made in for this token.
54
+ * The three-letter ISO currency code that payouts are delivered in for this
55
+ * destination.
53
56
  */
54
57
  currency: string;
55
58
  /**
56
- * The payout destination associated with the payout token
59
+ * The payout destination configuration linked to this token. Null if not yet
60
+ * configured.
57
61
  */
58
62
  destination: PayoutMethodRetrieveResponse.Destination | null;
59
63
  /**
60
- * The name of the bank or financial institution.
64
+ * The name of the bank or financial institution receiving payouts. Null if not
65
+ * applicable or not provided.
61
66
  */
62
67
  institution_name: string | null;
63
68
  /**
64
- * Whether this payout token is the default for the payout account
69
+ * Whether this is the default payout destination for the associated payout
70
+ * account.
65
71
  */
66
72
  is_default: boolean;
67
73
  /**
68
- * An optional nickname for the payout token to help the user identify it. This is
69
- * not used by the provider and is only for the user's reference.
74
+ * A user-defined label to help identify this payout destination. Not sent to the
75
+ * provider. Null if no nickname has been set.
70
76
  */
71
77
  nickname: string | null;
72
78
  }
73
79
  export declare namespace PayoutMethodRetrieveResponse {
74
80
  /**
75
- * The company associated with the payout token
81
+ * The company associated with this payout destination. Null if not linked to a
82
+ * specific company.
76
83
  */
77
84
  interface Company {
78
85
  /**
@@ -81,7 +88,8 @@ export declare namespace PayoutMethodRetrieveResponse {
81
88
  id: string;
82
89
  }
83
90
  /**
84
- * The payout destination associated with the payout token
91
+ * The payout destination configuration linked to this token. Null if not yet
92
+ * configured.
85
93
  */
86
94
  interface Destination {
87
95
  /**
@@ -99,7 +107,8 @@ export declare namespace PayoutMethodRetrieveResponse {
99
107
  }
100
108
  }
101
109
  /**
102
- * An object representing an user's setup payout destination.
110
+ * A configured payout destination where a user receives earned funds, such as a
111
+ * bank account or digital wallet.
103
112
  */
104
113
  export interface PayoutMethodListResponse {
105
114
  /**
@@ -107,12 +116,13 @@ export interface PayoutMethodListResponse {
107
116
  */
108
117
  id: string;
109
118
  /**
110
- * A reference to identify the payout destination, such as the last 4 digits of an
111
- * account number or an email address.
119
+ * A masked identifier for the payout destination, such as the last four digits of
120
+ * a bank account or an email address. Null if no reference is available.
112
121
  */
113
122
  account_reference: string | null;
114
123
  /**
115
- * The company associated with the payout token
124
+ * The company associated with this payout destination. Null if not linked to a
125
+ * specific company.
116
126
  */
117
127
  company: PayoutMethodListResponse.Company | null;
118
128
  /**
@@ -120,31 +130,35 @@ export interface PayoutMethodListResponse {
120
130
  */
121
131
  created_at: string;
122
132
  /**
123
- * The currency code of the payout destination. This is the currency that payouts
124
- * will be made in for this token.
133
+ * The three-letter ISO currency code that payouts are delivered in for this
134
+ * destination.
125
135
  */
126
136
  currency: string;
127
137
  /**
128
- * The payout destination associated with the payout token
138
+ * The payout destination configuration linked to this token. Null if not yet
139
+ * configured.
129
140
  */
130
141
  destination: PayoutMethodListResponse.Destination | null;
131
142
  /**
132
- * The name of the bank or financial institution.
143
+ * The name of the bank or financial institution receiving payouts. Null if not
144
+ * applicable or not provided.
133
145
  */
134
146
  institution_name: string | null;
135
147
  /**
136
- * Whether this payout token is the default for the payout account
148
+ * Whether this is the default payout destination for the associated payout
149
+ * account.
137
150
  */
138
151
  is_default: boolean;
139
152
  /**
140
- * An optional nickname for the payout token to help the user identify it. This is
141
- * not used by the provider and is only for the user's reference.
153
+ * A user-defined label to help identify this payout destination. Not sent to the
154
+ * provider. Null if no nickname has been set.
142
155
  */
143
156
  nickname: string | null;
144
157
  }
145
158
  export declare namespace PayoutMethodListResponse {
146
159
  /**
147
- * The company associated with the payout token
160
+ * The company associated with this payout destination. Null if not linked to a
161
+ * specific company.
148
162
  */
149
163
  interface Company {
150
164
  /**
@@ -153,7 +167,8 @@ export declare namespace PayoutMethodListResponse {
153
167
  id: string;
154
168
  }
155
169
  /**
156
- * The payout destination associated with the payout token
170
+ * The payout destination configuration linked to this token. Null if not yet
171
+ * configured.
157
172
  */
158
173
  interface Destination {
159
174
  /**
@@ -172,7 +187,7 @@ export declare namespace PayoutMethodListResponse {
172
187
  }
173
188
  export interface PayoutMethodListParams extends CursorPageParams {
174
189
  /**
175
- * The company ID to list payout methods for.
190
+ * The unique identifier of the company to list payout methods for.
176
191
  */
177
192
  company_id: string;
178
193
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"payout-methods.d.ts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
1
+ {"version":3,"file":"payout-methods.d.ts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
7
7
  const path_1 = require("../internal/utils/path.js");
8
8
  class PayoutMethods extends resource_1.APIResource {
9
9
  /**
10
- * Retrieves a payout method by ID
10
+ * Retrieves the details of an existing payout method.
11
11
  *
12
12
  * Required permissions:
13
13
  *
@@ -17,7 +17,8 @@ class PayoutMethods extends resource_1.APIResource {
17
17
  return this._client.get((0, path_1.path) `/payout_methods/${id}`, options);
18
18
  }
19
19
  /**
20
- * Lists payout destinations for a company
20
+ * Returns a list of active payout methods configured for a company, ordered by
21
+ * most recently created.
21
22
  *
22
23
  * Required permissions:
23
24
  *
@@ -1 +1 @@
1
- {"version":3,"file":"payout-methods.js","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,uBAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,sCA4BC"}
1
+ {"version":3,"file":"payout-methods.js","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,uBAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,sCA6BC"}
@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
4
4
  import { path } from "../internal/utils/path.mjs";
5
5
  export class PayoutMethods extends APIResource {
6
6
  /**
7
- * Retrieves a payout method by ID
7
+ * Retrieves the details of an existing payout method.
8
8
  *
9
9
  * Required permissions:
10
10
  *
@@ -14,7 +14,8 @@ export class PayoutMethods extends APIResource {
14
14
  return this._client.get(path `/payout_methods/${id}`, options);
15
15
  }
16
16
  /**
17
- * Lists payout destinations for a company
17
+ * Returns a list of active payout methods configured for a company, ordered by
18
+ * most recently created.
18
19
  *
19
20
  * Required permissions:
20
21
  *
@@ -1 +1 @@
1
- {"version":3,"file":"payout-methods.mjs","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,UAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"payout-methods.mjs","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,UAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}