@polar-sh/sdk 0.17.4 → 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 (284) 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/hooks/hooks.d.ts.map +1 -1
  6. package/hooks/hooks.js +18 -0
  7. package/hooks/hooks.js.map +1 -1
  8. package/hooks/types.d.ts +3 -0
  9. package/hooks/types.d.ts.map +1 -1
  10. package/lib/config.d.ts +3 -3
  11. package/lib/config.js +3 -3
  12. package/lib/config.js.map +1 -1
  13. package/models/components/benefit.d.ts +2 -3
  14. package/models/components/benefit.d.ts.map +1 -1
  15. package/models/components/benefit.js +0 -3
  16. package/models/components/benefit.js.map +1 -1
  17. package/models/components/benefitadssubscriber.d.ts +7 -7
  18. package/models/components/benefitadssubscriber.d.ts.map +1 -1
  19. package/models/components/benefitadssubscriber.js +11 -11
  20. package/models/components/benefitadssubscriber.js.map +1 -1
  21. package/models/components/benefitgrant.d.ts +4 -5
  22. package/models/components/benefitgrant.d.ts.map +1 -1
  23. package/models/components/benefitgrant.js +0 -5
  24. package/models/components/benefitgrant.js.map +1 -1
  25. package/models/components/benefitgrantwebhook.d.ts +8 -9
  26. package/models/components/benefitgrantwebhook.d.ts.map +1 -1
  27. package/models/components/benefitgrantwebhook.js +0 -9
  28. package/models/components/benefitgrantwebhook.js.map +1 -1
  29. package/models/components/benefittype.d.ts +0 -3
  30. package/models/components/benefittype.d.ts.map +1 -1
  31. package/models/components/benefittype.js +0 -1
  32. package/models/components/benefittype.js.map +1 -1
  33. package/models/components/checkoutlinkproduct.d.ts +2 -24
  34. package/models/components/checkoutlinkproduct.d.ts.map +1 -1
  35. package/models/components/checkoutlinkproduct.js +3 -27
  36. package/models/components/checkoutlinkproduct.js.map +1 -1
  37. package/models/components/checkoutproduct.d.ts +2 -24
  38. package/models/components/checkoutproduct.d.ts.map +1 -1
  39. package/models/components/checkoutproduct.js +3 -27
  40. package/models/components/checkoutproduct.js.map +1 -1
  41. package/models/components/index.d.ts +0 -15
  42. package/models/components/index.d.ts.map +1 -1
  43. package/models/components/index.js +0 -15
  44. package/models/components/index.js.map +1 -1
  45. package/models/components/listresourceuserbenefit.d.ts +0 -9
  46. package/models/components/listresourceuserbenefit.d.ts.map +1 -1
  47. package/models/components/listresourceuserbenefit.js +0 -13
  48. package/models/components/listresourceuserbenefit.js.map +1 -1
  49. package/models/components/oauth2client.js +2 -2
  50. package/models/components/oauth2client.js.map +1 -1
  51. package/models/components/oauth2clientconfiguration.js +2 -2
  52. package/models/components/oauth2clientconfiguration.js.map +1 -1
  53. package/models/components/oauth2clientconfigurationupdate.js +2 -2
  54. package/models/components/oauth2clientconfigurationupdate.js.map +1 -1
  55. package/models/components/organizationfeaturesettings.d.ts +0 -5
  56. package/models/components/organizationfeaturesettings.d.ts.map +1 -1
  57. package/models/components/organizationfeaturesettings.js +0 -4
  58. package/models/components/organizationfeaturesettings.js.map +1 -1
  59. package/models/components/scope.d.ts +0 -6
  60. package/models/components/scope.d.ts.map +1 -1
  61. package/models/components/scope.js +0 -2
  62. package/models/components/scope.js.map +1 -1
  63. package/models/components/userorderproduct.d.ts +2 -24
  64. package/models/components/userorderproduct.d.ts.map +1 -1
  65. package/models/components/userorderproduct.js +3 -27
  66. package/models/components/userorderproduct.js.map +1 -1
  67. package/models/components/usersubscriptionproduct.d.ts +2 -24
  68. package/models/components/usersubscriptionproduct.d.ts.map +1 -1
  69. package/models/components/usersubscriptionproduct.js +3 -27
  70. package/models/components/usersubscriptionproduct.js.map +1 -1
  71. package/models/operations/benefitsupdate.d.ts +4 -4
  72. package/models/operations/benefitsupdate.d.ts.map +1 -1
  73. package/models/operations/benefitsupdate.js +0 -4
  74. package/models/operations/benefitsupdate.js.map +1 -1
  75. package/models/operations/index.d.ts +0 -8
  76. package/models/operations/index.d.ts.map +1 -1
  77. package/models/operations/index.js +0 -8
  78. package/models/operations/index.js.map +1 -1
  79. package/models/operations/usersbenefitsget.d.ts +2 -6
  80. package/models/operations/usersbenefitsget.d.ts.map +1 -1
  81. package/models/operations/usersbenefitsget.js +0 -6
  82. package/models/operations/usersbenefitsget.js.map +1 -1
  83. package/package.json +1 -3
  84. package/sdk/sdk.d.ts +0 -3
  85. package/sdk/sdk.d.ts.map +1 -1
  86. package/sdk/sdk.js +0 -5
  87. package/sdk/sdk.js.map +1 -1
  88. package/src/hooks/hooks.ts +20 -0
  89. package/src/hooks/types.ts +9 -0
  90. package/src/lib/config.ts +3 -3
  91. package/src/models/components/benefit.ts +0 -10
  92. package/src/models/components/benefitadssubscriber.ts +12 -15
  93. package/src/models/components/benefitgrant.ts +0 -14
  94. package/src/models/components/benefitgrantwebhook.ts +0 -22
  95. package/src/models/components/benefittype.ts +0 -1
  96. package/src/models/components/checkoutlinkproduct.ts +4 -68
  97. package/src/models/components/checkoutproduct.ts +4 -66
  98. package/src/models/components/index.ts +0 -15
  99. package/src/models/components/listresourceuserbenefit.ts +0 -30
  100. package/src/models/components/oauth2client.ts +2 -2
  101. package/src/models/components/oauth2clientconfiguration.ts +2 -2
  102. package/src/models/components/oauth2clientconfigurationupdate.ts +2 -2
  103. package/src/models/components/organizationfeaturesettings.ts +0 -9
  104. package/src/models/components/scope.ts +0 -2
  105. package/src/models/components/userorderproduct.ts +4 -60
  106. package/src/models/components/usersubscriptionproduct.ts +4 -68
  107. package/src/models/operations/benefitsupdate.ts +0 -8
  108. package/src/models/operations/index.ts +0 -8
  109. package/src/models/operations/usersbenefitsget.ts +0 -12
  110. package/src/sdk/sdk.ts +0 -6
  111. package/src/types/index.ts +1 -0
  112. package/src/types/webhooks.ts +7 -0
  113. package/types/index.d.ts +1 -0
  114. package/types/index.d.ts.map +1 -1
  115. package/types/webhooks.d.ts +4 -0
  116. package/types/webhooks.d.ts.map +1 -0
  117. package/types/webhooks.js +6 -0
  118. package/types/webhooks.js.map +1 -0
  119. package/docs/sdks/articles/README.md +0 -724
  120. package/funcs/articlesCreate.d.ts +0 -16
  121. package/funcs/articlesCreate.d.ts.map +0 -1
  122. package/funcs/articlesCreate.js +0 -99
  123. package/funcs/articlesCreate.js.map +0 -1
  124. package/funcs/articlesDelete.d.ts +0 -16
  125. package/funcs/articlesDelete.d.ts.map +0 -1
  126. package/funcs/articlesDelete.js +0 -105
  127. package/funcs/articlesDelete.js.map +0 -1
  128. package/funcs/articlesExport.d.ts +0 -16
  129. package/funcs/articlesExport.d.ts.map +0 -1
  130. package/funcs/articlesExport.js +0 -103
  131. package/funcs/articlesExport.js.map +0 -1
  132. package/funcs/articlesGet.d.ts +0 -17
  133. package/funcs/articlesGet.d.ts.map +0 -1
  134. package/funcs/articlesGet.js +0 -105
  135. package/funcs/articlesGet.js.map +0 -1
  136. package/funcs/articlesList.d.ts +0 -19
  137. package/funcs/articlesList.d.ts.map +0 -1
  138. package/funcs/articlesList.js +0 -138
  139. package/funcs/articlesList.js.map +0 -1
  140. package/funcs/articlesPreview.d.ts +0 -16
  141. package/funcs/articlesPreview.d.ts.map +0 -1
  142. package/funcs/articlesPreview.js +0 -106
  143. package/funcs/articlesPreview.js.map +0 -1
  144. package/funcs/articlesReceivers.d.ts +0 -17
  145. package/funcs/articlesReceivers.d.ts.map +0 -1
  146. package/funcs/articlesReceivers.js +0 -105
  147. package/funcs/articlesReceivers.js.map +0 -1
  148. package/funcs/articlesSend.d.ts +0 -16
  149. package/funcs/articlesSend.d.ts.map +0 -1
  150. package/funcs/articlesSend.js +0 -105
  151. package/funcs/articlesSend.js.map +0 -1
  152. package/funcs/articlesUpdate.d.ts +0 -17
  153. package/funcs/articlesUpdate.d.ts.map +0 -1
  154. package/funcs/articlesUpdate.js +0 -106
  155. package/funcs/articlesUpdate.js.map +0 -1
  156. package/models/components/article.d.ts +0 -68
  157. package/models/components/article.d.ts.map +0 -1
  158. package/models/components/article.js +0 -129
  159. package/models/components/article.js.map +0 -1
  160. package/models/components/articlebyline.d.ts +0 -28
  161. package/models/components/articlebyline.d.ts.map +0 -1
  162. package/models/components/articlebyline.js +0 -50
  163. package/models/components/articlebyline.js.map +0 -1
  164. package/models/components/articlecreate.d.ts +0 -93
  165. package/models/components/articlecreate.d.ts.map +0 -1
  166. package/models/components/articlecreate.js +0 -112
  167. package/models/components/articlecreate.js.map +0 -1
  168. package/models/components/articlepreview.d.ts +0 -32
  169. package/models/components/articlepreview.d.ts.map +0 -1
  170. package/models/components/articlepreview.js +0 -59
  171. package/models/components/articlepreview.js.map +0 -1
  172. package/models/components/articlereceivers.d.ts +0 -33
  173. package/models/components/articlereceivers.d.ts.map +0 -1
  174. package/models/components/articlereceivers.js +0 -76
  175. package/models/components/articlereceivers.js.map +0 -1
  176. package/models/components/articleupdate.d.ts +0 -85
  177. package/models/components/articleupdate.d.ts.map +0 -1
  178. package/models/components/articleupdate.js +0 -108
  179. package/models/components/articleupdate.js.map +0 -1
  180. package/models/components/articlevisibility.d.ts +0 -31
  181. package/models/components/articlevisibility.d.ts.map +0 -1
  182. package/models/components/articlevisibility.js +0 -51
  183. package/models/components/articlevisibility.js.map +0 -1
  184. package/models/components/benefitarticles.d.ts +0 -100
  185. package/models/components/benefitarticles.d.ts.map +0 -1
  186. package/models/components/benefitarticles.js +0 -107
  187. package/models/components/benefitarticles.js.map +0 -1
  188. package/models/components/benefitarticlesproperties.d.ts +0 -35
  189. package/models/components/benefitarticlesproperties.d.ts.map +0 -1
  190. package/models/components/benefitarticlesproperties.js +0 -68
  191. package/models/components/benefitarticlesproperties.js.map +0 -1
  192. package/models/components/benefitarticlessubscriber.d.ts +0 -99
  193. package/models/components/benefitarticlessubscriber.d.ts.map +0 -1
  194. package/models/components/benefitarticlessubscriber.js +0 -113
  195. package/models/components/benefitarticlessubscriber.js.map +0 -1
  196. package/models/components/benefitarticlessubscriberproperties.d.ts +0 -35
  197. package/models/components/benefitarticlessubscriberproperties.d.ts.map +0 -1
  198. package/models/components/benefitarticlessubscriberproperties.js +0 -68
  199. package/models/components/benefitarticlessubscriberproperties.js.map +0 -1
  200. package/models/components/benefitarticlesupdate.d.ts +0 -57
  201. package/models/components/benefitarticlesupdate.d.ts.map +0 -1
  202. package/models/components/benefitarticlesupdate.js +0 -79
  203. package/models/components/benefitarticlesupdate.js.map +0 -1
  204. package/models/components/benefitgrantarticlesproperties.d.ts +0 -25
  205. package/models/components/benefitgrantarticlesproperties.d.ts.map +0 -1
  206. package/models/components/benefitgrantarticlesproperties.js +0 -55
  207. package/models/components/benefitgrantarticlesproperties.js.map +0 -1
  208. package/models/components/bylineprofile.d.ts +0 -31
  209. package/models/components/bylineprofile.d.ts.map +0 -1
  210. package/models/components/bylineprofile.js +0 -70
  211. package/models/components/bylineprofile.js.map +0 -1
  212. package/models/components/listresourcearticle.d.ts +0 -33
  213. package/models/components/listresourcearticle.d.ts.map +0 -1
  214. package/models/components/listresourcearticle.js +0 -63
  215. package/models/components/listresourcearticle.js.map +0 -1
  216. package/models/operations/articlesdelete.d.ts +0 -29
  217. package/models/operations/articlesdelete.d.ts.map +0 -1
  218. package/models/operations/articlesdelete.js +0 -59
  219. package/models/operations/articlesdelete.js.map +0 -1
  220. package/models/operations/articlesexport.d.ts +0 -29
  221. package/models/operations/articlesexport.d.ts.map +0 -1
  222. package/models/operations/articlesexport.js +0 -68
  223. package/models/operations/articlesexport.js.map +0 -1
  224. package/models/operations/articlesget.d.ts +0 -29
  225. package/models/operations/articlesget.d.ts.map +0 -1
  226. package/models/operations/articlesget.js +0 -59
  227. package/models/operations/articlesget.js.map +0 -1
  228. package/models/operations/articleslist.d.ts +0 -141
  229. package/models/operations/articleslist.d.ts.map +0 -1
  230. package/models/operations/articleslist.js +0 -184
  231. package/models/operations/articleslist.js.map +0 -1
  232. package/models/operations/articlespreview.d.ts +0 -32
  233. package/models/operations/articlespreview.d.ts.map +0 -1
  234. package/models/operations/articlespreview.js +0 -71
  235. package/models/operations/articlespreview.js.map +0 -1
  236. package/models/operations/articlesreceivers.d.ts +0 -29
  237. package/models/operations/articlesreceivers.d.ts.map +0 -1
  238. package/models/operations/articlesreceivers.js +0 -59
  239. package/models/operations/articlesreceivers.js.map +0 -1
  240. package/models/operations/articlessend.d.ts +0 -29
  241. package/models/operations/articlessend.d.ts.map +0 -1
  242. package/models/operations/articlessend.js +0 -59
  243. package/models/operations/articlessend.js.map +0 -1
  244. package/models/operations/articlesupdate.d.ts +0 -32
  245. package/models/operations/articlesupdate.d.ts.map +0 -1
  246. package/models/operations/articlesupdate.js +0 -71
  247. package/models/operations/articlesupdate.js.map +0 -1
  248. package/sdk/articles.d.ts +0 -72
  249. package/sdk/articles.d.ts.map +0 -1
  250. package/sdk/articles.js +0 -103
  251. package/sdk/articles.js.map +0 -1
  252. package/src/funcs/articlesCreate.ts +0 -131
  253. package/src/funcs/articlesDelete.ts +0 -144
  254. package/src/funcs/articlesExport.ts +0 -136
  255. package/src/funcs/articlesGet.ts +0 -141
  256. package/src/funcs/articlesList.ts +0 -205
  257. package/src/funcs/articlesPreview.ts +0 -145
  258. package/src/funcs/articlesReceivers.ts +0 -138
  259. package/src/funcs/articlesSend.ts +0 -144
  260. package/src/funcs/articlesUpdate.ts +0 -145
  261. package/src/models/components/article.ts +0 -187
  262. package/src/models/components/articlebyline.ts +0 -33
  263. package/src/models/components/articlecreate.ts +0 -191
  264. package/src/models/components/articlepreview.ts +0 -65
  265. package/src/models/components/articlereceivers.ts +0 -87
  266. package/src/models/components/articleupdate.ts +0 -179
  267. package/src/models/components/articlevisibility.ts +0 -34
  268. package/src/models/components/benefitarticles.ts +0 -175
  269. package/src/models/components/benefitarticlesproperties.ts +0 -81
  270. package/src/models/components/benefitarticlessubscriber.ts +0 -189
  271. package/src/models/components/benefitarticlessubscriberproperties.ts +0 -86
  272. package/src/models/components/benefitarticlesupdate.ts +0 -102
  273. package/src/models/components/benefitgrantarticlesproperties.ts +0 -60
  274. package/src/models/components/bylineprofile.ts +0 -75
  275. package/src/models/components/listresourcearticle.ts +0 -82
  276. package/src/models/operations/articlesdelete.ts +0 -66
  277. package/src/models/operations/articlesexport.ts +0 -75
  278. package/src/models/operations/articlesget.ts +0 -66
  279. package/src/models/operations/articleslist.ts +0 -342
  280. package/src/models/operations/articlespreview.ts +0 -80
  281. package/src/models/operations/articlesreceivers.ts +0 -66
  282. package/src/models/operations/articlessend.ts +0 -66
  283. package/src/models/operations/articlesupdate.ts +0 -80
  284. package/src/sdk/articles.ts +0 -173
