@polar-sh/sdk 0.13.0 → 0.13.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/README.md +15 -0
  2. package/docs/sdks/articles/README.md +78 -0
  3. package/docs/sdks/benefits/README.md +3 -3
  4. package/docs/sdks/checkoutlinks/README.md +400 -0
  5. package/funcs/articlesExport.d.ts +16 -0
  6. package/funcs/articlesExport.d.ts.map +1 -0
  7. package/funcs/articlesExport.js +99 -0
  8. package/funcs/articlesExport.js.map +1 -0
  9. package/funcs/benefitsCreate.d.ts +2 -1
  10. package/funcs/benefitsCreate.d.ts.map +1 -1
  11. package/funcs/benefitsCreate.js +2 -1
  12. package/funcs/benefitsCreate.js.map +1 -1
  13. package/funcs/benefitsGet.d.ts +2 -1
  14. package/funcs/benefitsGet.d.ts.map +1 -1
  15. package/funcs/benefitsGet.js +2 -1
  16. package/funcs/benefitsGet.js.map +1 -1
  17. package/funcs/benefitsUpdate.d.ts +2 -1
  18. package/funcs/benefitsUpdate.d.ts.map +1 -1
  19. package/funcs/benefitsUpdate.js +2 -1
  20. package/funcs/benefitsUpdate.js.map +1 -1
  21. package/funcs/checkoutLinksCreate.d.ts +16 -0
  22. package/funcs/checkoutLinksCreate.d.ts.map +1 -0
  23. package/funcs/checkoutLinksCreate.js +95 -0
  24. package/funcs/checkoutLinksCreate.js.map +1 -0
  25. package/funcs/checkoutLinksDelete.d.ts +16 -0
  26. package/funcs/checkoutLinksDelete.d.ts.map +1 -0
  27. package/funcs/checkoutLinksDelete.js +101 -0
  28. package/funcs/checkoutLinksDelete.js.map +1 -0
  29. package/funcs/checkoutLinksGet.d.ts +17 -0
  30. package/funcs/checkoutLinksGet.d.ts.map +1 -0
  31. package/funcs/checkoutLinksGet.js +101 -0
  32. package/funcs/checkoutLinksGet.js.map +1 -0
  33. package/funcs/checkoutLinksList.d.ts +17 -0
  34. package/funcs/checkoutLinksList.d.ts.map +1 -0
  35. package/funcs/checkoutLinksList.js +130 -0
  36. package/funcs/checkoutLinksList.js.map +1 -0
  37. package/funcs/checkoutLinksUpdate.d.ts +17 -0
  38. package/funcs/checkoutLinksUpdate.d.ts.map +1 -0
  39. package/funcs/checkoutLinksUpdate.js +104 -0
  40. package/funcs/checkoutLinksUpdate.js.map +1 -0
  41. package/lib/config.d.ts +3 -3
  42. package/lib/config.js +3 -3
  43. package/models/components/articlecreate.d.ts +6 -67
  44. package/models/components/articlecreate.d.ts.map +1 -1
  45. package/models/components/articlecreate.js +7 -47
  46. package/models/components/articlecreate.js.map +1 -1
  47. package/models/components/benefit.d.ts +28 -0
  48. package/models/components/benefit.d.ts.map +1 -0
  49. package/models/components/benefit.js +69 -0
  50. package/models/components/benefit.js.map +1 -0
  51. package/models/components/benefitbase.d.ts +0 -3
  52. package/models/components/benefitbase.d.ts.map +1 -1
  53. package/models/components/benefitbase.js.map +1 -1
  54. package/models/components/benefitgrantwebhook.d.ts +3 -28
  55. package/models/components/benefitgrantwebhook.d.ts.map +1 -1
  56. package/models/components/benefitgrantwebhook.js +4 -57
  57. package/models/components/benefitgrantwebhook.js.map +1 -1
  58. package/models/components/benefitinput.d.ts +28 -0
  59. package/models/components/benefitinput.d.ts.map +1 -0
  60. package/models/components/benefitinput.js +69 -0
  61. package/models/components/benefitinput.js.map +1 -0
  62. package/models/components/checkoutlink.d.ts +69 -0
  63. package/models/components/checkoutlink.d.ts.map +1 -0
  64. package/models/components/checkoutlink.js +90 -0
  65. package/models/components/checkoutlink.js.map +1 -0
  66. package/models/components/checkoutlinkcreate.d.ts +85 -0
  67. package/models/components/checkoutlinkcreate.d.ts.map +1 -0
  68. package/models/components/checkoutlinkcreate.js +90 -0
  69. package/models/components/checkoutlinkcreate.js.map +1 -0
  70. package/models/components/checkoutlinksortproperty.d.ts +28 -0
  71. package/models/components/checkoutlinksortproperty.d.ts.map +1 -0
  72. package/models/components/checkoutlinksortproperty.js +50 -0
  73. package/models/components/checkoutlinksortproperty.js.map +1 -0
  74. package/models/components/checkoutlinkupdate.d.ts +46 -0
  75. package/models/components/checkoutlinkupdate.d.ts.map +1 -0
  76. package/models/components/checkoutlinkupdate.js +61 -0
  77. package/models/components/checkoutlinkupdate.js.map +1 -0
  78. package/models/components/checkoutpublic.d.ts +5 -8
  79. package/models/components/checkoutpublic.d.ts.map +1 -1
  80. package/models/components/checkoutpublic.js +2 -2
  81. package/models/components/checkoutpublic.js.map +1 -1
  82. package/models/components/index.d.ts +13 -0
  83. package/models/components/index.d.ts.map +1 -1
  84. package/models/components/index.js +13 -0
  85. package/models/components/index.js.map +1 -1
  86. package/models/components/interval.d.ts +37 -0
  87. package/models/components/interval.d.ts.map +1 -0
  88. package/models/components/interval.js +54 -0
  89. package/models/components/interval.js.map +1 -0
  90. package/models/components/issue.d.ts +0 -6
  91. package/models/components/issue.d.ts.map +1 -1
  92. package/models/components/issue.js.map +1 -1
  93. package/models/components/licensekeyread.d.ts +3 -0
  94. package/models/components/licensekeyread.d.ts.map +1 -1
  95. package/models/components/licensekeyread.js +3 -0
  96. package/models/components/licensekeyread.js.map +1 -1
  97. package/models/components/licensekeyuser.d.ts +31 -0
  98. package/models/components/licensekeyuser.d.ts.map +1 -0
  99. package/models/components/licensekeyuser.js +67 -0
  100. package/models/components/licensekeyuser.js.map +1 -0
  101. package/models/components/licensekeywithactivations.d.ts +3 -0
  102. package/models/components/licensekeywithactivations.d.ts.map +1 -1
  103. package/models/components/licensekeywithactivations.js +3 -0
  104. package/models/components/licensekeywithactivations.js.map +1 -1
  105. package/models/components/listresourcebenefit.d.ts +3 -28
  106. package/models/components/listresourcebenefit.d.ts.map +1 -1
  107. package/models/components/listresourcebenefit.js +4 -57
  108. package/models/components/listresourcebenefit.js.map +1 -1
  109. package/models/components/listresourcecheckoutlink.d.ts +29 -0
  110. package/models/components/listresourcecheckoutlink.d.ts.map +1 -0
  111. package/models/components/listresourcecheckoutlink.js +54 -0
  112. package/models/components/listresourcecheckoutlink.js.map +1 -0
  113. package/models/components/metric.d.ts +0 -3
  114. package/models/components/metric.d.ts.map +1 -1
  115. package/models/components/metric.js.map +1 -1
  116. package/models/components/metricsintervalslimits.d.ts +5 -5
  117. package/models/components/metricslimits.d.ts +1 -1
  118. package/models/components/metricsresponse.d.ts +0 -3
  119. package/models/components/metricsresponse.d.ts.map +1 -1
  120. package/models/components/metricsresponse.js.map +1 -1
  121. package/models/components/oauth2client.js +2 -2
  122. package/models/components/oauth2client.js.map +1 -1
  123. package/models/components/oauth2clientconfiguration.js +2 -2
  124. package/models/components/oauth2clientconfiguration.js.map +1 -1
  125. package/models/components/oauth2clientconfigurationupdate.js +2 -2
  126. package/models/components/oauth2clientconfigurationupdate.js.map +1 -1
  127. package/models/components/order.d.ts +3 -0
  128. package/models/components/order.d.ts.map +1 -1
  129. package/models/components/order.js +5 -0
  130. package/models/components/order.js.map +1 -1
  131. package/models/components/orderbillingreason.d.ts +34 -0
  132. package/models/components/orderbillingreason.d.ts.map +1 -0
  133. package/models/components/orderbillingreason.js +52 -0
  134. package/models/components/orderbillingreason.js.map +1 -0
  135. package/models/components/pledge.d.ts +0 -9
  136. package/models/components/pledge.d.ts.map +1 -1
  137. package/models/components/pledge.js.map +1 -1
  138. package/models/components/polarcheckoutschemascheckout.d.ts +2 -121
  139. package/models/components/polarcheckoutschemascheckout.d.ts.map +1 -1
  140. package/models/components/polarcheckoutschemascheckout.js +3 -108
  141. package/models/components/polarcheckoutschemascheckout.js.map +1 -1
  142. package/models/components/productpriceonetimecustom.d.ts +5 -0
  143. package/models/components/productpriceonetimecustom.d.ts.map +1 -1
  144. package/models/components/productpriceonetimecustom.js +4 -0
  145. package/models/components/productpriceonetimecustom.js.map +1 -1
  146. package/models/components/productpriceonetimefixed.d.ts +5 -0
  147. package/models/components/productpriceonetimefixed.d.ts.map +1 -1
  148. package/models/components/productpriceonetimefixed.js +4 -0
  149. package/models/components/productpriceonetimefixed.js.map +1 -1
  150. package/models/components/productpriceonetimefree.d.ts +5 -0
  151. package/models/components/productpriceonetimefree.d.ts.map +1 -1
  152. package/models/components/productpriceonetimefree.js +4 -0
  153. package/models/components/productpriceonetimefree.js.map +1 -1
  154. package/models/components/productpricerecurringcustom.d.ts +5 -3
  155. package/models/components/productpricerecurringcustom.d.ts.map +1 -1
  156. package/models/components/productpricerecurringcustom.js +4 -0
  157. package/models/components/productpricerecurringcustom.js.map +1 -1
  158. package/models/components/productpricerecurringfixed.d.ts +5 -3
  159. package/models/components/productpricerecurringfixed.d.ts.map +1 -1
  160. package/models/components/productpricerecurringfixed.js +4 -0
  161. package/models/components/productpricerecurringfixed.js.map +1 -1
  162. package/models/components/productpricerecurringfixedcreate.d.ts +0 -3
  163. package/models/components/productpricerecurringfixedcreate.d.ts.map +1 -1
  164. package/models/components/productpricerecurringfixedcreate.js.map +1 -1
  165. package/models/components/productpricerecurringfree.d.ts +5 -3
  166. package/models/components/productpricerecurringfree.d.ts.map +1 -1
  167. package/models/components/productpricerecurringfree.js +4 -0
  168. package/models/components/productpricerecurringfree.js.map +1 -1
  169. package/models/components/productpricerecurringfreecreate.d.ts +0 -3
  170. package/models/components/productpricerecurringfreecreate.d.ts.map +1 -1
  171. package/models/components/productpricerecurringfreecreate.js.map +1 -1
  172. package/models/components/validatedlicensekey.d.ts +3 -0
  173. package/models/components/validatedlicensekey.d.ts.map +1 -1
  174. package/models/components/validatedlicensekey.js +3 -0
  175. package/models/components/validatedlicensekey.js.map +1 -1
  176. package/models/components/webhookbenefitcreatedpayload.d.ts +3 -28
  177. package/models/components/webhookbenefitcreatedpayload.d.ts.map +1 -1
  178. package/models/components/webhookbenefitcreatedpayload.js +4 -57
  179. package/models/components/webhookbenefitcreatedpayload.js.map +1 -1
  180. package/models/components/webhookbenefitupdatedpayload.d.ts +3 -28
  181. package/models/components/webhookbenefitupdatedpayload.d.ts.map +1 -1
  182. package/models/components/webhookbenefitupdatedpayload.js +4 -57
  183. package/models/components/webhookbenefitupdatedpayload.js.map +1 -1
  184. package/models/components/webhookcheckoutcreatedpayload.d.ts +3 -3
  185. package/models/components/webhookcheckoutcreatedpayload.d.ts.map +1 -1
  186. package/models/components/webhookcheckoutcreatedpayload.js +2 -2
  187. package/models/components/webhookcheckoutcreatedpayload.js.map +1 -1
  188. package/models/components/webhookcheckoutupdatedpayload.d.ts +3 -3
  189. package/models/components/webhookcheckoutupdatedpayload.d.ts.map +1 -1
  190. package/models/components/webhookcheckoutupdatedpayload.js +2 -2
  191. package/models/components/webhookcheckoutupdatedpayload.js.map +1 -1
  192. package/models/components/webhooksubscriptionactivepayload.d.ts +59 -0
  193. package/models/components/webhooksubscriptionactivepayload.d.ts.map +1 -0
  194. package/models/components/webhooksubscriptionactivepayload.js +71 -0
  195. package/models/components/webhooksubscriptionactivepayload.js.map +1 -0
  196. package/models/components/webhooksubscriptioncanceledpayload.d.ts +59 -0
  197. package/models/components/webhooksubscriptioncanceledpayload.d.ts.map +1 -0
  198. package/models/components/webhooksubscriptioncanceledpayload.js +71 -0
  199. package/models/components/webhooksubscriptioncanceledpayload.js.map +1 -0
  200. package/models/components/webhooksubscriptionrevokedpayload.d.ts +59 -0
  201. package/models/components/webhooksubscriptionrevokedpayload.d.ts.map +1 -0
  202. package/models/components/webhooksubscriptionrevokedpayload.js +71 -0
  203. package/models/components/webhooksubscriptionrevokedpayload.js.map +1 -0
  204. package/models/components/webhooksubscriptionupdatedpayload.d.ts +6 -2
  205. package/models/components/webhooksubscriptionupdatedpayload.d.ts.map +1 -1
  206. package/models/components/webhooksubscriptionupdatedpayload.js.map +1 -1
  207. package/models/operations/articlesexport.d.ts +25 -0
  208. package/models/operations/articlesexport.d.ts.map +1 -0
  209. package/models/operations/articlesexport.js +59 -0
  210. package/models/operations/articlesexport.js.map +1 -0
  211. package/models/operations/benefitscreate.d.ts +0 -22
  212. package/models/operations/benefitscreate.d.ts.map +1 -1
  213. package/models/operations/benefitscreate.js +1 -32
  214. package/models/operations/benefitscreate.js.map +1 -1
  215. package/models/operations/benefitsget.d.ts +0 -23
  216. package/models/operations/benefitsget.d.ts.map +1 -1
  217. package/models/operations/benefitsget.js +1 -33
  218. package/models/operations/benefitsget.js.map +1 -1
  219. package/models/operations/benefitsupdate.d.ts +0 -22
  220. package/models/operations/benefitsupdate.d.ts.map +1 -1
  221. package/models/operations/benefitsupdate.js +1 -32
  222. package/models/operations/benefitsupdate.js.map +1 -1
  223. package/models/operations/checkoutlinksdelete.d.ts +28 -0
  224. package/models/operations/checkoutlinksdelete.d.ts.map +1 -0
  225. package/models/operations/checkoutlinksdelete.js +50 -0
  226. package/models/operations/checkoutlinksdelete.js.map +1 -0
  227. package/models/operations/checkoutlinksget.d.ts +28 -0
  228. package/models/operations/checkoutlinksget.d.ts.map +1 -0
  229. package/models/operations/checkoutlinksget.js +50 -0
  230. package/models/operations/checkoutlinksget.js.map +1 -0
  231. package/models/operations/checkoutlinkslist.d.ts +116 -0
  232. package/models/operations/checkoutlinkslist.d.ts.map +1 -0
  233. package/models/operations/checkoutlinkslist.js +129 -0
  234. package/models/operations/checkoutlinkslist.js.map +1 -0
  235. package/models/operations/checkoutlinksupdate.d.ts +31 -0
  236. package/models/operations/checkoutlinksupdate.d.ts.map +1 -0
  237. package/models/operations/checkoutlinksupdate.js +62 -0
  238. package/models/operations/checkoutlinksupdate.js.map +1 -0
  239. package/models/operations/index.d.ts +5 -0
  240. package/models/operations/index.d.ts.map +1 -1
  241. package/models/operations/index.js +5 -0
  242. package/models/operations/index.js.map +1 -1
  243. package/models/operations/metricsget.d.ts +1 -42
  244. package/models/operations/metricsget.d.ts.map +1 -1
  245. package/models/operations/metricsget.js +3 -29
  246. package/models/operations/metricsget.js.map +1 -1
  247. package/package.json +1 -1
  248. package/sdk/articles.d.ts +7 -0
  249. package/sdk/articles.d.ts.map +1 -1
  250. package/sdk/articles.js +10 -0
  251. package/sdk/articles.js.map +1 -1
  252. package/sdk/benefits.d.ts +4 -3
  253. package/sdk/benefits.d.ts.map +1 -1
  254. package/sdk/benefits.js.map +1 -1
  255. package/sdk/checkoutlinks.d.ts +42 -0
  256. package/sdk/checkoutlinks.d.ts.map +1 -0
  257. package/sdk/checkoutlinks.js +63 -0
  258. package/sdk/checkoutlinks.js.map +1 -0
  259. package/sdk/sdk.d.ts +3 -0
  260. package/sdk/sdk.d.ts.map +1 -1
  261. package/sdk/sdk.js +5 -0
  262. package/sdk/sdk.js.map +1 -1
  263. package/src/funcs/articlesExport.ts +129 -0
  264. package/src/funcs/benefitsCreate.ts +4 -3
  265. package/src/funcs/benefitsGet.ts +4 -3
  266. package/src/funcs/benefitsUpdate.ts +4 -3
  267. package/src/funcs/checkoutLinksCreate.ts +124 -0
  268. package/src/funcs/checkoutLinksDelete.ts +135 -0
  269. package/src/funcs/checkoutLinksGet.ts +134 -0
  270. package/src/funcs/checkoutLinksList.ts +189 -0
  271. package/src/funcs/checkoutLinksUpdate.ts +138 -0
  272. package/src/lib/config.ts +3 -3
  273. package/src/models/components/articlecreate.ts +18 -77
  274. package/src/models/components/benefit.ts +106 -0
  275. package/src/models/components/benefitbase.ts +0 -3
  276. package/src/models/components/benefitgrantwebhook.ts +9 -137
  277. package/src/models/components/benefitinput.ts +109 -0
  278. package/src/models/components/checkoutlink.ts +131 -0
  279. package/src/models/components/checkoutlinkcreate.ts +127 -0
  280. package/src/models/components/checkoutlinksortproperty.ts +35 -0
  281. package/src/models/components/checkoutlinkupdate.ts +73 -0
  282. package/src/models/components/checkoutpublic.ts +7 -10
  283. package/src/models/components/index.ts +13 -0
  284. package/src/models/components/interval.ts +34 -0
  285. package/src/models/components/issue.ts +0 -6
  286. package/src/models/components/licensekeyread.ts +10 -0
  287. package/src/models/components/licensekeyuser.ts +68 -0
  288. package/src/models/components/licensekeywithactivations.ts +10 -0
  289. package/src/models/components/listresourcebenefit.ts +9 -140
  290. package/src/models/components/listresourcecheckoutlink.ts +61 -0
  291. package/src/models/components/metric.ts +0 -3
  292. package/src/models/components/metricsintervalslimits.ts +5 -5
  293. package/src/models/components/metricslimits.ts +1 -1
  294. package/src/models/components/metricsresponse.ts +0 -3
  295. package/src/models/components/oauth2client.ts +2 -2
  296. package/src/models/components/oauth2clientconfiguration.ts +2 -2
  297. package/src/models/components/oauth2clientconfigurationupdate.ts +2 -2
  298. package/src/models/components/order.ts +11 -0
  299. package/src/models/components/orderbillingreason.ts +35 -0
  300. package/src/models/components/pledge.ts +0 -9
  301. package/src/models/components/polarcheckoutschemascheckout.ts +4 -229
  302. package/src/models/components/productpriceonetimecustom.ts +9 -0
  303. package/src/models/components/productpriceonetimefixed.ts +9 -0
  304. package/src/models/components/productpriceonetimefree.ts +9 -0
  305. package/src/models/components/productpricerecurringcustom.ts +9 -3
  306. package/src/models/components/productpricerecurringfixed.ts +9 -3
  307. package/src/models/components/productpricerecurringfixedcreate.ts +0 -3
  308. package/src/models/components/productpricerecurringfree.ts +9 -3
  309. package/src/models/components/productpricerecurringfreecreate.ts +0 -3
  310. package/src/models/components/validatedlicensekey.ts +10 -0
  311. package/src/models/components/webhookbenefitcreatedpayload.ts +9 -139
  312. package/src/models/components/webhookbenefitupdatedpayload.ts +9 -139
  313. package/src/models/components/webhookcheckoutcreatedpayload.ts +8 -8
  314. package/src/models/components/webhookcheckoutupdatedpayload.ts +8 -8
  315. package/src/models/components/webhooksubscriptionactivepayload.ts +95 -0
  316. package/src/models/components/webhooksubscriptioncanceledpayload.ts +96 -0
  317. package/src/models/components/webhooksubscriptionrevokedpayload.ts +96 -0
  318. package/src/models/components/webhooksubscriptionupdatedpayload.ts +6 -2
  319. package/src/models/operations/articlesexport.ts +54 -0
  320. package/src/models/operations/benefitscreate.ts +0 -67
  321. package/src/models/operations/benefitsget.ts +0 -66
  322. package/src/models/operations/benefitsupdate.ts +0 -67
  323. package/src/models/operations/checkoutlinksdelete.ts +48 -0
  324. package/src/models/operations/checkoutlinksget.ts +48 -0
  325. package/src/models/operations/checkoutlinkslist.ts +224 -0
  326. package/src/models/operations/checkoutlinksupdate.ts +62 -0
  327. package/src/models/operations/index.ts +5 -0
  328. package/src/models/operations/metricsget.ts +3 -38
  329. package/src/sdk/articles.ts +18 -0
  330. package/src/sdk/benefits.ts +4 -3
  331. package/src/sdk/checkoutlinks.ts +101 -0
  332. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,96 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+ import {
8
+ SubscriptionInput,
9
+ SubscriptionInput$inboundSchema,
10
+ SubscriptionInput$Outbound,
11
+ SubscriptionInput$outboundSchema,
12
+ } from "./subscriptioninput.js";
13
+
14
+ export const WebhookSubscriptionRevokedPayloadType = {
15
+ SubscriptionRevoked: "subscription.revoked",
16
+ } as const;
17
+ export type WebhookSubscriptionRevokedPayloadType = ClosedEnum<
18
+ typeof WebhookSubscriptionRevokedPayloadType
19
+ >;
20
+
21
+ /**
22
+ * Sent when a subscription is revoked, the user looses access immediately.
23
+ *
24
+ * @remarks
25
+ * Happens when the subscription is canceled, or payment is past due.
26
+ *
27
+ * **Discord & Slack support:** Full
28
+ */
29
+ export type WebhookSubscriptionRevokedPayload = {
30
+ type?: "subscription.revoked" | undefined;
31
+ data: SubscriptionInput;
32
+ };
33
+
34
+ /** @internal */
35
+ export const WebhookSubscriptionRevokedPayloadType$inboundSchema:
36
+ z.ZodNativeEnum<typeof WebhookSubscriptionRevokedPayloadType> = z.nativeEnum(
37
+ WebhookSubscriptionRevokedPayloadType,
38
+ );
39
+
40
+ /** @internal */
41
+ export const WebhookSubscriptionRevokedPayloadType$outboundSchema:
42
+ z.ZodNativeEnum<typeof WebhookSubscriptionRevokedPayloadType> =
43
+ WebhookSubscriptionRevokedPayloadType$inboundSchema;
44
+
45
+ /**
46
+ * @internal
47
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
48
+ */
49
+ export namespace WebhookSubscriptionRevokedPayloadType$ {
50
+ /** @deprecated use `WebhookSubscriptionRevokedPayloadType$inboundSchema` instead. */
51
+ export const inboundSchema =
52
+ WebhookSubscriptionRevokedPayloadType$inboundSchema;
53
+ /** @deprecated use `WebhookSubscriptionRevokedPayloadType$outboundSchema` instead. */
54
+ export const outboundSchema =
55
+ WebhookSubscriptionRevokedPayloadType$outboundSchema;
56
+ }
57
+
58
+ /** @internal */
59
+ export const WebhookSubscriptionRevokedPayload$inboundSchema: z.ZodType<
60
+ WebhookSubscriptionRevokedPayload,
61
+ z.ZodTypeDef,
62
+ unknown
63
+ > = z.object({
64
+ type: z.literal("subscription.revoked").optional(),
65
+ data: SubscriptionInput$inboundSchema,
66
+ });
67
+
68
+ /** @internal */
69
+ export type WebhookSubscriptionRevokedPayload$Outbound = {
70
+ type: "subscription.revoked";
71
+ data: SubscriptionInput$Outbound;
72
+ };
73
+
74
+ /** @internal */
75
+ export const WebhookSubscriptionRevokedPayload$outboundSchema: z.ZodType<
76
+ WebhookSubscriptionRevokedPayload$Outbound,
77
+ z.ZodTypeDef,
78
+ WebhookSubscriptionRevokedPayload
79
+ > = z.object({
80
+ type: z.literal("subscription.revoked").default("subscription.revoked"),
81
+ data: SubscriptionInput$outboundSchema,
82
+ });
83
+
84
+ /**
85
+ * @internal
86
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
87
+ */
88
+ export namespace WebhookSubscriptionRevokedPayload$ {
89
+ /** @deprecated use `WebhookSubscriptionRevokedPayload$inboundSchema` instead. */
90
+ export const inboundSchema = WebhookSubscriptionRevokedPayload$inboundSchema;
91
+ /** @deprecated use `WebhookSubscriptionRevokedPayload$outboundSchema` instead. */
92
+ export const outboundSchema =
93
+ WebhookSubscriptionRevokedPayload$outboundSchema;
94
+ /** @deprecated use `WebhookSubscriptionRevokedPayload$Outbound` instead. */
95
+ export type Outbound = WebhookSubscriptionRevokedPayload$Outbound;
96
+ }
@@ -19,11 +19,15 @@ export type WebhookSubscriptionUpdatedPayloadType = ClosedEnum<
19
19
  >;
