@polar-sh/sdk 0.17.3 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (316) hide show
  1. package/FUNCTIONS.md +106 -0
  2. package/README.md +181 -30
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/checkouts/README.md +1 -1
  5. package/docs/sdks/files/README.md +5 -1
  6. package/funcs/filesCreate.js +1 -1
  7. package/funcs/filesDelete.d.ts +1 -1
  8. package/funcs/filesDelete.d.ts.map +1 -1
  9. package/funcs/filesDelete.js +1 -1
  10. package/funcs/filesDelete.js.map +1 -1
  11. package/funcs/filesUpdate.d.ts +1 -1
  12. package/funcs/filesUpdate.d.ts.map +1 -1
  13. package/funcs/filesUpdate.js +2 -2
  14. package/funcs/filesUpdate.js.map +1 -1
  15. package/funcs/filesUploaded.d.ts +1 -1
  16. package/funcs/filesUploaded.d.ts.map +1 -1
  17. package/funcs/filesUploaded.js +2 -2
  18. package/funcs/filesUploaded.js.map +1 -1
  19. package/hooks/hooks.d.ts.map +1 -1
  20. package/hooks/hooks.js +18 -0
  21. package/hooks/hooks.js.map +1 -1
  22. package/hooks/types.d.ts +3 -0
  23. package/hooks/types.d.ts.map +1 -1
  24. package/lib/config.d.ts +3 -3
  25. package/lib/config.js +3 -3
  26. package/lib/config.js.map +1 -1
  27. package/models/components/benefit.d.ts +2 -3
  28. package/models/components/benefit.d.ts.map +1 -1
  29. package/models/components/benefit.js +0 -3
  30. package/models/components/benefit.js.map +1 -1
  31. package/models/components/benefitadssubscriber.d.ts +7 -7
  32. package/models/components/benefitadssubscriber.d.ts.map +1 -1
  33. package/models/components/benefitadssubscriber.js +11 -11
  34. package/models/components/benefitadssubscriber.js.map +1 -1
  35. package/models/components/benefitgrant.d.ts +4 -5
  36. package/models/components/benefitgrant.d.ts.map +1 -1
  37. package/models/components/benefitgrant.js +0 -5
  38. package/models/components/benefitgrant.js.map +1 -1
  39. package/models/components/benefitgrantwebhook.d.ts +8 -9
  40. package/models/components/benefitgrantwebhook.d.ts.map +1 -1
  41. package/models/components/benefitgrantwebhook.js +0 -9
  42. package/models/components/benefitgrantwebhook.js.map +1 -1
  43. package/models/components/benefittype.d.ts +0 -3
  44. package/models/components/benefittype.d.ts.map +1 -1
  45. package/models/components/benefittype.js +0 -1
  46. package/models/components/benefittype.js.map +1 -1
  47. package/models/components/checkoutlinkproduct.d.ts +2 -24
  48. package/models/components/checkoutlinkproduct.d.ts.map +1 -1
  49. package/models/components/checkoutlinkproduct.js +3 -27
  50. package/models/components/checkoutlinkproduct.js.map +1 -1
  51. package/models/components/checkoutproduct.d.ts +2 -24
  52. package/models/components/checkoutproduct.d.ts.map +1 -1
  53. package/models/components/checkoutproduct.js +3 -27
  54. package/models/components/checkoutproduct.js.map +1 -1
  55. package/models/components/index.d.ts +0 -15
  56. package/models/components/index.d.ts.map +1 -1
  57. package/models/components/index.js +0 -15
  58. package/models/components/index.js.map +1 -1
  59. package/models/components/listresourceuserbenefit.d.ts +0 -9
  60. package/models/components/listresourceuserbenefit.d.ts.map +1 -1
  61. package/models/components/listresourceuserbenefit.js +0 -13
  62. package/models/components/listresourceuserbenefit.js.map +1 -1
  63. package/models/components/oauth2client.js +2 -2
  64. package/models/components/oauth2client.js.map +1 -1
  65. package/models/components/oauth2clientconfiguration.js +2 -2
  66. package/models/components/oauth2clientconfiguration.js.map +1 -1
  67. package/models/components/oauth2clientconfigurationupdate.js +2 -2
  68. package/models/components/oauth2clientconfigurationupdate.js.map +1 -1
  69. package/models/components/organizationfeaturesettings.d.ts +0 -5
  70. package/models/components/organizationfeaturesettings.d.ts.map +1 -1
  71. package/models/components/organizationfeaturesettings.js +0 -4
  72. package/models/components/organizationfeaturesettings.js.map +1 -1
  73. package/models/components/scope.d.ts +0 -6
  74. package/models/components/scope.d.ts.map +1 -1
  75. package/models/components/scope.js +0 -2
  76. package/models/components/scope.js.map +1 -1
  77. package/models/components/userorderproduct.d.ts +2 -24
  78. package/models/components/userorderproduct.d.ts.map +1 -1
  79. package/models/components/userorderproduct.js +3 -27
  80. package/models/components/userorderproduct.js.map +1 -1
  81. package/models/components/usersubscriptionproduct.d.ts +2 -24
  82. package/models/components/usersubscriptionproduct.d.ts.map +1 -1
  83. package/models/components/usersubscriptionproduct.js +3 -27
  84. package/models/components/usersubscriptionproduct.js.map +1 -1
  85. package/models/errors/index.d.ts +0 -1
  86. package/models/errors/index.d.ts.map +1 -1
  87. package/models/errors/index.js +0 -1
  88. package/models/errors/index.js.map +1 -1
  89. package/models/operations/benefitsupdate.d.ts +4 -4
  90. package/models/operations/benefitsupdate.d.ts.map +1 -1
  91. package/models/operations/benefitsupdate.js +0 -4
  92. package/models/operations/benefitsupdate.js.map +1 -1
  93. package/models/operations/filesupdate.d.ts +1 -1
  94. package/models/operations/filesuploaded.d.ts +1 -1
  95. package/models/operations/index.d.ts +0 -8
  96. package/models/operations/index.d.ts.map +1 -1
  97. package/models/operations/index.js +0 -8
  98. package/models/operations/index.js.map +1 -1
  99. package/models/operations/usersbenefitsget.d.ts +2 -6
  100. package/models/operations/usersbenefitsget.d.ts.map +1 -1
  101. package/models/operations/usersbenefitsget.js +0 -6
  102. package/models/operations/usersbenefitsget.js.map +1 -1
  103. package/package.json +1 -3
  104. package/sdk/sdk.d.ts +0 -3
  105. package/sdk/sdk.d.ts.map +1 -1
  106. package/sdk/sdk.js +0 -5
  107. package/sdk/sdk.js.map +1 -1
  108. package/src/funcs/filesCreate.ts +1 -1
  109. package/src/funcs/filesDelete.ts +3 -3
  110. package/src/funcs/filesUpdate.ts +7 -1
  111. package/src/funcs/filesUploaded.ts +7 -1
  112. package/src/hooks/hooks.ts +20 -0
  113. package/src/hooks/types.ts +9 -0
  114. package/src/lib/config.ts +3 -3
  115. package/src/models/components/benefit.ts +0 -10
  116. package/src/models/components/benefitadssubscriber.ts +12 -15
  117. package/src/models/components/benefitgrant.ts +0 -14
  118. package/src/models/components/benefitgrantwebhook.ts +0 -22
  119. package/src/models/components/benefittype.ts +0 -1
  120. package/src/models/components/checkoutlinkproduct.ts +4 -68
  121. package/src/models/components/checkoutproduct.ts +4 -66
  122. package/src/models/components/index.ts +0 -15
  123. package/src/models/components/listresourceuserbenefit.ts +0 -30
  124. package/src/models/components/oauth2client.ts +2 -2
  125. package/src/models/components/oauth2clientconfiguration.ts +2 -2
  126. package/src/models/components/oauth2clientconfigurationupdate.ts +2 -2
  127. package/src/models/components/organizationfeaturesettings.ts +0 -9
  128. package/src/models/components/scope.ts +0 -2
  129. package/src/models/components/userorderproduct.ts +4 -60
  130. package/src/models/components/usersubscriptionproduct.ts +4 -68
  131. package/src/models/errors/index.ts +0 -1
  132. package/src/models/operations/benefitsupdate.ts +0 -8
  133. package/src/models/operations/filesupdate.ts +1 -1
  134. package/src/models/operations/filesuploaded.ts +1 -1
  135. package/src/models/operations/index.ts +0 -8
  136. package/src/models/operations/usersbenefitsget.ts +0 -12
  137. package/src/sdk/sdk.ts +0 -6
  138. package/src/types/index.ts +1 -0
  139. package/src/types/webhooks.ts +7 -0
  140. package/types/index.d.ts +1 -0
  141. package/types/index.d.ts.map +1 -1
  142. package/types/webhooks.d.ts +4 -0
  143. package/types/webhooks.d.ts.map +1 -0
  144. package/types/webhooks.js +6 -0
  145. package/types/webhooks.js.map +1 -0
  146. package/docs/sdks/articles/README.md +0 -724
  147. package/funcs/articlesCreate.d.ts +0 -16
  148. package/funcs/articlesCreate.d.ts.map +0 -1
  149. package/funcs/articlesCreate.js +0 -99
  150. package/funcs/articlesCreate.js.map +0 -1
  151. package/funcs/articlesDelete.d.ts +0 -16
  152. package/funcs/articlesDelete.d.ts.map +0 -1
  153. package/funcs/articlesDelete.js +0 -105
  154. package/funcs/articlesDelete.js.map +0 -1
  155. package/funcs/articlesExport.d.ts +0 -16
  156. package/funcs/articlesExport.d.ts.map +0 -1
  157. package/funcs/articlesExport.js +0 -103
  158. package/funcs/articlesExport.js.map +0 -1
  159. package/funcs/articlesGet.d.ts +0 -17
  160. package/funcs/articlesGet.d.ts.map +0 -1
  161. package/funcs/articlesGet.js +0 -105
  162. package/funcs/articlesGet.js.map +0 -1
  163. package/funcs/articlesList.d.ts +0 -19
  164. package/funcs/articlesList.d.ts.map +0 -1
  165. package/funcs/articlesList.js +0 -138
  166. package/funcs/articlesList.js.map +0 -1
  167. package/funcs/articlesPreview.d.ts +0 -16
  168. package/funcs/articlesPreview.d.ts.map +0 -1
  169. package/funcs/articlesPreview.js +0 -106
  170. package/funcs/articlesPreview.js.map +0 -1
  171. package/funcs/articlesReceivers.d.ts +0 -17
  172. package/funcs/articlesReceivers.d.ts.map +0 -1
  173. package/funcs/articlesReceivers.js +0 -105
  174. package/funcs/articlesReceivers.js.map +0 -1
  175. package/funcs/articlesSend.d.ts +0 -16
  176. package/funcs/articlesSend.d.ts.map +0 -1
  177. package/funcs/articlesSend.js +0 -105
  178. package/funcs/articlesSend.js.map +0 -1
  179. package/funcs/articlesUpdate.d.ts +0 -17
  180. package/funcs/articlesUpdate.d.ts.map +0 -1
  181. package/funcs/articlesUpdate.js +0 -106
  182. package/funcs/articlesUpdate.js.map +0 -1
  183. package/models/components/article.d.ts +0 -68
  184. package/models/components/article.d.ts.map +0 -1
  185. package/models/components/article.js +0 -129
  186. package/models/components/article.js.map +0 -1
  187. package/models/components/articlebyline.d.ts +0 -28
  188. package/models/components/articlebyline.d.ts.map +0 -1
  189. package/models/components/articlebyline.js +0 -50
  190. package/models/components/articlebyline.js.map +0 -1
  191. package/models/components/articlecreate.d.ts +0 -93
  192. package/models/components/articlecreate.d.ts.map +0 -1
  193. package/models/components/articlecreate.js +0 -112
  194. package/models/components/articlecreate.js.map +0 -1
  195. package/models/components/articlepreview.d.ts +0 -32
  196. package/models/components/articlepreview.d.ts.map +0 -1
  197. package/models/components/articlepreview.js +0 -59
  198. package/models/components/articlepreview.js.map +0 -1
  199. package/models/components/articlereceivers.d.ts +0 -33
  200. package/models/components/articlereceivers.d.ts.map +0 -1
  201. package/models/components/articlereceivers.js +0 -76
  202. package/models/components/articlereceivers.js.map +0 -1
  203. package/models/components/articleupdate.d.ts +0 -85
  204. package/models/components/articleupdate.d.ts.map +0 -1
  205. package/models/components/articleupdate.js +0 -108
  206. package/models/components/articleupdate.js.map +0 -1
  207. package/models/components/articlevisibility.d.ts +0 -31
  208. package/models/components/articlevisibility.d.ts.map +0 -1
  209. package/models/components/articlevisibility.js +0 -51
  210. package/models/components/articlevisibility.js.map +0 -1
  211. package/models/components/benefitarticles.d.ts +0 -100
  212. package/models/components/benefitarticles.d.ts.map +0 -1
  213. package/models/components/benefitarticles.js +0 -107
  214. package/models/components/benefitarticles.js.map +0 -1
  215. package/models/components/benefitarticlesproperties.d.ts +0 -35
  216. package/models/components/benefitarticlesproperties.d.ts.map +0 -1
  217. package/models/components/benefitarticlesproperties.js +0 -68
  218. package/models/components/benefitarticlesproperties.js.map +0 -1
  219. package/models/components/benefitarticlessubscriber.d.ts +0 -99
  220. package/models/components/benefitarticlessubscriber.d.ts.map +0 -1
  221. package/models/components/benefitarticlessubscriber.js +0 -113
  222. package/models/components/benefitarticlessubscriber.js.map +0 -1
  223. package/models/components/benefitarticlessubscriberproperties.d.ts +0 -35
  224. package/models/components/benefitarticlessubscriberproperties.d.ts.map +0 -1
  225. package/models/components/benefitarticlessubscriberproperties.js +0 -68
  226. package/models/components/benefitarticlessubscriberproperties.js.map +0 -1
  227. package/models/components/benefitarticlesupdate.d.ts +0 -57
  228. package/models/components/benefitarticlesupdate.d.ts.map +0 -1
  229. package/models/components/benefitarticlesupdate.js +0 -79
  230. package/models/components/benefitarticlesupdate.js.map +0 -1
  231. package/models/components/benefitgrantarticlesproperties.d.ts +0 -25
  232. package/models/components/benefitgrantarticlesproperties.d.ts.map +0 -1
  233. package/models/components/benefitgrantarticlesproperties.js +0 -55
  234. package/models/components/benefitgrantarticlesproperties.js.map +0 -1
  235. package/models/components/bylineprofile.d.ts +0 -31
  236. package/models/components/bylineprofile.d.ts.map +0 -1
  237. package/models/components/bylineprofile.js +0 -70
  238. package/models/components/bylineprofile.js.map +0 -1
  239. package/models/components/listresourcearticle.d.ts +0 -33
  240. package/models/components/listresourcearticle.d.ts.map +0 -1
  241. package/models/components/listresourcearticle.js +0 -63
  242. package/models/components/listresourcearticle.js.map +0 -1
  243. package/models/errors/filenotfound.d.ts +0 -57
  244. package/models/errors/filenotfound.d.ts.map +0 -1
  245. package/models/errors/filenotfound.js +0 -88
  246. package/models/errors/filenotfound.js.map +0 -1
  247. package/models/operations/articlesdelete.d.ts +0 -29
  248. package/models/operations/articlesdelete.d.ts.map +0 -1
  249. package/models/operations/articlesdelete.js +0 -59
  250. package/models/operations/articlesdelete.js.map +0 -1
  251. package/models/operations/articlesexport.d.ts +0 -29
  252. package/models/operations/articlesexport.d.ts.map +0 -1
  253. package/models/operations/articlesexport.js +0 -68
  254. package/models/operations/articlesexport.js.map +0 -1
  255. package/models/operations/articlesget.d.ts +0 -29
  256. package/models/operations/articlesget.d.ts.map +0 -1
  257. package/models/operations/articlesget.js +0 -59
  258. package/models/operations/articlesget.js.map +0 -1
  259. package/models/operations/articleslist.d.ts +0 -141
  260. package/models/operations/articleslist.d.ts.map +0 -1
  261. package/models/operations/articleslist.js +0 -184
  262. package/models/operations/articleslist.js.map +0 -1
  263. package/models/operations/articlespreview.d.ts +0 -32
  264. package/models/operations/articlespreview.d.ts.map +0 -1
  265. package/models/operations/articlespreview.js +0 -71
  266. package/models/operations/articlespreview.js.map +0 -1
  267. package/models/operations/articlesreceivers.d.ts +0 -29
  268. package/models/operations/articlesreceivers.d.ts.map +0 -1
  269. package/models/operations/articlesreceivers.js +0 -59
  270. package/models/operations/articlesreceivers.js.map +0 -1
  271. package/models/operations/articlessend.d.ts +0 -29
  272. package/models/operations/articlessend.d.ts.map +0 -1
  273. package/models/operations/articlessend.js +0 -59
  274. package/models/operations/articlessend.js.map +0 -1
  275. package/models/operations/articlesupdate.d.ts +0 -32
  276. package/models/operations/articlesupdate.d.ts.map +0 -1
  277. package/models/operations/articlesupdate.js +0 -71
  278. package/models/operations/articlesupdate.js.map +0 -1
  279. package/sdk/articles.d.ts +0 -72
  280. package/sdk/articles.d.ts.map +0 -1
  281. package/sdk/articles.js +0 -103
  282. package/sdk/articles.js.map +0 -1
  283. package/src/funcs/articlesCreate.ts +0 -131
  284. package/src/funcs/articlesDelete.ts +0 -144
  285. package/src/funcs/articlesExport.ts +0 -136
  286. package/src/funcs/articlesGet.ts +0 -141
  287. package/src/funcs/articlesList.ts +0 -205
  288. package/src/funcs/articlesPreview.ts +0 -145
  289. package/src/funcs/articlesReceivers.ts +0 -138
  290. package/src/funcs/articlesSend.ts +0 -144
  291. package/src/funcs/articlesUpdate.ts +0 -145
  292. package/src/models/components/article.ts +0 -187
  293. package/src/models/components/articlebyline.ts +0 -33
  294. package/src/models/components/articlecreate.ts +0 -191
  295. package/src/models/components/articlepreview.ts +0 -65
  296. package/src/models/components/articlereceivers.ts +0 -87
  297. package/src/models/components/articleupdate.ts +0 -179
  298. package/src/models/components/articlevisibility.ts +0 -34
  299. package/src/models/components/benefitarticles.ts +0 -175
  300. package/src/models/components/benefitarticlesproperties.ts +0 -81
  301. package/src/models/components/benefitarticlessubscriber.ts +0 -189
  302. package/src/models/components/benefitarticlessubscriberproperties.ts +0 -86
  303. package/src/models/components/benefitarticlesupdate.ts +0 -102
  304. package/src/models/components/benefitgrantarticlesproperties.ts +0 -60
  305. package/src/models/components/bylineprofile.ts +0 -75
  306. package/src/models/components/listresourcearticle.ts +0 -82
  307. package/src/models/errors/filenotfound.ts +0 -102
  308. package/src/models/operations/articlesdelete.ts +0 -66
  309. package/src/models/operations/articlesexport.ts +0 -75
  310. package/src/models/operations/articlesget.ts +0 -66
  311. package/src/models/operations/articleslist.ts +0 -342
  312. package/src/models/operations/articlespreview.ts +0 -80
  313. package/src/models/operations/articlesreceivers.ts +0 -66
  314. package/src/models/operations/articlessend.ts +0 -66
  315. package/src/models/operations/articlesupdate.ts +0 -80
  316. package/src/sdk/articles.ts +0 -173