@@ -1,80 +0,0 @@
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
- import { safeParse } from "../../lib/schemas.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import * as components from "../components/index.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export type ArticlesPreviewRequest = {
13
- id: string;
14
- articlePreview: components.ArticlePreview;
15
- };
16
-
17
- /** @internal */
18
- export const ArticlesPreviewRequest$inboundSchema: z.ZodType<
19
- ArticlesPreviewRequest,
20
- z.ZodTypeDef,
21
- unknown
22
- > = z.object({
23
- id: z.string(),
24
- ArticlePreview: components.ArticlePreview$inboundSchema,
25
- }).transform((v) => {
26
- return remap$(v, {
27
- "ArticlePreview": "articlePreview",
28
- });
29
- });
30
-
31
- /** @internal */
32
- export type ArticlesPreviewRequest$Outbound = {
33
- id: string;
34
- ArticlePreview: components.ArticlePreview$Outbound;
35
- };
36
-
37
- /** @internal */
38
- export const ArticlesPreviewRequest$outboundSchema: z.ZodType<
39
- ArticlesPreviewRequest$Outbound,
40
- z.ZodTypeDef,
41
- ArticlesPreviewRequest
42
- > = z.object({
43
- id: z.string(),
44
- articlePreview: components.ArticlePreview$outboundSchema,
45
- }).transform((v) => {
46
- return remap$(v, {
47
- articlePreview: "ArticlePreview",
48
- });
49
- });
50
-
51
- /**
52
- * @internal
53
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
54
- */
55
- export namespace ArticlesPreviewRequest$ {
56
- /** @deprecated use `ArticlesPreviewRequest$inboundSchema` instead. */
57
- export const inboundSchema = ArticlesPreviewRequest$inboundSchema;
58
- /** @deprecated use `ArticlesPreviewRequest$outboundSchema` instead. */
59
- export const outboundSchema = ArticlesPreviewRequest$outboundSchema;
60
- /** @deprecated use `ArticlesPreviewRequest$Outbound` instead. */
61
- export type Outbound = ArticlesPreviewRequest$Outbound;
62
- }
63
-
64
- export function articlesPreviewRequestToJSON(
65
- articlesPreviewRequest: ArticlesPreviewRequest,
66
- ): string {
67
- return JSON.stringify(
68
- ArticlesPreviewRequest$outboundSchema.parse(articlesPreviewRequest),
69
- );
70
- }
71
-
72
- export function articlesPreviewRequestFromJSON(
73
- jsonString: string,
74
- ): SafeParseResult<ArticlesPreviewRequest, SDKValidationError> {
75
- return safeParse(
76
- jsonString,
77
- (x) => ArticlesPreviewRequest$inboundSchema.parse(JSON.parse(x)),
78
- `Failed to parse 'ArticlesPreviewRequest' from JSON`,
79
- );
80
- }
@@ -1,66 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { safeParse } from "../../lib/schemas.js";
7
- import { Result as SafeParseResult } from "../../types/fp.js";
8
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
-
10
- export type ArticlesReceiversRequest = {
11
- id: string;
12
- };
13
-
14
- /** @internal */
15
- export const ArticlesReceiversRequest$inboundSchema: z.ZodType<
16
- ArticlesReceiversRequest,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
20
- id: z.string(),
21
- });
22
-
23
- /** @internal */
24
- export type ArticlesReceiversRequest$Outbound = {
25
- id: string;
26
- };
27
-
28
- /** @internal */
29
- export const ArticlesReceiversRequest$outboundSchema: z.ZodType<
30
- ArticlesReceiversRequest$Outbound,
31
- z.ZodTypeDef,
32
- ArticlesReceiversRequest
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 ArticlesReceiversRequest$ {
42
- /** @deprecated use `ArticlesReceiversRequest$inboundSchema` instead. */
43
- export const inboundSchema = ArticlesReceiversRequest$inboundSchema;
44
- /** @deprecated use `ArticlesReceiversRequest$outboundSchema` instead. */
45
- export const outboundSchema = ArticlesReceiversRequest$outboundSchema;
46
- /** @deprecated use `ArticlesReceiversRequest$Outbound` instead. */
47
- export type Outbound = ArticlesReceiversRequest$Outbound;
48
- }
49
-
50
- export function articlesReceiversRequestToJSON(
51
- articlesReceiversRequest: ArticlesReceiversRequest,
52
- ): string {
53
- return JSON.stringify(
54
- ArticlesReceiversRequest$outboundSchema.parse(articlesReceiversRequest),
55
- );
56
- }
57
-
58
- export function articlesReceiversRequestFromJSON(
59
- jsonString: string,
60
- ): SafeParseResult<ArticlesReceiversRequest, SDKValidationError> {
61
- return safeParse(
62
- jsonString,
63
- (x) => ArticlesReceiversRequest$inboundSchema.parse(JSON.parse(x)),
64
- `Failed to parse 'ArticlesReceiversRequest' from JSON`,
65
- );
66
- }
@@ -1,66 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { safeParse } from "../../lib/schemas.js";
7
- import { Result as SafeParseResult } from "../../types/fp.js";
8
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
-
10
- export type ArticlesSendRequest = {
11
- id: string;
12
- };
13
-
14
- /** @internal */
15
- export const ArticlesSendRequest$inboundSchema: z.ZodType<
16
- ArticlesSendRequest,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
20
- id: z.string(),
21
- });
22
-
23
- /** @internal */
24
- export type ArticlesSendRequest$Outbound = {
25
- id: string;
26
- };
27
-
28
- /** @internal */
29
- export const ArticlesSendRequest$outboundSchema: z.ZodType<
30
- ArticlesSendRequest$Outbound,
31
- z.ZodTypeDef,
32
- ArticlesSendRequest
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 ArticlesSendRequest$ {
42
- /** @deprecated use `ArticlesSendRequest$inboundSchema` instead. */
43
- export const inboundSchema = ArticlesSendRequest$inboundSchema;
44
- /** @deprecated use `ArticlesSendRequest$outboundSchema` instead. */
45
- export const outboundSchema = ArticlesSendRequest$outboundSchema;
46
- /** @deprecated use `ArticlesSendRequest$Outbound` instead. */
47
- export type Outbound = ArticlesSendRequest$Outbound;
48
- }
49
-
50
- export function articlesSendRequestToJSON(
51
- articlesSendRequest: ArticlesSendRequest,
52
- ): string {
53
- return JSON.stringify(
54
- ArticlesSendRequest$outboundSchema.parse(articlesSendRequest),
55
- );
56
- }
57
-
58
- export function articlesSendRequestFromJSON(
59
- jsonString: string,
60
- ): SafeParseResult<ArticlesSendRequest, SDKValidationError> {
61
- return safeParse(
62
- jsonString,
63
- (x) => ArticlesSendRequest$inboundSchema.parse(JSON.parse(x)),
64
- `Failed to parse 'ArticlesSendRequest' from JSON`,
65
- );
66
- }
@@ -1,80 +0,0 @@
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
- import { safeParse } from "../../lib/schemas.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import * as components from "../components/index.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export type ArticlesUpdateRequest = {
13
- id: string;
14
- articleUpdate: components.ArticleUpdate;
15
- };
16
-
17
- /** @internal */
18
- export const ArticlesUpdateRequest$inboundSchema: z.ZodType<
19
- ArticlesUpdateRequest,
20
- z.ZodTypeDef,
21
- unknown
22
- > = z.object({
23
- id: z.string(),
24
- ArticleUpdate: components.ArticleUpdate$inboundSchema,
25
- }).transform((v) => {
26
- return remap$(v, {
27
- "ArticleUpdate": "articleUpdate",
28
- });
29
- });
30
-
31
- /** @internal */
32
- export type ArticlesUpdateRequest$Outbound = {
33
- id: string;
34
- ArticleUpdate: components.ArticleUpdate$Outbound;
35
- };
36
-
37
- /** @internal */
38
- export const ArticlesUpdateRequest$outboundSchema: z.ZodType<
39
- ArticlesUpdateRequest$Outbound,
40
- z.ZodTypeDef,
41
- ArticlesUpdateRequest
42
- > = z.object({
43
- id: z.string(),
44
- articleUpdate: components.ArticleUpdate$outboundSchema,
45
- }).transform((v) => {
46
- return remap$(v, {
47
- articleUpdate: "ArticleUpdate",
48
- });
49
- });
50
-
51
- /**
52
- * @internal
53
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
54
- */
55
- export namespace ArticlesUpdateRequest$ {
56
- /** @deprecated use `ArticlesUpdateRequest$inboundSchema` instead. */
57
- export const inboundSchema = ArticlesUpdateRequest$inboundSchema;
58
- /** @deprecated use `ArticlesUpdateRequest$outboundSchema` instead. */
59
- export const outboundSchema = ArticlesUpdateRequest$outboundSchema;
60
- /** @deprecated use `ArticlesUpdateRequest$Outbound` instead. */
61
- export type Outbound = ArticlesUpdateRequest$Outbound;
62
- }
63
-
64
- export function articlesUpdateRequestToJSON(
65
- articlesUpdateRequest: ArticlesUpdateRequest,
66
- ): string {
67
- return JSON.stringify(
68
- ArticlesUpdateRequest$outboundSchema.parse(articlesUpdateRequest),
69
- );
70
- }
71
-
72
- export function articlesUpdateRequestFromJSON(
73
- jsonString: string,
74
- ): SafeParseResult<ArticlesUpdateRequest, SDKValidationError> {
75
- return safeParse(
76
- jsonString,
77
- (x) => ArticlesUpdateRequest$inboundSchema.parse(JSON.parse(x)),
78
- `Failed to parse 'ArticlesUpdateRequest' from JSON`,
79
- );
80
- }
@@ -1,173 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { articlesCreate } from "../funcs/articlesCreate.js";
6
- import { articlesDelete } from "../funcs/articlesDelete.js";
7
- import { articlesExport } from "../funcs/articlesExport.js";
8
- import { articlesGet } from "../funcs/articlesGet.js";
9
- import { articlesList } from "../funcs/articlesList.js";
10
- import { articlesPreview } from "../funcs/articlesPreview.js";
11
- import { articlesReceivers } from "../funcs/articlesReceivers.js";
12
- import { articlesSend } from "../funcs/articlesSend.js";
13
- import { articlesUpdate } from "../funcs/articlesUpdate.js";
14
- import { ClientSDK, RequestOptions } from "../lib/sdks.js";
15
- import * as components from "../models/components/index.js";
16
- import * as operations from "../models/operations/index.js";
17
- import { unwrapAsync } from "../types/fp.js";
18
- import { PageIterator, unwrapResultIterator } from "../types/operations.js";
19
-
20
- export class Articles extends ClientSDK {
21
- /**
22
- * List Articles
23
- *
24
- * @remarks
25
- * List articles.
26
- */
27
- async list(
28
- request: operations.ArticlesListRequest,
29
- options?: RequestOptions,
30
- ): Promise<PageIterator<operations.ArticlesListResponse, { page: number }>> {
31
- return unwrapResultIterator(articlesList(
32
- this,
33
- request,
34
- options,
35
- ));
36
- }
37
-
38
- /**
39
- * Create Article
40
- *
41
- * @remarks
42
- * Create an article.
43
- */
44
- async create(
45
- request: components.ArticleCreate,
46
- options?: RequestOptions,
47
- ): Promise<components.Article> {
48
- return unwrapAsync(articlesCreate(
49
- this,
50
- request,
51
- options,
52
- ));
53
- }
54
-
55
- /**
56
- * Export Articles
57
- *
58
- * @remarks
59
- * Export organization articles.
60
- */
61
- async export(
62
- request: operations.ArticlesExportRequest,
63
- options?: RequestOptions,
64
- ): Promise<any> {
65
- return unwrapAsync(articlesExport(
66
- this,
67
- request,
68
- options,
69
- ));
70
- }
71
-
72
- /**
73
- * Get Article
74
- *
75
- * @remarks
76
- * Get an article by ID.
77
- */
78
- async get(
79
- request: operations.ArticlesGetRequest,
80
- options?: RequestOptions,
81
- ): Promise<components.Article> {
82
- return unwrapAsync(articlesGet(
83
- this,
84
- request,
85
- options,
86
- ));
87
- }
88
-
89
- /**
90
- * Update Article
91
- *
92
- * @remarks
93
- * Update an article.
94
- */
95
- async update(
96
- request: operations.ArticlesUpdateRequest,
97
- options?: RequestOptions,
98
- ): Promise<components.Article> {
99
- return unwrapAsync(articlesUpdate(
100
- this,
101
- request,
102
- options,
103
- ));
104
- }
105
-
106
- /**
107
- * Delete Article
108
- *
109
- * @remarks
110
- * Delete an article.
111
- */
112
- async delete(
113
- request: operations.ArticlesDeleteRequest,
114
- options?: RequestOptions,
115
- ): Promise<void> {
116
- return unwrapAsync(articlesDelete(
117
- this,
118
- request,
119
- options,
120
- ));
121
- }
122
-
123
- /**
124
- * Get Article Receivers Count
125
- *
126
- * @remarks
127
- * Get number of potential receivers for an article.
128
- */
129
- async receivers(
130
- request: operations.ArticlesReceiversRequest,
131
- options?: RequestOptions,
132
- ): Promise<components.ArticleReceivers> {
133
- return unwrapAsync(articlesReceivers(
134
- this,
135
- request,
136
- options,
137
- ));
138
- }
139
-
140
- /**
141
- * Send Article Preview
142
- *
143
- * @remarks
144
- * Send an article preview by email.
145
- */
146
- async preview(
147
- request: operations.ArticlesPreviewRequest,
148
- options?: RequestOptions,
149
- ): Promise<any> {
150
- return unwrapAsync(articlesPreview(
151
- this,
152
- request,
153
- options,
154
- ));
155
- }
156
-
157
- /**
158
- * Send Article
159
- *
160
- * @remarks
161
- * Send an article by email to all subscribers.
162
- */
163
- async send(
164
- request: operations.ArticlesSendRequest,
165
- options?: RequestOptions,
166
- ): Promise<any> {
167
- return unwrapAsync(articlesSend(
168
- this,
169
- request,
170
- options,
171
- ));
172
- }
173
- }