20
20
 
21
21
  /**
22
- * Sent when a new subscription is updated. This event fires if the subscription is cancelled, both immediately and if the subscription is cancelled at the end of the current period.
22
+ * Sent when a subscription is updated. This event fires for all changes to the subscription, including renewals.
23
23
  *
24
24
  * @remarks
25
25
  *
26
- * **Discord & Slack support:** On cancellation
26
+ * If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, and `subscription.revoked`.
27
+ *
28
+ * To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field.
29
+ *
30
+ * **Discord & Slack support:** On cancellation and revocation. Renewals are skipped.
27
31
  */
28
32
  export type WebhookSubscriptionUpdatedPayload = {
29
33
  type?: "subscription.updated" | undefined;
@@ -0,0 +1,54 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+
8
+ export type ArticlesExportRequest = {
9
+ organizationId: string;
10
+ };
11
+
12
+ /** @internal */
13
+ export const ArticlesExportRequest$inboundSchema: z.ZodType<
14
+ ArticlesExportRequest,
15
+ z.ZodTypeDef,
16
+ unknown
17
+ > = z.object({
18
+ organization_id: z.string(),
19
+ }).transform((v) => {
20
+ return remap$(v, {
21
+ "organization_id": "organizationId",
22
+ });
23
+ });
24
+
25
+ /** @internal */
26
+ export type ArticlesExportRequest$Outbound = {
27
+ organization_id: string;
28
+ };
29
+
30
+ /** @internal */
31
+ export const ArticlesExportRequest$outboundSchema: z.ZodType<
32
+ ArticlesExportRequest$Outbound,
33
+ z.ZodTypeDef,
34
+ ArticlesExportRequest
35
+ > = z.object({
36
+ organizationId: z.string(),
37
+ }).transform((v) => {
38
+ return remap$(v, {
39
+ organizationId: "organization_id",
40
+ });
41
+ });
42
+
43
+ /**
44
+ * @internal
45
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
46
+ */
47
+ export namespace ArticlesExportRequest$ {
48
+ /** @deprecated use `ArticlesExportRequest$inboundSchema` instead. */
49
+ export const inboundSchema = ArticlesExportRequest$inboundSchema;
50
+ /** @deprecated use `ArticlesExportRequest$outboundSchema` instead. */
51
+ export const outboundSchema = ArticlesExportRequest$outboundSchema;
52
+ /** @deprecated use `ArticlesExportRequest$Outbound` instead. */
53
+ export type Outbound = ArticlesExportRequest$Outbound;
54
+ }
@@ -13,18 +13,6 @@ export type BenefitsCreateBenefitCreate =
13
13
  | (components.BenefitLicenseKeysCreate & { type: "license_keys" })
14
14
  | (components.BenefitCustomCreate & { type: "custom" });
15
15
 
16
- /**
17
- * Benefit created.
18
- */
19
- export type BenefitsCreateResponseBenefitsCreate =
20
- | components.BenefitArticles
21
- | components.BenefitAds
22
- | components.BenefitDiscord
23
- | components.BenefitGitHubRepository
24
- | components.BenefitDownloadables
25
- | components.BenefitLicenseKeys
26
- | components.BenefitCustom;
27
-
28
16
  /** @internal */
29
17
  export const BenefitsCreateBenefitCreate$inboundSchema: z.ZodType<
30
18
  BenefitsCreateBenefitCreate,
@@ -120,58 +108,3 @@ export namespace BenefitsCreateBenefitCreate$ {
120
108
  /** @deprecated use `BenefitsCreateBenefitCreate$Outbound` instead. */
121
109
  export type Outbound = BenefitsCreateBenefitCreate$Outbound;
122
110
  }
123
-
124
- /** @internal */
125
- export const BenefitsCreateResponseBenefitsCreate$inboundSchema: z.ZodType<
126
- BenefitsCreateResponseBenefitsCreate,
127
- z.ZodTypeDef,
128
- unknown
129
- > = z.union([
130
- components.BenefitArticles$inboundSchema,
131
- components.BenefitAds$inboundSchema,
132
- components.BenefitDiscord$inboundSchema,
133
- components.BenefitGitHubRepository$inboundSchema,
134
- components.BenefitDownloadables$inboundSchema,
135
- components.BenefitLicenseKeys$inboundSchema,
136
- components.BenefitCustom$inboundSchema,
137
- ]);
138
-
139
- /** @internal */
140
- export type BenefitsCreateResponseBenefitsCreate$Outbound =
141
- | components.BenefitArticles$Outbound
142
- | components.BenefitAds$Outbound
143
- | components.BenefitDiscord$Outbound
144
- | components.BenefitGitHubRepository$Outbound
145
- | components.BenefitDownloadables$Outbound
146
- | components.BenefitLicenseKeys$Outbound
147
- | components.BenefitCustom$Outbound;
148
-
149
- /** @internal */
150
- export const BenefitsCreateResponseBenefitsCreate$outboundSchema: z.ZodType<
151
- BenefitsCreateResponseBenefitsCreate$Outbound,
152
- z.ZodTypeDef,
153
- BenefitsCreateResponseBenefitsCreate
154
- > = z.union([
155
- components.BenefitArticles$outboundSchema,
156
- components.BenefitAds$outboundSchema,
157
- components.BenefitDiscord$outboundSchema,
158
- components.BenefitGitHubRepository$outboundSchema,
159
- components.BenefitDownloadables$outboundSchema,
160
- components.BenefitLicenseKeys$outboundSchema,
161
- components.BenefitCustom$outboundSchema,
162
- ]);
163
-
164
- /**
165
- * @internal
166
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
167
- */
168
- export namespace BenefitsCreateResponseBenefitsCreate$ {
169
- /** @deprecated use `BenefitsCreateResponseBenefitsCreate$inboundSchema` instead. */
170
- export const inboundSchema =
171
- BenefitsCreateResponseBenefitsCreate$inboundSchema;
172
- /** @deprecated use `BenefitsCreateResponseBenefitsCreate$outboundSchema` instead. */
173
- export const outboundSchema =
174
- BenefitsCreateResponseBenefitsCreate$outboundSchema;
175
- /** @deprecated use `BenefitsCreateResponseBenefitsCreate$Outbound` instead. */
176
- export type Outbound = BenefitsCreateResponseBenefitsCreate$Outbound;
177
- }
@@ -3,24 +3,11 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
- import * as components from "../components/index.js";
7
6
 
8
7
  export type BenefitsGetRequest = {
9
8
  id: string;
10
9
  };
11
10
 
12
- /**
13
- * Successful Response
14
- */
15
- export type BenefitsGetResponseBenefitsGet =
16
- | components.BenefitArticles
17
- | components.BenefitAds
18
- | components.BenefitDiscord
19
- | components.BenefitGitHubRepository
20
- | components.BenefitDownloadables
21
- | components.BenefitLicenseKeys
22
- | components.BenefitCustom;
23
-
24
11
  /** @internal */
25
12
  export const BenefitsGetRequest$inboundSchema: z.ZodType<
26
13
  BenefitsGetRequest,
@@ -56,56 +43,3 @@ export namespace BenefitsGetRequest$ {
56
43
  /** @deprecated use `BenefitsGetRequest$Outbound` instead. */
57
44
  export type Outbound = BenefitsGetRequest$Outbound;
58
45
  }
59
-
60
- /** @internal */
61
- export const BenefitsGetResponseBenefitsGet$inboundSchema: z.ZodType<
62
- BenefitsGetResponseBenefitsGet,
63
- z.ZodTypeDef,
64
- unknown
65
- > = z.union([
66
- components.BenefitArticles$inboundSchema,
67
- components.BenefitAds$inboundSchema,
68
- components.BenefitDiscord$inboundSchema,
69
- components.BenefitGitHubRepository$inboundSchema,
70
- components.BenefitDownloadables$inboundSchema,
71
- components.BenefitLicenseKeys$inboundSchema,
72
- components.BenefitCustom$inboundSchema,
73
- ]);
74
-
75
- /** @internal */
76
- export type BenefitsGetResponseBenefitsGet$Outbound =
77
- | components.BenefitArticles$Outbound
78
- | components.BenefitAds$Outbound
79
- | components.BenefitDiscord$Outbound
80
- | components.BenefitGitHubRepository$Outbound
81
- | components.BenefitDownloadables$Outbound
82
- | components.BenefitLicenseKeys$Outbound
83
- | components.BenefitCustom$Outbound;
84
-
85
- /** @internal */
86
- export const BenefitsGetResponseBenefitsGet$outboundSchema: z.ZodType<
87
- BenefitsGetResponseBenefitsGet$Outbound,
88
- z.ZodTypeDef,
89
- BenefitsGetResponseBenefitsGet
90
- > = z.union([
91
- components.BenefitArticles$outboundSchema,
92
- components.BenefitAds$outboundSchema,
93
- components.BenefitDiscord$outboundSchema,
94
- components.BenefitGitHubRepository$outboundSchema,
95
- components.BenefitDownloadables$outboundSchema,
96
- components.BenefitLicenseKeys$outboundSchema,
97
- components.BenefitCustom$outboundSchema,
98
- ]);
99
-
100
- /**
101
- * @internal
102
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
103
- */
104
- export namespace BenefitsGetResponseBenefitsGet$ {
105
- /** @deprecated use `BenefitsGetResponseBenefitsGet$inboundSchema` instead. */
106
- export const inboundSchema = BenefitsGetResponseBenefitsGet$inboundSchema;
107
- /** @deprecated use `BenefitsGetResponseBenefitsGet$outboundSchema` instead. */
108
- export const outboundSchema = BenefitsGetResponseBenefitsGet$outboundSchema;
109
- /** @deprecated use `BenefitsGetResponseBenefitsGet$Outbound` instead. */
110
- export type Outbound = BenefitsGetResponseBenefitsGet$Outbound;
111
- }
@@ -27,18 +27,6 @@ export type BenefitsUpdateRequest = {
27
27
  | components.BenefitLicenseKeysUpdate;
28
28
  };
29
29
 
30
- /**
31
- * Benefit updated.
32
- */
33
- export type BenefitsUpdateResponseBenefitsUpdate =
34
- | components.BenefitArticles
35
- | components.BenefitAds
36
- | components.BenefitDiscord
37
- | components.BenefitGitHubRepository
38
- | components.BenefitDownloadables
39
- | components.BenefitLicenseKeys
40
- | components.BenefitCustom;
41
-
42
30
  /** @internal */
43
31
  export const BenefitsUpdateBenefitUpdate$inboundSchema: z.ZodType<
44
32
  BenefitsUpdateBenefitUpdate,
@@ -161,58 +149,3 @@ export namespace BenefitsUpdateRequest$ {
161
149
  /** @deprecated use `BenefitsUpdateRequest$Outbound` instead. */
162
150
  export type Outbound = BenefitsUpdateRequest$Outbound;
163
151
  }
164
-
165
- /** @internal */
166
- export const BenefitsUpdateResponseBenefitsUpdate$inboundSchema: z.ZodType<
167
- BenefitsUpdateResponseBenefitsUpdate,
168
- z.ZodTypeDef,
169
- unknown
170
- > = z.union([
171
- components.BenefitArticles$inboundSchema,
172
- components.BenefitAds$inboundSchema,
173
- components.BenefitDiscord$inboundSchema,
174
- components.BenefitGitHubRepository$inboundSchema,
175
- components.BenefitDownloadables$inboundSchema,
176
- components.BenefitLicenseKeys$inboundSchema,
177
- components.BenefitCustom$inboundSchema,
178
- ]);
179
-
180
- /** @internal */
181
- export type BenefitsUpdateResponseBenefitsUpdate$Outbound =
182
- | components.BenefitArticles$Outbound
183
- | components.BenefitAds$Outbound
184
- | components.BenefitDiscord$Outbound
185
- | components.BenefitGitHubRepository$Outbound
186
- | components.BenefitDownloadables$Outbound
187
- | components.BenefitLicenseKeys$Outbound
188
- | components.BenefitCustom$Outbound;
189
-
190
- /** @internal */
191
- export const BenefitsUpdateResponseBenefitsUpdate$outboundSchema: z.ZodType<
192
- BenefitsUpdateResponseBenefitsUpdate$Outbound,
193
- z.ZodTypeDef,
194
- BenefitsUpdateResponseBenefitsUpdate
195
- > = z.union([
196
- components.BenefitArticles$outboundSchema,
197
- components.BenefitAds$outboundSchema,
198
- components.BenefitDiscord$outboundSchema,
199
- components.BenefitGitHubRepository$outboundSchema,
200
- components.BenefitDownloadables$outboundSchema,
201
- components.BenefitLicenseKeys$outboundSchema,
202
- components.BenefitCustom$outboundSchema,
203
- ]);
204
-
205
- /**
206
- * @internal
207
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
208
- */
209
- export namespace BenefitsUpdateResponseBenefitsUpdate$ {
210
- /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$inboundSchema` instead. */
211
- export const inboundSchema =
212
- BenefitsUpdateResponseBenefitsUpdate$inboundSchema;
213
- /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$outboundSchema` instead. */
214
- export const outboundSchema =
215
- BenefitsUpdateResponseBenefitsUpdate$outboundSchema;
216
- /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$Outbound` instead. */
217
- export type Outbound = BenefitsUpdateResponseBenefitsUpdate$Outbound;
218
- }
@@ -0,0 +1,48 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+
7
+ export type CheckoutLinksDeleteRequest = {
8
+ /**
9
+ * The checkout link ID.
10
+ */
11
+ id: string;
12
+ };
13
+
14
+ /** @internal */
15
+ export const CheckoutLinksDeleteRequest$inboundSchema: z.ZodType<
16
+ CheckoutLinksDeleteRequest,
17
+ z.ZodTypeDef,
18
+ unknown
19
+ > = z.object({
20
+ id: z.string(),
21
+ });
22
+
23
+ /** @internal */
24
+ export type CheckoutLinksDeleteRequest$Outbound = {
25
+ id: string;
26
+ };
27
+
28
+ /** @internal */
29
+ export const CheckoutLinksDeleteRequest$outboundSchema: z.ZodType<
30
+ CheckoutLinksDeleteRequest$Outbound,
31
+ z.ZodTypeDef,
32
+ CheckoutLinksDeleteRequest
33
+ > = z.object({
34
+ id: z.string(),
35
+ });
36
+
37
+ /**
38
+ * @internal
39
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
40
+ */
41
+ export namespace CheckoutLinksDeleteRequest$ {
42
+ /** @deprecated use `CheckoutLinksDeleteRequest$inboundSchema` instead. */
43
+ export const inboundSchema = CheckoutLinksDeleteRequest$inboundSchema;
44
+ /** @deprecated use `CheckoutLinksDeleteRequest$outboundSchema` instead. */
45
+ export const outboundSchema = CheckoutLinksDeleteRequest$outboundSchema;
46
+ /** @deprecated use `CheckoutLinksDeleteRequest$Outbound` instead. */
47
+ export type Outbound = CheckoutLinksDeleteRequest$Outbound;
48
+ }
@@ -0,0 +1,48 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+
7
+ export type CheckoutLinksGetRequest = {
8
+ /**
9
+ * The checkout link ID.
10
+ */
11
+ id: string;
12
+ };
13
+
14
+ /** @internal */
15
+ export const CheckoutLinksGetRequest$inboundSchema: z.ZodType<
16
+ CheckoutLinksGetRequest,
17
+ z.ZodTypeDef,
18
+ unknown
19
+ > = z.object({
20
+ id: z.string(),
21
+ });
22
+
23
+ /** @internal */
24
+ export type CheckoutLinksGetRequest$Outbound = {
25
+ id: string;
26
+ };
27
+
28
+ /** @internal */
29
+ export const CheckoutLinksGetRequest$outboundSchema: z.ZodType<
30
+ CheckoutLinksGetRequest$Outbound,
31
+ z.ZodTypeDef,
32
+ CheckoutLinksGetRequest
33
+ > = z.object({
34
+ id: z.string(),
35
+ });
36
+
37
+ /**
38
+ * @internal
39
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
40
+ */
41
+ export namespace CheckoutLinksGetRequest$ {
42
+ /** @deprecated use `CheckoutLinksGetRequest$inboundSchema` instead. */
43
+ export const inboundSchema = CheckoutLinksGetRequest$inboundSchema;
44
+ /** @deprecated use `CheckoutLinksGetRequest$outboundSchema` instead. */
45
+ export const outboundSchema = CheckoutLinksGetRequest$outboundSchema;
46
+ /** @deprecated use `CheckoutLinksGetRequest$Outbound` instead. */
47
+ export type Outbound = CheckoutLinksGetRequest$Outbound;
48
+ }