@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
@@ -1,131 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { PolarCore } from "../core.js";
6
- import { encodeJSON } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { safeParse } from "../lib/schemas.js";
9
- import { RequestOptions } from "../lib/sdks.js";
10
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
- import { pathToFunc } from "../lib/url.js";
12
- import * as components from "../models/components/index.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import { Result } from "../types/fp.js";
24
-
25
- /**
26
- * Create Article
27
- *
28
- * @remarks
29
- * Create an article.
30
- */
31
- export async function articlesCreate(
32
- client: PolarCore,
33
- request: components.ArticleCreate,
34
- options?: RequestOptions,
35
- ): Promise<
36
- Result<
37
- components.Article,
38
- | errors.HTTPValidationError
39
- | SDKError
40
- | SDKValidationError
41
- | UnexpectedClientError
42
- | InvalidRequestError
43
- | RequestAbortedError
44
- | RequestTimeoutError
45
- | ConnectionError
46
- >
47
- > {
48
- const parsed = safeParse(
49
- request,
50
- (value) => components.ArticleCreate$outboundSchema.parse(value),
51
- "Input validation failed",
52
- );
53
- if (!parsed.ok) {
54
- return parsed;
55
- }
56
- const payload = parsed.value;
57
- const body = encodeJSON("body", payload, { explode: true });
58
-
59
- const path = pathToFunc("/v1/articles/")();
60
-
61
- const headers = new Headers({
62
- "Content-Type": "application/json",
63
- Accept: "application/json",
64
- });
65
-
66
- const secConfig = await extractSecurity(client._options.accessToken);
67
- const securityInput = secConfig == null ? {} : { accessToken: secConfig };
68
- const requestSecurity = resolveGlobalSecurity(securityInput);
69
-
70
- const context = {
71
- operationID: "articles:create",
72
- oAuth2Scopes: [],
73
-
74
- resolvedSecurity: requestSecurity,
75
-
76
- securitySource: client._options.accessToken,
77
- retryConfig: options?.retries
78
- || client._options.retryConfig
79
- || { strategy: "none" },
80
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
81
- };
82
-
83
- const requestRes = client._createRequest(context, {
84
- security: requestSecurity,
85
- method: "POST",
86
- path: path,
87
- headers: headers,
88
- body: body,
89
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
90
- }, options);
91
- if (!requestRes.ok) {
92
- return requestRes;
93
- }
94
- const req = requestRes.value;
95
-
96
- const doResult = await client._do(req, {
97
- context,
98
- errorCodes: ["422", "4XX", "5XX"],
99
- retryConfig: context.retryConfig,
100
- retryCodes: context.retryCodes,
101
- });
102
- if (!doResult.ok) {
103
- return doResult;
104
- }
105
- const response = doResult.value;
106
-
107
- const responseFields = {
108
- HttpMeta: { Response: response, Request: req },
109
- };
110
-
111
- const [result] = await M.match<
112
- components.Article,
113
- | errors.HTTPValidationError
114
- | SDKError
115
- | SDKValidationError
116
- | UnexpectedClientError
117
- | InvalidRequestError
118
- | RequestAbortedError
119
- | RequestTimeoutError
120
- | ConnectionError
121
- >(
122
- M.json(201, components.Article$inboundSchema),
123
- M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
124
- M.fail(["4XX", "5XX"]),
125
- )(response, { extraFields: responseFields });
126
- if (!result.ok) {
127
- return result;
128
- }
129
-
130
- return result;
131
- }
@@ -1,144 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { PolarCore } from "../core.js";
7
- import { encodeSimple } from "../lib/encodings.js";
8
- import * as M from "../lib/matchers.js";
9
- import { safeParse } from "../lib/schemas.js";
10
- import { RequestOptions } from "../lib/sdks.js";
11
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
- import { pathToFunc } from "../lib/url.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Delete Article
28
- *
29
- * @remarks
30
- * Delete an article.
31
- */
32
- export async function articlesDelete(
33
- client: PolarCore,
34
- request: operations.ArticlesDeleteRequest,
35
- options?: RequestOptions,
36
- ): Promise<
37
- Result<
38
- void,
39
- | errors.NotPermitted
40
- | errors.ResourceNotFound
41
- | errors.HTTPValidationError
42
- | SDKError
43
- | SDKValidationError
44
- | UnexpectedClientError
45
- | InvalidRequestError
46
- | RequestAbortedError
47
- | RequestTimeoutError
48
- | ConnectionError
49
- >
50
- > {
51
- const parsed = safeParse(
52
- request,
53
- (value) => operations.ArticlesDeleteRequest$outboundSchema.parse(value),
54
- "Input validation failed",
55
- );
56
- if (!parsed.ok) {
57
- return parsed;
58
- }
59
- const payload = parsed.value;
60
- const body = null;
61
-
62
- const pathParams = {
63
- id: encodeSimple("id", payload.id, {
64
- explode: false,
65
- charEncoding: "percent",
66
- }),
67
- };
68
-
69
- const path = pathToFunc("/v1/articles/{id}")(pathParams);
70
-
71
- const headers = new Headers({
72
- Accept: "application/json",
73
- });
74
-
75
- const secConfig = await extractSecurity(client._options.accessToken);
76
- const securityInput = secConfig == null ? {} : { accessToken: secConfig };
77
- const requestSecurity = resolveGlobalSecurity(securityInput);
78
-
79
- const context = {
80
- operationID: "articles:delete",
81
- oAuth2Scopes: [],
82
-
83
- resolvedSecurity: requestSecurity,
84
-
85
- securitySource: client._options.accessToken,
86
- retryConfig: options?.retries
87
- || client._options.retryConfig
88
- || { strategy: "none" },
89
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
90
- };
91
-
92
- const requestRes = client._createRequest(context, {
93
- security: requestSecurity,
94
- method: "DELETE",
95
- path: path,
96
- headers: headers,
97
- body: body,
98
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
99
- }, options);
100
- if (!requestRes.ok) {
101
- return requestRes;
102
- }
103
- const req = requestRes.value;
104
-
105
- const doResult = await client._do(req, {
106
- context,
107
- errorCodes: ["403", "404", "422", "4XX", "5XX"],
108
- retryConfig: context.retryConfig,
109
- retryCodes: context.retryCodes,
110
- });
111
- if (!doResult.ok) {
112
- return doResult;
113
- }
114
- const response = doResult.value;
115
-
116
- const responseFields = {
117
- HttpMeta: { Response: response, Request: req },
118
- };
119
-
120
- const [result] = await M.match<
121
- void,
122
- | errors.NotPermitted
123
- | errors.ResourceNotFound
124
- | errors.HTTPValidationError
125
- | SDKError
126
- | SDKValidationError
127
- | UnexpectedClientError
128
- | InvalidRequestError
129
- | RequestAbortedError
130
- | RequestTimeoutError
131
- | ConnectionError
132
- >(
133
- M.nil(204, z.void()),
134
- M.jsonErr(403, errors.NotPermitted$inboundSchema),
135
- M.jsonErr(404, errors.ResourceNotFound$inboundSchema),
136
- M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
137
- M.fail(["4XX", "5XX"]),
138
- )(response, { extraFields: responseFields });
139
- if (!result.ok) {
140
- return result;
141
- }
142
-
143
- return result;
144
- }
@@ -1,136 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { PolarCore } from "../core.js";
7
- import { encodeFormQuery } from "../lib/encodings.js";
8
- import * as M from "../lib/matchers.js";
9
- import { safeParse } from "../lib/schemas.js";
10
- import { RequestOptions } from "../lib/sdks.js";
11
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
- import { pathToFunc } from "../lib/url.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Export Articles
28
- *
29
- * @remarks
30
- * Export organization articles.
31
- */
32
- export async function articlesExport(
33
- client: PolarCore,
34
- request: operations.ArticlesExportRequest,
35
- options?: RequestOptions,
36
- ): Promise<
37
- Result<
38
- any,
39
- | errors.HTTPValidationError
40
- | SDKError
41
- | SDKValidationError
42
- | UnexpectedClientError
43
- | InvalidRequestError
44
- | RequestAbortedError
45
- | RequestTimeoutError
46
- | ConnectionError
47
- >
48
- > {
49
- const parsed = safeParse(
50
- request,
51
- (value) => operations.ArticlesExportRequest$outboundSchema.parse(value),
52
- "Input validation failed",
53
- );
54
- if (!parsed.ok) {
55
- return parsed;
56
- }
57
- const payload = parsed.value;
58
- const body = null;
59
-
60
- const path = pathToFunc("/v1/articles/export")();
61
-
62
- const query = encodeFormQuery({
63
- "organization_id": payload.organization_id,
64
- });
65
-
66
- const headers = new Headers({
67
- Accept: "application/json",
68
- });
69
-
70
- const secConfig = await extractSecurity(client._options.accessToken);
71
- const securityInput = secConfig == null ? {} : { accessToken: secConfig };
72
- const requestSecurity = resolveGlobalSecurity(securityInput);
73
-
74
- const context = {
75
- operationID: "articles:export",
76
- oAuth2Scopes: [],
77
-
78
- resolvedSecurity: requestSecurity,
79
-
80
- securitySource: client._options.accessToken,
81
- retryConfig: options?.retries
82
- || client._options.retryConfig
83
- || { strategy: "none" },
84
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
85
- };
86
-
87
- const requestRes = client._createRequest(context, {
88
- security: requestSecurity,
89
- method: "GET",
90
- path: path,
91
- headers: headers,
92
- query: query,
93
- body: body,
94
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
95
- }, options);
96
- if (!requestRes.ok) {
97
- return requestRes;
98
- }
99
- const req = requestRes.value;
100
-
101
- const doResult = await client._do(req, {
102
- context,
103
- errorCodes: ["422", "4XX", "5XX"],
104
- retryConfig: context.retryConfig,
105
- retryCodes: context.retryCodes,
106
- });
107
- if (!doResult.ok) {
108
- return doResult;
109
- }
110
- const response = doResult.value;
111
-
112
- const responseFields = {
113
- HttpMeta: { Response: response, Request: req },
114
- };
115
-
116
- const [result] = await M.match<
117
- any,
118
- | errors.HTTPValidationError
119
- | SDKError
120
- | SDKValidationError
121
- | UnexpectedClientError
122
- | InvalidRequestError
123
- | RequestAbortedError
124
- | RequestTimeoutError
125
- | ConnectionError
126
- >(
127
- M.json(200, z.any()),
128
- M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
129
- M.fail(["4XX", "5XX"]),
130
- )(response, { extraFields: responseFields });
131
- if (!result.ok) {
132
- return result;
133
- }
134
-
135
- return result;
136
- }
@@ -1,141 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { PolarCore } from "../core.js";
6
- import { encodeSimple } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { safeParse } from "../lib/schemas.js";
9
- import { RequestOptions } from "../lib/sdks.js";
10
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
- import { pathToFunc } from "../lib/url.js";
12
- import * as components from "../models/components/index.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Get Article
28
- *
29
- * @remarks
30
- * Get an article by ID.
31
- */
32
- export async function articlesGet(
33
- client: PolarCore,
34
- request: operations.ArticlesGetRequest,
35
- options?: RequestOptions,
36
- ): Promise<
37
- Result<
38
- components.Article,
39
- | errors.ResourceNotFound
40
- | errors.HTTPValidationError
41
- | SDKError
42
- | SDKValidationError
43
- | UnexpectedClientError
44
- | InvalidRequestError
45
- | RequestAbortedError
46
- | RequestTimeoutError
47
- | ConnectionError
48
- >
49
- > {
50
- const parsed = safeParse(
51
- request,
52
- (value) => operations.ArticlesGetRequest$outboundSchema.parse(value),
53
- "Input validation failed",
54
- );
55
- if (!parsed.ok) {
56
- return parsed;
57
- }
58
- const payload = parsed.value;
59
- const body = null;
60
-
61
- const pathParams = {
62
- id: encodeSimple("id", payload.id, {
63
- explode: false,
64
- charEncoding: "percent",
65
- }),
66
- };
67
-
68
- const path = pathToFunc("/v1/articles/{id}")(pathParams);
69
-
70
- const headers = new Headers({
71
- Accept: "application/json",
72
- });
73
-
74
- const secConfig = await extractSecurity(client._options.accessToken);
75
- const securityInput = secConfig == null ? {} : { accessToken: secConfig };
76
- const requestSecurity = resolveGlobalSecurity(securityInput);
77
-
78
- const context = {
79
- operationID: "articles:get",
80
- oAuth2Scopes: [],
81
-
82
- resolvedSecurity: requestSecurity,
83
-
84
- securitySource: client._options.accessToken,
85
- retryConfig: options?.retries
86
- || client._options.retryConfig
87
- || { strategy: "none" },
88
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
89
- };
90
-
91
- const requestRes = client._createRequest(context, {
92
- security: requestSecurity,
93
- method: "GET",
94
- path: path,
95
- headers: headers,
96
- body: body,
97
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
98
- }, options);
99
- if (!requestRes.ok) {
100
- return requestRes;
101
- }
102
- const req = requestRes.value;
103
-
104
- const doResult = await client._do(req, {
105
- context,
106
- errorCodes: ["404", "422", "4XX", "5XX"],
107
- retryConfig: context.retryConfig,
108
- retryCodes: context.retryCodes,
109
- });
110
- if (!doResult.ok) {
111
- return doResult;
112
- }
113
- const response = doResult.value;
114
-
115
- const responseFields = {
116
- HttpMeta: { Response: response, Request: req },
117
- };
118
-
119
- const [result] = await M.match<
120
- components.Article,
121
- | errors.ResourceNotFound
122
- | errors.HTTPValidationError
123
- | SDKError
124
- | SDKValidationError
125
- | UnexpectedClientError
126
- | InvalidRequestError
127
- | RequestAbortedError
128
- | RequestTimeoutError
129
- | ConnectionError
130
- >(
131
- M.json(200, components.Article$inboundSchema),
132
- M.jsonErr(404, errors.ResourceNotFound$inboundSchema),
133
- M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
134
- M.fail(["4XX", "5XX"]),
135
- )(response, { extraFields: responseFields });
136
- if (!result.ok) {
137
- return result;
138
- }
139
-
140
- return result;
141
- }