@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.
- package/FUNCTIONS.md +106 -0
- package/README.md +181 -30
- package/RUNTIMES.md +22 -0
- package/docs/sdks/checkouts/README.md +1 -1
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +18 -0
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +3 -0
- package/hooks/types.d.ts.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/models/components/benefit.d.ts +2 -3
- package/models/components/benefit.d.ts.map +1 -1
- package/models/components/benefit.js +0 -3
- package/models/components/benefit.js.map +1 -1
- package/models/components/benefitadssubscriber.d.ts +7 -7
- package/models/components/benefitadssubscriber.d.ts.map +1 -1
- package/models/components/benefitadssubscriber.js +11 -11
- package/models/components/benefitadssubscriber.js.map +1 -1
- package/models/components/benefitgrant.d.ts +4 -5
- package/models/components/benefitgrant.d.ts.map +1 -1
- package/models/components/benefitgrant.js +0 -5
- package/models/components/benefitgrant.js.map +1 -1
- package/models/components/benefitgrantwebhook.d.ts +8 -9
- package/models/components/benefitgrantwebhook.d.ts.map +1 -1
- package/models/components/benefitgrantwebhook.js +0 -9
- package/models/components/benefitgrantwebhook.js.map +1 -1
- package/models/components/benefittype.d.ts +0 -3
- package/models/components/benefittype.d.ts.map +1 -1
- package/models/components/benefittype.js +0 -1
- package/models/components/benefittype.js.map +1 -1
- package/models/components/checkoutlinkproduct.d.ts +2 -24
- package/models/components/checkoutlinkproduct.d.ts.map +1 -1
- package/models/components/checkoutlinkproduct.js +3 -27
- package/models/components/checkoutlinkproduct.js.map +1 -1
- package/models/components/checkoutproduct.d.ts +2 -24
- package/models/components/checkoutproduct.d.ts.map +1 -1
- package/models/components/checkoutproduct.js +3 -27
- package/models/components/checkoutproduct.js.map +1 -1
- package/models/components/index.d.ts +0 -15
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +0 -15
- package/models/components/index.js.map +1 -1
- package/models/components/listresourceuserbenefit.d.ts +0 -9
- package/models/components/listresourceuserbenefit.d.ts.map +1 -1
- package/models/components/listresourceuserbenefit.js +0 -13
- package/models/components/listresourceuserbenefit.js.map +1 -1
- package/models/components/oauth2client.js +2 -2
- package/models/components/oauth2client.js.map +1 -1
- package/models/components/oauth2clientconfiguration.js +2 -2
- package/models/components/oauth2clientconfiguration.js.map +1 -1
- package/models/components/oauth2clientconfigurationupdate.js +2 -2
- package/models/components/oauth2clientconfigurationupdate.js.map +1 -1
- package/models/components/organizationfeaturesettings.d.ts +0 -5
- package/models/components/organizationfeaturesettings.d.ts.map +1 -1
- package/models/components/organizationfeaturesettings.js +0 -4
- package/models/components/organizationfeaturesettings.js.map +1 -1
- package/models/components/scope.d.ts +0 -6
- package/models/components/scope.d.ts.map +1 -1
- package/models/components/scope.js +0 -2
- package/models/components/scope.js.map +1 -1
- package/models/components/userorderproduct.d.ts +2 -24
- package/models/components/userorderproduct.d.ts.map +1 -1
- package/models/components/userorderproduct.js +3 -27
- package/models/components/userorderproduct.js.map +1 -1
- package/models/components/usersubscriptionproduct.d.ts +2 -24
- package/models/components/usersubscriptionproduct.d.ts.map +1 -1
- package/models/components/usersubscriptionproduct.js +3 -27
- package/models/components/usersubscriptionproduct.js.map +1 -1
- package/models/operations/benefitsupdate.d.ts +4 -4
- package/models/operations/benefitsupdate.d.ts.map +1 -1
- package/models/operations/benefitsupdate.js +0 -4
- package/models/operations/benefitsupdate.js.map +1 -1
- package/models/operations/index.d.ts +0 -8
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -8
- package/models/operations/index.js.map +1 -1
- package/models/operations/usersbenefitsget.d.ts +2 -6
- package/models/operations/usersbenefitsget.d.ts.map +1 -1
- package/models/operations/usersbenefitsget.js +0 -6
- package/models/operations/usersbenefitsget.js.map +1 -1
- package/package.json +1 -3
- package/sdk/sdk.d.ts +0 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -5
- package/sdk/sdk.js.map +1 -1
- package/src/hooks/hooks.ts +20 -0
- package/src/hooks/types.ts +9 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/benefit.ts +0 -10
- package/src/models/components/benefitadssubscriber.ts +12 -15
- package/src/models/components/benefitgrant.ts +0 -14
- package/src/models/components/benefitgrantwebhook.ts +0 -22
- package/src/models/components/benefittype.ts +0 -1
- package/src/models/components/checkoutlinkproduct.ts +4 -68
- package/src/models/components/checkoutproduct.ts +4 -66
- package/src/models/components/index.ts +0 -15
- package/src/models/components/listresourceuserbenefit.ts +0 -30
- package/src/models/components/oauth2client.ts +2 -2
- package/src/models/components/oauth2clientconfiguration.ts +2 -2
- package/src/models/components/oauth2clientconfigurationupdate.ts +2 -2
- package/src/models/components/organizationfeaturesettings.ts +0 -9
- package/src/models/components/scope.ts +0 -2
- package/src/models/components/userorderproduct.ts +4 -60
- package/src/models/components/usersubscriptionproduct.ts +4 -68
- package/src/models/operations/benefitsupdate.ts +0 -8
- package/src/models/operations/index.ts +0 -8
- package/src/models/operations/usersbenefitsget.ts +0 -12
- package/src/sdk/sdk.ts +0 -6
- package/src/types/index.ts +1 -0
- package/src/types/webhooks.ts +7 -0
- package/types/index.d.ts +1 -0
- package/types/index.d.ts.map +1 -1
- package/types/webhooks.d.ts +4 -0
- package/types/webhooks.d.ts.map +1 -0
- package/types/webhooks.js +6 -0
- package/types/webhooks.js.map +1 -0
- package/docs/sdks/articles/README.md +0 -724
- package/funcs/articlesCreate.d.ts +0 -16
- package/funcs/articlesCreate.d.ts.map +0 -1
- package/funcs/articlesCreate.js +0 -99
- package/funcs/articlesCreate.js.map +0 -1
- package/funcs/articlesDelete.d.ts +0 -16
- package/funcs/articlesDelete.d.ts.map +0 -1
- package/funcs/articlesDelete.js +0 -105
- package/funcs/articlesDelete.js.map +0 -1
- package/funcs/articlesExport.d.ts +0 -16
- package/funcs/articlesExport.d.ts.map +0 -1
- package/funcs/articlesExport.js +0 -103
- package/funcs/articlesExport.js.map +0 -1
- package/funcs/articlesGet.d.ts +0 -17
- package/funcs/articlesGet.d.ts.map +0 -1
- package/funcs/articlesGet.js +0 -105
- package/funcs/articlesGet.js.map +0 -1
- package/funcs/articlesList.d.ts +0 -19
- package/funcs/articlesList.d.ts.map +0 -1
- package/funcs/articlesList.js +0 -138
- package/funcs/articlesList.js.map +0 -1
- package/funcs/articlesPreview.d.ts +0 -16
- package/funcs/articlesPreview.d.ts.map +0 -1
- package/funcs/articlesPreview.js +0 -106
- package/funcs/articlesPreview.js.map +0 -1
- package/funcs/articlesReceivers.d.ts +0 -17
- package/funcs/articlesReceivers.d.ts.map +0 -1
- package/funcs/articlesReceivers.js +0 -105
- package/funcs/articlesReceivers.js.map +0 -1
- package/funcs/articlesSend.d.ts +0 -16
- package/funcs/articlesSend.d.ts.map +0 -1
- package/funcs/articlesSend.js +0 -105
- package/funcs/articlesSend.js.map +0 -1
- package/funcs/articlesUpdate.d.ts +0 -17
- package/funcs/articlesUpdate.d.ts.map +0 -1
- package/funcs/articlesUpdate.js +0 -106
- package/funcs/articlesUpdate.js.map +0 -1
- package/models/components/article.d.ts +0 -68
- package/models/components/article.d.ts.map +0 -1
- package/models/components/article.js +0 -129
- package/models/components/article.js.map +0 -1
- package/models/components/articlebyline.d.ts +0 -28
- package/models/components/articlebyline.d.ts.map +0 -1
- package/models/components/articlebyline.js +0 -50
- package/models/components/articlebyline.js.map +0 -1
- package/models/components/articlecreate.d.ts +0 -93
- package/models/components/articlecreate.d.ts.map +0 -1
- package/models/components/articlecreate.js +0 -112
- package/models/components/articlecreate.js.map +0 -1
- package/models/components/articlepreview.d.ts +0 -32
- package/models/components/articlepreview.d.ts.map +0 -1
- package/models/components/articlepreview.js +0 -59
- package/models/components/articlepreview.js.map +0 -1
- package/models/components/articlereceivers.d.ts +0 -33
- package/models/components/articlereceivers.d.ts.map +0 -1
- package/models/components/articlereceivers.js +0 -76
- package/models/components/articlereceivers.js.map +0 -1
- package/models/components/articleupdate.d.ts +0 -85
- package/models/components/articleupdate.d.ts.map +0 -1
- package/models/components/articleupdate.js +0 -108
- package/models/components/articleupdate.js.map +0 -1
- package/models/components/articlevisibility.d.ts +0 -31
- package/models/components/articlevisibility.d.ts.map +0 -1
- package/models/components/articlevisibility.js +0 -51
- package/models/components/articlevisibility.js.map +0 -1
- package/models/components/benefitarticles.d.ts +0 -100
- package/models/components/benefitarticles.d.ts.map +0 -1
- package/models/components/benefitarticles.js +0 -107
- package/models/components/benefitarticles.js.map +0 -1
- package/models/components/benefitarticlesproperties.d.ts +0 -35
- package/models/components/benefitarticlesproperties.d.ts.map +0 -1
- package/models/components/benefitarticlesproperties.js +0 -68
- package/models/components/benefitarticlesproperties.js.map +0 -1
- package/models/components/benefitarticlessubscriber.d.ts +0 -99
- package/models/components/benefitarticlessubscriber.d.ts.map +0 -1
- package/models/components/benefitarticlessubscriber.js +0 -113
- package/models/components/benefitarticlessubscriber.js.map +0 -1
- package/models/components/benefitarticlessubscriberproperties.d.ts +0 -35
- package/models/components/benefitarticlessubscriberproperties.d.ts.map +0 -1
- package/models/components/benefitarticlessubscriberproperties.js +0 -68
- package/models/components/benefitarticlessubscriberproperties.js.map +0 -1
- package/models/components/benefitarticlesupdate.d.ts +0 -57
- package/models/components/benefitarticlesupdate.d.ts.map +0 -1
- package/models/components/benefitarticlesupdate.js +0 -79
- package/models/components/benefitarticlesupdate.js.map +0 -1
- package/models/components/benefitgrantarticlesproperties.d.ts +0 -25
- package/models/components/benefitgrantarticlesproperties.d.ts.map +0 -1
- package/models/components/benefitgrantarticlesproperties.js +0 -55
- package/models/components/benefitgrantarticlesproperties.js.map +0 -1
- package/models/components/bylineprofile.d.ts +0 -31
- package/models/components/bylineprofile.d.ts.map +0 -1
- package/models/components/bylineprofile.js +0 -70
- package/models/components/bylineprofile.js.map +0 -1
- package/models/components/listresourcearticle.d.ts +0 -33
- package/models/components/listresourcearticle.d.ts.map +0 -1
- package/models/components/listresourcearticle.js +0 -63
- package/models/components/listresourcearticle.js.map +0 -1
- package/models/operations/articlesdelete.d.ts +0 -29
- package/models/operations/articlesdelete.d.ts.map +0 -1
- package/models/operations/articlesdelete.js +0 -59
- package/models/operations/articlesdelete.js.map +0 -1
- package/models/operations/articlesexport.d.ts +0 -29
- package/models/operations/articlesexport.d.ts.map +0 -1
- package/models/operations/articlesexport.js +0 -68
- package/models/operations/articlesexport.js.map +0 -1
- package/models/operations/articlesget.d.ts +0 -29
- package/models/operations/articlesget.d.ts.map +0 -1
- package/models/operations/articlesget.js +0 -59
- package/models/operations/articlesget.js.map +0 -1
- package/models/operations/articleslist.d.ts +0 -141
- package/models/operations/articleslist.d.ts.map +0 -1
- package/models/operations/articleslist.js +0 -184
- package/models/operations/articleslist.js.map +0 -1
- package/models/operations/articlespreview.d.ts +0 -32
- package/models/operations/articlespreview.d.ts.map +0 -1
- package/models/operations/articlespreview.js +0 -71
- package/models/operations/articlespreview.js.map +0 -1
- package/models/operations/articlesreceivers.d.ts +0 -29
- package/models/operations/articlesreceivers.d.ts.map +0 -1
- package/models/operations/articlesreceivers.js +0 -59
- package/models/operations/articlesreceivers.js.map +0 -1
- package/models/operations/articlessend.d.ts +0 -29
- package/models/operations/articlessend.d.ts.map +0 -1
- package/models/operations/articlessend.js +0 -59
- package/models/operations/articlessend.js.map +0 -1
- package/models/operations/articlesupdate.d.ts +0 -32
- package/models/operations/articlesupdate.d.ts.map +0 -1
- package/models/operations/articlesupdate.js +0 -71
- package/models/operations/articlesupdate.js.map +0 -1
- package/sdk/articles.d.ts +0 -72
- package/sdk/articles.d.ts.map +0 -1
- package/sdk/articles.js +0 -103
- package/sdk/articles.js.map +0 -1
- package/src/funcs/articlesCreate.ts +0 -131
- package/src/funcs/articlesDelete.ts +0 -144
- package/src/funcs/articlesExport.ts +0 -136
- package/src/funcs/articlesGet.ts +0 -141
- package/src/funcs/articlesList.ts +0 -205
- package/src/funcs/articlesPreview.ts +0 -145
- package/src/funcs/articlesReceivers.ts +0 -138
- package/src/funcs/articlesSend.ts +0 -144
- package/src/funcs/articlesUpdate.ts +0 -145
- package/src/models/components/article.ts +0 -187
- package/src/models/components/articlebyline.ts +0 -33
- package/src/models/components/articlecreate.ts +0 -191
- package/src/models/components/articlepreview.ts +0 -65
- package/src/models/components/articlereceivers.ts +0 -87
- package/src/models/components/articleupdate.ts +0 -179
- package/src/models/components/articlevisibility.ts +0 -34
- package/src/models/components/benefitarticles.ts +0 -175
- package/src/models/components/benefitarticlesproperties.ts +0 -81
- package/src/models/components/benefitarticlessubscriber.ts +0 -189
- package/src/models/components/benefitarticlessubscriberproperties.ts +0 -86
- package/src/models/components/benefitarticlesupdate.ts +0 -102
- package/src/models/components/benefitgrantarticlesproperties.ts +0 -60
- package/src/models/components/bylineprofile.ts +0 -75
- package/src/models/components/listresourcearticle.ts +0 -82
- package/src/models/operations/articlesdelete.ts +0 -66
- package/src/models/operations/articlesexport.ts +0 -75
- package/src/models/operations/articlesget.ts +0 -66
- package/src/models/operations/articleslist.ts +0 -342
- package/src/models/operations/articlespreview.ts +0 -80
- package/src/models/operations/articlesreceivers.ts +0 -66
- package/src/models/operations/articlessend.ts +0 -66
- package/src/models/operations/articlesupdate.ts +0 -80
- 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
|
-
}
|
package/src/sdk/articles.ts
DELETED
|
@@ -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
|
-
}
|