@@ -9,10 +9,6 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  export type OrganizationFeatureSettings = {
12
- /**
13
- * If this organization has articles enabled
14
- */
15
- articlesEnabled?: boolean | undefined;
16
12
  /**
17
13
  * If this organization has issue funding enabled
18
14
  */
@@ -25,18 +21,15 @@ export const OrganizationFeatureSettings$inboundSchema: z.ZodType<
25
21
  z.ZodTypeDef,
26
22
  unknown
27
23
  > = z.object({
28
- articles_enabled: z.boolean().default(false),
29
24
  issue_funding_enabled: z.boolean().default(false),
30
25
  }).transform((v) => {
31
26
  return remap$(v, {
32
- "articles_enabled": "articlesEnabled",
33
27
  "issue_funding_enabled": "issueFundingEnabled",
34
28
  });
35
29
  });
36
30
 
37
31
  /** @internal */
38
32
  export type OrganizationFeatureSettings$Outbound = {
39
- articles_enabled: boolean;
40
33
  issue_funding_enabled: boolean;
41
34
  };
42
35
 
@@ -46,11 +39,9 @@ export const OrganizationFeatureSettings$outboundSchema: z.ZodType<
46
39
  z.ZodTypeDef,
47
40
  OrganizationFeatureSettings
48
41
  > = z.object({
49
- articlesEnabled: z.boolean().default(false),
50
42
  issueFundingEnabled: z.boolean().default(false),
51
43
  }).transform((v) => {
52
44
  return remap$(v, {
53
- articlesEnabled: "articles_enabled",
54
45
  issueFundingEnabled: "issue_funding_enabled",
55
46
  });
56
47
  });
@@ -32,8 +32,6 @@ export const Scope = {
32
32
  SubscriptionsWrite: "subscriptions:write",
33
33
  OrdersRead: "orders:read",
34
34
  MetricsRead: "metrics:read",
35
- ArticlesRead: "articles:read",
36
- ArticlesWrite: "articles:write",
37
35
  WebhooksRead: "webhooks:read",
38
36
  WebhooksWrite: "webhooks:write",
39
37
  ExternalOrganizationsRead: "external_organizations:read",
@@ -7,12 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- BenefitArticles,
12
- BenefitArticles$inboundSchema,
13
- BenefitArticles$Outbound,
14
- BenefitArticles$outboundSchema,
15
- } from "./benefitarticles.js";
16
10
  import {
17
11
  BenefitBase,
18
12
  BenefitBase$inboundSchema,
@@ -38,8 +32,6 @@ import {
38
32
  ProductPrice$outboundSchema,
39
33
  } from "./productprice.js";
40
34
 
41
- export type Benefits = BenefitBase | BenefitArticles;
42
-
43
35
  export type UserOrderProduct = {
44
36
  /**
45
37
  * Creation timestamp of the object.
@@ -80,7 +72,7 @@ export type UserOrderProduct = {
80
72
  /**
81
73
  * List of benefits granted by the product.
82
74
  */
83
- benefits: Array<BenefitBase | BenefitArticles>;
75
+ benefits: Array<BenefitBase>;
84
76
  /**
85
77
  * List of medias associated to the product.
86
78
  */
@@ -88,50 +80,6 @@ export type UserOrderProduct = {
88
80
  organization: Organization;
89
81
  };
90
82
 
91
- /** @internal */
92
- export const Benefits$inboundSchema: z.ZodType<
93
- Benefits,
94
- z.ZodTypeDef,
95
- unknown
96
- > = z.union([BenefitBase$inboundSchema, BenefitArticles$inboundSchema]);
97
-
98
- /** @internal */
99
- export type Benefits$Outbound = BenefitBase$Outbound | BenefitArticles$Outbound;
100
-
101
- /** @internal */
102
- export const Benefits$outboundSchema: z.ZodType<
103
- Benefits$Outbound,
104
- z.ZodTypeDef,
105
- Benefits
106
- > = z.union([BenefitBase$outboundSchema, BenefitArticles$outboundSchema]);
107
-
108
- /**
109
- * @internal
110
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
111
- */
112
- export namespace Benefits$ {
113
- /** @deprecated use `Benefits$inboundSchema` instead. */
114
- export const inboundSchema = Benefits$inboundSchema;
115
- /** @deprecated use `Benefits$outboundSchema` instead. */
116
- export const outboundSchema = Benefits$outboundSchema;
117
- /** @deprecated use `Benefits$Outbound` instead. */
118
- export type Outbound = Benefits$Outbound;
119
- }
120
-
121
- export function benefitsToJSON(benefits: Benefits): string {
122
- return JSON.stringify(Benefits$outboundSchema.parse(benefits));
123
- }
124
-
125
- export function benefitsFromJSON(
126
- jsonString: string,
127
- ): SafeParseResult<Benefits, SDKValidationError> {
128
- return safeParse(
129
- jsonString,
130
- (x) => Benefits$inboundSchema.parse(JSON.parse(x)),
131
- `Failed to parse 'Benefits' from JSON`,
132
- );
133
- }
134
-
135
83
  /** @internal */
136
84
  export const UserOrderProduct$inboundSchema: z.ZodType<
137
85
  UserOrderProduct,
@@ -149,9 +97,7 @@ export const UserOrderProduct$inboundSchema: z.ZodType<
149
97
  is_archived: z.boolean(),
150
98
  organization_id: z.string(),
151
99
  prices: z.array(ProductPrice$inboundSchema),
152
- benefits: z.array(
153
- z.union([BenefitBase$inboundSchema, BenefitArticles$inboundSchema]),
154
- ),
100
+ benefits: z.array(BenefitBase$inboundSchema),
155
101
  medias: z.array(ProductMediaFileRead$inboundSchema),
156
102
  organization: Organization$inboundSchema,
157
103
  }).transform((v) => {
@@ -175,7 +121,7 @@ export type UserOrderProduct$Outbound = {
175
121
  is_archived: boolean;
176
122
  organization_id: string;
177
123
  prices: Array<ProductPrice$Outbound>;
178
- benefits: Array<BenefitBase$Outbound | BenefitArticles$Outbound>;
124
+ benefits: Array<BenefitBase$Outbound>;
179
125
  medias: Array<ProductMediaFileRead$Outbound>;
180
126
  organization: Organization$Outbound;
181
127
  };
@@ -195,9 +141,7 @@ export const UserOrderProduct$outboundSchema: z.ZodType<
195
141
  isArchived: z.boolean(),
196
142
  organizationId: z.string(),
197
143
  prices: z.array(ProductPrice$outboundSchema),
198
- benefits: z.array(
199
- z.union([BenefitBase$outboundSchema, BenefitArticles$outboundSchema]),
200
- ),
144
+ benefits: z.array(BenefitBase$outboundSchema),
201
145
  medias: z.array(ProductMediaFileRead$outboundSchema),
202
146
  organization: Organization$outboundSchema,
203
147
  }).transform((v) => {
@@ -7,12 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- BenefitArticles,
12
- BenefitArticles$inboundSchema,
13
- BenefitArticles$Outbound,
14
- BenefitArticles$outboundSchema,
15
- } from "./benefitarticles.js";
16
10
  import {
17
11
  BenefitBase,
18
12
  BenefitBase$inboundSchema,
@@ -38,8 +32,6 @@ import {
38
32
  ProductPrice$outboundSchema,
39
33
  } from "./productprice.js";
40
34
 
41
- export type UserSubscriptionProductBenefits = BenefitBase | BenefitArticles;
42
-
43
35
  export type UserSubscriptionProduct = {
44
36
  /**
45
37
  * Creation timestamp of the object.
@@ -80,7 +72,7 @@ export type UserSubscriptionProduct = {
80
72
  /**
81
73
  * List of benefits granted by the product.
82
74
  */
83
- benefits: Array<BenefitBase | BenefitArticles>;
75
+ benefits: Array<BenefitBase>;
84
76
  /**
85
77
  * List of medias associated to the product.
86
78
  */
@@ -88,58 +80,6 @@ export type UserSubscriptionProduct = {
88
80
  organization: Organization;
89
81
  };
90
82
 
91
- /** @internal */
92
- export const UserSubscriptionProductBenefits$inboundSchema: z.ZodType<
93
- UserSubscriptionProductBenefits,
94
- z.ZodTypeDef,
95
- unknown
96
- > = z.union([BenefitBase$inboundSchema, BenefitArticles$inboundSchema]);
97
-
98
- /** @internal */
99
- export type UserSubscriptionProductBenefits$Outbound =
100
- | BenefitBase$Outbound
101
- | BenefitArticles$Outbound;
102
-
103
- /** @internal */
104
- export const UserSubscriptionProductBenefits$outboundSchema: z.ZodType<
105
- UserSubscriptionProductBenefits$Outbound,
106
- z.ZodTypeDef,
107
- UserSubscriptionProductBenefits
108
- > = z.union([BenefitBase$outboundSchema, BenefitArticles$outboundSchema]);
109
-
110
- /**
111
- * @internal
112
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
113
- */
114
- export namespace UserSubscriptionProductBenefits$ {
115
- /** @deprecated use `UserSubscriptionProductBenefits$inboundSchema` instead. */
116
- export const inboundSchema = UserSubscriptionProductBenefits$inboundSchema;
117
- /** @deprecated use `UserSubscriptionProductBenefits$outboundSchema` instead. */
118
- export const outboundSchema = UserSubscriptionProductBenefits$outboundSchema;
119
- /** @deprecated use `UserSubscriptionProductBenefits$Outbound` instead. */
120
- export type Outbound = UserSubscriptionProductBenefits$Outbound;
121
- }
122
-
123
- export function userSubscriptionProductBenefitsToJSON(
124
- userSubscriptionProductBenefits: UserSubscriptionProductBenefits,
125
- ): string {
126
- return JSON.stringify(
127
- UserSubscriptionProductBenefits$outboundSchema.parse(
128
- userSubscriptionProductBenefits,
129
- ),
130
- );
131
- }
132
-
133
- export function userSubscriptionProductBenefitsFromJSON(
134
- jsonString: string,
135
- ): SafeParseResult<UserSubscriptionProductBenefits, SDKValidationError> {
136
- return safeParse(
137
- jsonString,
138
- (x) => UserSubscriptionProductBenefits$inboundSchema.parse(JSON.parse(x)),
139
- `Failed to parse 'UserSubscriptionProductBenefits' from JSON`,
140
- );
141
- }
142
-
143
83
  /** @internal */
144
84
  export const UserSubscriptionProduct$inboundSchema: z.ZodType<
145
85
  UserSubscriptionProduct,
@@ -157,9 +97,7 @@ export const UserSubscriptionProduct$inboundSchema: z.ZodType<
157
97
  is_archived: z.boolean(),
158
98
  organization_id: z.string(),
159
99
  prices: z.array(ProductPrice$inboundSchema),
160
- benefits: z.array(
161
- z.union([BenefitBase$inboundSchema, BenefitArticles$inboundSchema]),
162
- ),
100
+ benefits: z.array(BenefitBase$inboundSchema),
163
101
  medias: z.array(ProductMediaFileRead$inboundSchema),
164
102
  organization: Organization$inboundSchema,
165
103
  }).transform((v) => {
@@ -183,7 +121,7 @@ export type UserSubscriptionProduct$Outbound = {
183
121
  is_archived: boolean;
184
122
  organization_id: string;
185
123
  prices: Array<ProductPrice$Outbound>;
186
- benefits: Array<BenefitBase$Outbound | BenefitArticles$Outbound>;
124
+ benefits: Array<BenefitBase$Outbound>;
187
125
  medias: Array<ProductMediaFileRead$Outbound>;
188
126
  organization: Organization$Outbound;
189
127
  };
@@ -203,9 +141,7 @@ export const UserSubscriptionProduct$outboundSchema: z.ZodType<
203
141
  isArchived: z.boolean(),
204
142
  organizationId: z.string(),
205
143
  prices: z.array(ProductPrice$outboundSchema),
206
- benefits: z.array(
207
- z.union([BenefitBase$outboundSchema, BenefitArticles$outboundSchema]),
208
- ),
144
+ benefits: z.array(BenefitBase$outboundSchema),
209
145
  medias: z.array(ProductMediaFileRead$outboundSchema),
210
146
  organization: Organization$outboundSchema,
211
147
  }).transform((v) => {
@@ -3,7 +3,6 @@
3
3
  */
4
4
 
5
5
  export * from "./alreadycanceledsubscription.js";
6
- export * from "./filenotfound.js";
7
6
  export * from "./httpclienterrors.js";
8
7
  export * from "./httpvalidationerror.js";
9
8
  export * from "./notpermitted.js";
@@ -10,7 +10,6 @@ import * as components from "../components/index.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  export type BenefitsUpdateBenefitUpdate =
13
- | components.BenefitArticlesUpdate
14
13
  | components.BenefitAdsUpdate
15
14
  | components.BenefitCustomUpdate
16
15
  | components.BenefitDiscordUpdate
@@ -21,7 +20,6 @@ export type BenefitsUpdateBenefitUpdate =
21
20
  export type BenefitsUpdateRequest = {
22
21
  id: string;
23
22
  requestBody:
24
- | components.BenefitArticlesUpdate
25
23
  | components.BenefitAdsUpdate
26
24
  | components.BenefitCustomUpdate
27
25
  | components.BenefitDiscordUpdate
@@ -36,7 +34,6 @@ export const BenefitsUpdateBenefitUpdate$inboundSchema: z.ZodType<
36
34
  z.ZodTypeDef,
37
35
  unknown
38
36
  > = z.union([
39
- components.BenefitArticlesUpdate$inboundSchema,
40
37
  components.BenefitAdsUpdate$inboundSchema,
41
38
  components.BenefitCustomUpdate$inboundSchema,
42
39
  components.BenefitDiscordUpdate$inboundSchema,
@@ -47,7 +44,6 @@ export const BenefitsUpdateBenefitUpdate$inboundSchema: z.ZodType<
47
44
 
48
45
  /** @internal */
49
46
  export type BenefitsUpdateBenefitUpdate$Outbound =
50
- | components.BenefitArticlesUpdate$Outbound
51
47
  | components.BenefitAdsUpdate$Outbound
52
48
  | components.BenefitCustomUpdate$Outbound
53
49
  | components.BenefitDiscordUpdate$Outbound
@@ -61,7 +57,6 @@ export const BenefitsUpdateBenefitUpdate$outboundSchema: z.ZodType<
61
57
  z.ZodTypeDef,
62
58
  BenefitsUpdateBenefitUpdate
63
59
  > = z.union([
64
- components.BenefitArticlesUpdate$outboundSchema,
65
60
  components.BenefitAdsUpdate$outboundSchema,
66
61
  components.BenefitCustomUpdate$outboundSchema,
67
62
  components.BenefitDiscordUpdate$outboundSchema,
@@ -111,7 +106,6 @@ export const BenefitsUpdateRequest$inboundSchema: z.ZodType<
111
106
  > = z.object({
112
107
  id: z.string(),
113
108
  RequestBody: z.union([
114
- components.BenefitArticlesUpdate$inboundSchema,
115
109
  components.BenefitAdsUpdate$inboundSchema,
116
110
  components.BenefitCustomUpdate$inboundSchema,
117
111
  components.BenefitDiscordUpdate$inboundSchema,
@@ -129,7 +123,6 @@ export const BenefitsUpdateRequest$inboundSchema: z.ZodType<
129
123
  export type BenefitsUpdateRequest$Outbound = {
130
124
  id: string;
131
125
  RequestBody:
132
- | components.BenefitArticlesUpdate$Outbound
133
126
  | components.BenefitAdsUpdate$Outbound
134
127
  | components.BenefitCustomUpdate$Outbound
135
128
  | components.BenefitDiscordUpdate$Outbound
@@ -146,7 +139,6 @@ export const BenefitsUpdateRequest$outboundSchema: z.ZodType<
146
139
  > = z.object({
147
140
  id: z.string(),
148
141
  requestBody: z.union([
149
- components.BenefitArticlesUpdate$outboundSchema,
150
142
  components.BenefitAdsUpdate$outboundSchema,
151
143
  components.BenefitCustomUpdate$outboundSchema,
152
144
  components.BenefitDiscordUpdate$outboundSchema,
@@ -18,7 +18,7 @@ export type FilesUpdateRequest = {
18
18
  };
19
19
 
20
20
  /**
21
- * Successful Response
21
+ * File updated.
22
22
  */
23
23
  export type FilesUpdateResponseFilesUpdate =
24
24
  | (components.DownloadableFileRead & { service: "downloadable" })
@@ -18,7 +18,7 @@ export type FilesUploadedRequest = {
18
18
  };
19
19
 
20
20
  /**
21
- * Successful Response
21
+ * File upload completed.
22
22
  */
23
23
  export type FilesUploadedResponseFilesUploaded =
24
24
  | (components.DownloadableFileRead & { service: "downloadable" })
@@ -4,14 +4,6 @@
4
4
 
5
5
  export * from "./advertisementsget.js";
6
6
  export * from "./advertisementslist.js";
7
- export * from "./articlesdelete.js";
8
- export * from "./articlesexport.js";
9
- export * from "./articlesget.js";
10
- export * from "./articleslist.js";
11
- export * from "./articlespreview.js";
12
- export * from "./articlesreceivers.js";
13
- export * from "./articlessend.js";
14
- export * from "./articlesupdate.js";
15
7
  export * from "./benefitsdelete.js";
16
8
  export * from "./benefitsget.js";
17
9
  export * from "./benefitsgrants.js";
@@ -19,7 +19,6 @@ export type UsersBenefitsGetRequest = {
19
19
  * Successful Response
20
20
  */
21
21
  export type UsersBenefitsGetResponseUsersBenefitsGet =
22
- | (components.BenefitArticlesSubscriber & { type: "articles" })
23
22
  | (components.BenefitAdsSubscriber & { type: "ads" })
24
23
  | (components.BenefitDiscordSubscriber & { type: "discord" })
25
24
  | (components.BenefitCustomSubscriber & { type: "custom" })
@@ -89,11 +88,6 @@ export const UsersBenefitsGetResponseUsersBenefitsGet$inboundSchema: z.ZodType<
89
88
  z.ZodTypeDef,
90
89
  unknown
91
90
  > = z.union([
92
- components.BenefitArticlesSubscriber$inboundSchema.and(
93
- z.object({ type: z.literal("articles") }).transform((v) => ({
94
- type: v.type,
95
- })),
96
- ),
97
91
  components.BenefitAdsSubscriber$inboundSchema.and(
98
92
  z.object({ type: z.literal("ads") }).transform((v) => ({ type: v.type })),
99
93
  ),
@@ -126,7 +120,6 @@ export const UsersBenefitsGetResponseUsersBenefitsGet$inboundSchema: z.ZodType<
126
120
 
127
121
  /** @internal */
128
122
  export type UsersBenefitsGetResponseUsersBenefitsGet$Outbound =
129
- | (components.BenefitArticlesSubscriber$Outbound & { type: "articles" })
130
123
  | (components.BenefitAdsSubscriber$Outbound & { type: "ads" })
131
124
  | (components.BenefitDiscordSubscriber$Outbound & { type: "discord" })
132
125
  | (components.BenefitCustomSubscriber$Outbound & { type: "custom" })
@@ -146,11 +139,6 @@ export const UsersBenefitsGetResponseUsersBenefitsGet$outboundSchema: z.ZodType<
146
139
  z.ZodTypeDef,
147
140
  UsersBenefitsGetResponseUsersBenefitsGet
148
141
  > = z.union([
149
- components.BenefitArticlesSubscriber$outboundSchema.and(
150
- z.object({ type: z.literal("articles") }).transform((v) => ({
151
- type: v.type,
152
- })),
153
- ),
154
142
  components.BenefitAdsSubscriber$outboundSchema.and(
155
143
  z.object({ type: z.literal("ads") }).transform((v) => ({ type: v.type })),
156
144
  ),
package/src/sdk/sdk.ts CHANGED
@@ -4,7 +4,6 @@
4
4
 
5
5
  import { ClientSDK } from "../lib/sdks.js";
6
6
  import { Advertisements } from "./advertisements.js";
7
- import { Articles } from "./articles.js";
8
7
  import { Benefits } from "./benefits.js";
9
8
  import { CheckoutLinks } from "./checkoutlinks.js";
10
9
  import { Checkouts } from "./checkouts.js";
@@ -50,11 +49,6 @@ export class Polar extends ClientSDK {
50
49
  return (this._subscriptions ??= new Subscriptions(this._options));
51
50
  }
52
51
 
53
- private _articles?: Articles;
54
- get articles(): Articles {
55
- return (this._articles ??= new Articles(this._options));
56
- }
57
-
58
52
  private _advertisements?: Advertisements;
59
53
  get advertisements(): Advertisements {
60
54
  return (this._advertisements ??= new Advertisements(this._options));
@@ -9,3 +9,4 @@ export type { Result } from "./fp.js";
9
9
  export type { PageIterator, Paginator } from "./operations.js";
10
10
  export { createPageIterator } from "./operations.js";
11
11
  export { RFCDate } from "./rfcdate.js";
12
+ export type { WebhookRecipient } from "./webhooks.js";
@@ -0,0 +1,7 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ export type WebhookRecipient = {
6
+ url: string;
7
+ };
package/types/index.d.ts CHANGED
@@ -5,4 +5,5 @@ export type { Result } from "./fp.js";
5
5
  export type { PageIterator, Paginator } from "./operations.js";
6
6
  export { createPageIterator } from "./operations.js";
7
7
  export { RFCDate } from "./rfcdate.js";
8
+ export type { WebhookRecipient } from "./webhooks.js";
8
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}
@@ -0,0 +1,4 @@
1
+ export type WebhookRecipient = {
2
+ url: string;
3
+ };
4
+ //# sourceMappingURL=webhooks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/types/webhooks.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ //# sourceMappingURL=webhooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/types/webhooks.ts"],"names":[],"mappings":";AAAA;;GAEG"}