@wix/auto_sdk_blog_draft-posts 1.0.98 → 1.0.100
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/build/cjs/index.js +13 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +272 -272
- package/build/cjs/index.typings.js +13 -13
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +274 -274
- package/build/cjs/meta.js +13 -13
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +1331 -1316
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs +13 -13
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +272 -272
- package/build/es/index.typings.mjs +13 -13
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +274 -274
- package/build/es/meta.mjs +13 -13
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +1331 -1316
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +301 -301
- package/build/internal/cjs/meta.d.ts +321 -321
- package/build/internal/es/index.typings.d.mts +301 -301
- package/build/internal/es/meta.d.mts +321 -321
- package/package.json +2 -2
- package/build/internal/cjs/index.js +0 -5392
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -4756
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -4159
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/schemas.js +0 -2886
- package/build/internal/cjs/schemas.js.map +0 -1
- package/build/internal/es/index.mjs +0 -5278
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -4644
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -4046
- package/build/internal/es/meta.mjs.map +0 -1
- package/build/internal/es/schemas.mjs +0 -2822
- package/build/internal/es/schemas.mjs.map +0 -1
package/build/es/schemas.mjs
CHANGED
|
@@ -1,40 +1,40 @@
|
|
|
1
1
|
// src/blog-v3-draft-draft-posts.schemas.ts
|
|
2
2
|
import * as z from "zod";
|
|
3
3
|
var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
4
|
-
draftPost: z.object({
|
|
5
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
6
|
-
title: z.string().describe("Draft post title.").max(200),
|
|
7
|
-
excerpt: z.string().describe(
|
|
4
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
5
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
6
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200),
|
|
7
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
8
8
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
9
9
|
).max(500).optional().nullable(),
|
|
10
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
11
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
12
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
10
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
11
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
12
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
13
13
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
14
14
|
"Must be a valid GUID"
|
|
15
15
|
).optional().nullable(),
|
|
16
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
17
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
18
|
-
minutesToRead: z.number().int().describe(
|
|
16
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
17
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
18
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
19
19
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
20
20
|
).optional(),
|
|
21
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
22
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
23
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
24
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
25
|
-
translationId: z.string().describe(
|
|
21
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
22
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
23
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
24
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
25
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
26
26
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
27
27
|
).regex(
|
|
28
28
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
29
29
|
"Must be a valid GUID"
|
|
30
30
|
).optional().nullable(),
|
|
31
|
-
language: z.string().describe(
|
|
31
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
32
32
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
33
33
|
).optional().nullable(),
|
|
34
|
-
richContent: z.any().describe(
|
|
34
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
35
35
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
36
36
|
).optional(),
|
|
37
|
-
status: z.enum([
|
|
37
|
+
status: /* @__PURE__ */ z.enum([
|
|
38
38
|
"UNKNOWN",
|
|
39
39
|
"PUBLISHED",
|
|
40
40
|
"UNPUBLISHED",
|
|
@@ -42,123 +42,123 @@ var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
42
42
|
"DELETED",
|
|
43
43
|
"IN_REVIEW"
|
|
44
44
|
]).optional(),
|
|
45
|
-
moderationDetails: z.object({
|
|
46
|
-
submittedBy: z.string().describe(
|
|
45
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
46
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
47
47
|
"Member ID of the person submitting the draft post for review."
|
|
48
48
|
).regex(
|
|
49
49
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
50
50
|
"Must be a valid GUID"
|
|
51
51
|
).optional(),
|
|
52
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
53
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
54
|
-
moderatedBy: z.string().describe(
|
|
52
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
53
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
54
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
55
55
|
"Member ID of the person who approved or rejected the post."
|
|
56
56
|
).regex(
|
|
57
57
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
58
58
|
"Must be a valid GUID"
|
|
59
59
|
).optional().nullable(),
|
|
60
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
60
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
61
61
|
}).describe(
|
|
62
62
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
63
63
|
).optional(),
|
|
64
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
64
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
65
65
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
66
66
|
).optional(),
|
|
67
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
68
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
69
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
70
|
-
seoData: z.object({
|
|
71
|
-
tags: z.array(
|
|
72
|
-
z.object({
|
|
73
|
-
type: z.string().describe(
|
|
67
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
68
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
69
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
70
|
+
seoData: /* @__PURE__ */ z.object({
|
|
71
|
+
tags: /* @__PURE__ */ z.array(
|
|
72
|
+
/* @__PURE__ */ z.object({
|
|
73
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
74
74
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
75
75
|
).optional(),
|
|
76
|
-
props: z.record(z.string(), z.any()).describe(
|
|
76
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
77
77
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
78
78
|
).optional().nullable(),
|
|
79
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
79
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
80
80
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
81
81
|
).optional().nullable(),
|
|
82
|
-
children: z.string().describe(
|
|
82
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
83
83
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
84
84
|
).optional(),
|
|
85
|
-
custom: z.boolean().describe(
|
|
85
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
86
86
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
87
87
|
).optional(),
|
|
88
|
-
disabled: z.boolean().describe(
|
|
88
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
89
89
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
90
90
|
).optional()
|
|
91
91
|
})
|
|
92
92
|
).optional(),
|
|
93
|
-
settings: z.object({
|
|
94
|
-
preventAutoRedirect: z.boolean().describe(
|
|
93
|
+
settings: /* @__PURE__ */ z.object({
|
|
94
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
95
95
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
96
96
|
).optional(),
|
|
97
|
-
keywords: z.array(
|
|
98
|
-
z.object({
|
|
99
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
100
|
-
isMain: z.boolean().describe(
|
|
97
|
+
keywords: /* @__PURE__ */ z.array(
|
|
98
|
+
/* @__PURE__ */ z.object({
|
|
99
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
100
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
101
101
|
"Whether the keyword is the main focus keyword."
|
|
102
102
|
).optional(),
|
|
103
|
-
origin: z.string().describe(
|
|
103
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
104
104
|
"The source that added the keyword terms to the SEO settings."
|
|
105
105
|
).max(1e3).optional().nullable()
|
|
106
106
|
})
|
|
107
107
|
).max(5).optional()
|
|
108
108
|
}).describe("SEO general settings.").optional()
|
|
109
109
|
}).describe("SEO data.").optional(),
|
|
110
|
-
url: z.string().describe(
|
|
110
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
111
111
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
112
112
|
).optional(),
|
|
113
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
114
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
115
|
-
media: z.intersection(
|
|
116
|
-
z.object({
|
|
117
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
118
|
-
custom: z.boolean().describe(
|
|
113
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
114
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
115
|
+
media: /* @__PURE__ */ z.intersection(
|
|
116
|
+
/* @__PURE__ */ z.object({
|
|
117
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
118
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
119
119
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
120
120
|
).optional(),
|
|
121
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
121
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
122
122
|
}),
|
|
123
|
-
z.xor([
|
|
124
|
-
z.object({
|
|
125
|
-
wixMedia: z.never().optional(),
|
|
126
|
-
embedMedia: z.never().optional()
|
|
123
|
+
/* @__PURE__ */ z.xor([
|
|
124
|
+
/* @__PURE__ */ z.object({
|
|
125
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
126
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
127
127
|
}),
|
|
128
|
-
z.object({
|
|
129
|
-
embedMedia: z.never().optional(),
|
|
130
|
-
wixMedia: z.object({
|
|
131
|
-
image: z.string().describe("Image details.").optional(),
|
|
132
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
128
|
+
/* @__PURE__ */ z.object({
|
|
129
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
130
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
131
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
132
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
133
133
|
}).describe("Wix Media details.")
|
|
134
134
|
}),
|
|
135
|
-
z.object({
|
|
136
|
-
wixMedia: z.never().optional(),
|
|
137
|
-
embedMedia: z.object({
|
|
138
|
-
thumbnail: z.object({
|
|
139
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
140
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
141
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
135
|
+
/* @__PURE__ */ z.object({
|
|
136
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
137
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
138
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
139
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
140
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
141
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
142
142
|
}).describe("Thumbnail details.").optional(),
|
|
143
|
-
video: z.object({
|
|
144
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
145
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
146
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
143
|
+
video: /* @__PURE__ */ z.object({
|
|
144
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
145
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
146
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
147
147
|
}).describe("Video details.").optional()
|
|
148
148
|
}).describe("Embed media details.")
|
|
149
149
|
})
|
|
150
150
|
])
|
|
151
151
|
).describe("Post cover media.").optional(),
|
|
152
|
-
previewTextParagraph: z.number().int().describe(
|
|
152
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
153
153
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
154
154
|
).min(0).optional().nullable()
|
|
155
155
|
}).describe("Draft post to create."),
|
|
156
|
-
options: z.object({
|
|
157
|
-
publish: z.boolean().describe(
|
|
156
|
+
options: /* @__PURE__ */ z.object({
|
|
157
|
+
publish: /* @__PURE__ */ z.boolean().describe(
|
|
158
158
|
"Whether the draft post should be published on creation.\n\nDefault: `false`"
|
|
159
159
|
).optional(),
|
|
160
|
-
fieldsets: z.array(
|
|
161
|
-
z.enum([
|
|
160
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
161
|
+
/* @__PURE__ */ z.enum([
|
|
162
162
|
"UNKNOWN",
|
|
163
163
|
"URL",
|
|
164
164
|
"CONTENT",
|
|
@@ -169,40 +169,40 @@ var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
169
169
|
}).describe("Options for creating a draft post.").optional()
|
|
170
170
|
});
|
|
171
171
|
var CreateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
172
|
-
draftPost: z.object({
|
|
173
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
174
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
175
|
-
excerpt: z.string().describe(
|
|
172
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
173
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
174
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
175
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
176
176
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
177
177
|
).max(500).optional().nullable(),
|
|
178
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
179
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
180
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
178
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
179
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
180
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
181
181
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
182
182
|
"Must be a valid GUID"
|
|
183
183
|
).optional().nullable(),
|
|
184
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
185
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
186
|
-
minutesToRead: z.number().int().describe(
|
|
184
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
185
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
186
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
187
187
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
188
188
|
).optional(),
|
|
189
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
190
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
191
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
192
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
193
|
-
translationId: z.string().describe(
|
|
189
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
190
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
191
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
192
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
193
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
194
194
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
195
195
|
).regex(
|
|
196
196
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
197
197
|
"Must be a valid GUID"
|
|
198
198
|
).optional().nullable(),
|
|
199
|
-
language: z.string().describe(
|
|
199
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
200
200
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
201
201
|
).optional().nullable(),
|
|
202
|
-
richContent: z.any().describe(
|
|
202
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
203
203
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
204
204
|
).optional(),
|
|
205
|
-
status: z.enum([
|
|
205
|
+
status: /* @__PURE__ */ z.enum([
|
|
206
206
|
"UNKNOWN",
|
|
207
207
|
"PUBLISHED",
|
|
208
208
|
"UNPUBLISHED",
|
|
@@ -210,156 +210,156 @@ var CreateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
210
210
|
"DELETED",
|
|
211
211
|
"IN_REVIEW"
|
|
212
212
|
]).describe("Status of the draft post.").optional(),
|
|
213
|
-
moderationDetails: z.object({
|
|
214
|
-
submittedBy: z.string().describe(
|
|
213
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
214
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
215
215
|
"Member ID of the person submitting the draft post for review."
|
|
216
216
|
).regex(
|
|
217
217
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
218
218
|
"Must be a valid GUID"
|
|
219
219
|
).optional(),
|
|
220
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
221
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
220
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
221
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
222
222
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
223
223
|
).optional(),
|
|
224
|
-
moderatedBy: z.string().describe(
|
|
224
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
225
225
|
"Member ID of the person who approved or rejected the post."
|
|
226
226
|
).regex(
|
|
227
227
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
228
228
|
"Must be a valid GUID"
|
|
229
229
|
).optional().nullable(),
|
|
230
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
230
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
231
231
|
}).describe(
|
|
232
232
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
233
233
|
).optional(),
|
|
234
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
234
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
235
235
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
236
236
|
).optional(),
|
|
237
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
238
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
239
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
240
|
-
seoData: z.object({
|
|
241
|
-
tags: z.array(
|
|
242
|
-
z.object({
|
|
243
|
-
type: z.string().describe(
|
|
237
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
238
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
239
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
240
|
+
seoData: /* @__PURE__ */ z.object({
|
|
241
|
+
tags: /* @__PURE__ */ z.array(
|
|
242
|
+
/* @__PURE__ */ z.object({
|
|
243
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
244
244
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
245
245
|
).optional(),
|
|
246
|
-
props: z.record(z.string(), z.any()).describe(
|
|
246
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
247
247
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
248
248
|
).optional().nullable(),
|
|
249
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
249
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
250
250
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
251
251
|
).optional().nullable(),
|
|
252
|
-
children: z.string().describe(
|
|
252
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
253
253
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
254
254
|
).optional(),
|
|
255
|
-
custom: z.boolean().describe(
|
|
255
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
256
256
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
257
257
|
).optional(),
|
|
258
|
-
disabled: z.boolean().describe(
|
|
258
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
259
259
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
260
260
|
).optional()
|
|
261
261
|
})
|
|
262
262
|
).optional(),
|
|
263
|
-
settings: z.object({
|
|
264
|
-
preventAutoRedirect: z.boolean().describe(
|
|
263
|
+
settings: /* @__PURE__ */ z.object({
|
|
264
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
265
265
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
266
266
|
).optional(),
|
|
267
|
-
keywords: z.array(
|
|
268
|
-
z.object({
|
|
269
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
270
|
-
isMain: z.boolean().describe(
|
|
267
|
+
keywords: /* @__PURE__ */ z.array(
|
|
268
|
+
/* @__PURE__ */ z.object({
|
|
269
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
270
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
271
271
|
"Whether the keyword is the main focus keyword."
|
|
272
272
|
).optional(),
|
|
273
|
-
origin: z.string().describe(
|
|
273
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
274
274
|
"The source that added the keyword terms to the SEO settings."
|
|
275
275
|
).max(1e3).optional().nullable()
|
|
276
276
|
})
|
|
277
277
|
).max(5).optional()
|
|
278
278
|
}).describe("SEO general settings.").optional()
|
|
279
279
|
}).describe("SEO data.").optional(),
|
|
280
|
-
url: z.string().describe(
|
|
280
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
281
281
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
282
282
|
).optional(),
|
|
283
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
284
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
285
|
-
media: z.intersection(
|
|
286
|
-
z.object({
|
|
287
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
288
|
-
custom: z.boolean().describe(
|
|
283
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
284
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
285
|
+
media: /* @__PURE__ */ z.intersection(
|
|
286
|
+
/* @__PURE__ */ z.object({
|
|
287
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
288
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
289
289
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
290
290
|
).optional(),
|
|
291
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
291
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
292
292
|
}),
|
|
293
|
-
z.xor([
|
|
294
|
-
z.object({
|
|
295
|
-
wixMedia: z.never().optional(),
|
|
296
|
-
embedMedia: z.never().optional()
|
|
293
|
+
/* @__PURE__ */ z.xor([
|
|
294
|
+
/* @__PURE__ */ z.object({
|
|
295
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
296
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
297
297
|
}),
|
|
298
|
-
z.object({
|
|
299
|
-
embedMedia: z.never().optional(),
|
|
300
|
-
wixMedia: z.object({
|
|
301
|
-
image: z.string().describe("Image details.").optional(),
|
|
302
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
298
|
+
/* @__PURE__ */ z.object({
|
|
299
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
300
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
301
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
302
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
303
303
|
}).describe("Wix Media details.")
|
|
304
304
|
}),
|
|
305
|
-
z.object({
|
|
306
|
-
wixMedia: z.never().optional(),
|
|
307
|
-
embedMedia: z.object({
|
|
308
|
-
thumbnail: z.object({
|
|
309
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
310
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
311
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
305
|
+
/* @__PURE__ */ z.object({
|
|
306
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
307
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
308
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
309
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
310
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
311
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
312
312
|
}).describe("Thumbnail details.").optional(),
|
|
313
|
-
video: z.object({
|
|
314
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
315
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
316
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
313
|
+
video: /* @__PURE__ */ z.object({
|
|
314
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
315
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
316
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
317
317
|
}).describe("Video details.").optional()
|
|
318
318
|
}).describe("Embed media details.")
|
|
319
319
|
})
|
|
320
320
|
])
|
|
321
321
|
).describe("Post cover media.").optional(),
|
|
322
|
-
previewTextParagraph: z.number().int().describe(
|
|
322
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
323
323
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
324
324
|
).min(0).optional().nullable()
|
|
325
325
|
}).describe("Created draft post info.").optional()
|
|
326
326
|
});
|
|
327
327
|
var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
328
|
-
draftPosts: z.array(
|
|
329
|
-
z.object({
|
|
330
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
331
|
-
title: z.string().describe("Draft post title.").max(200),
|
|
332
|
-
excerpt: z.string().describe(
|
|
328
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
329
|
+
/* @__PURE__ */ z.object({
|
|
330
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
331
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200),
|
|
332
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
333
333
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
334
334
|
).max(500).optional().nullable(),
|
|
335
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
336
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
337
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
335
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
336
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
337
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
338
338
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
339
339
|
"Must be a valid GUID"
|
|
340
340
|
).optional().nullable(),
|
|
341
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
342
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
343
|
-
minutesToRead: z.number().int().describe(
|
|
341
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
342
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
343
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
344
344
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
345
345
|
).optional(),
|
|
346
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
347
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
348
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
349
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
350
|
-
translationId: z.string().describe(
|
|
346
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
347
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
348
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
349
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
350
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
351
351
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
352
352
|
).regex(
|
|
353
353
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
354
354
|
"Must be a valid GUID"
|
|
355
355
|
).optional().nullable(),
|
|
356
|
-
language: z.string().describe(
|
|
356
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
357
357
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
358
358
|
).optional().nullable(),
|
|
359
|
-
richContent: z.any().describe(
|
|
359
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
360
360
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
361
361
|
).optional(),
|
|
362
|
-
status: z.enum([
|
|
362
|
+
status: /* @__PURE__ */ z.enum([
|
|
363
363
|
"UNKNOWN",
|
|
364
364
|
"PUBLISHED",
|
|
365
365
|
"UNPUBLISHED",
|
|
@@ -367,125 +367,125 @@ var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
367
367
|
"DELETED",
|
|
368
368
|
"IN_REVIEW"
|
|
369
369
|
]).optional(),
|
|
370
|
-
moderationDetails: z.object({
|
|
371
|
-
submittedBy: z.string().describe(
|
|
370
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
371
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
372
372
|
"Member ID of the person submitting the draft post for review."
|
|
373
373
|
).regex(
|
|
374
374
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
375
375
|
"Must be a valid GUID"
|
|
376
376
|
).optional(),
|
|
377
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
378
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
379
|
-
moderatedBy: z.string().describe(
|
|
377
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
378
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
379
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
380
380
|
"Member ID of the person who approved or rejected the post."
|
|
381
381
|
).regex(
|
|
382
382
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
383
383
|
"Must be a valid GUID"
|
|
384
384
|
).optional().nullable(),
|
|
385
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
385
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
386
386
|
}).describe(
|
|
387
387
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
388
388
|
).optional(),
|
|
389
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
389
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
390
390
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
391
391
|
).optional(),
|
|
392
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
393
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
394
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
395
|
-
seoData: z.object({
|
|
396
|
-
tags: z.array(
|
|
397
|
-
z.object({
|
|
398
|
-
type: z.string().describe(
|
|
392
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
393
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
394
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
395
|
+
seoData: /* @__PURE__ */ z.object({
|
|
396
|
+
tags: /* @__PURE__ */ z.array(
|
|
397
|
+
/* @__PURE__ */ z.object({
|
|
398
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
399
399
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
400
400
|
).optional(),
|
|
401
|
-
props: z.record(z.string(), z.any()).describe(
|
|
401
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
402
402
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
403
403
|
).optional().nullable(),
|
|
404
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
404
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
405
405
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
406
406
|
).optional().nullable(),
|
|
407
|
-
children: z.string().describe(
|
|
407
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
408
408
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
409
409
|
).optional(),
|
|
410
|
-
custom: z.boolean().describe(
|
|
410
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
411
411
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
412
412
|
).optional(),
|
|
413
|
-
disabled: z.boolean().describe(
|
|
413
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
414
414
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
415
415
|
).optional()
|
|
416
416
|
})
|
|
417
417
|
).optional(),
|
|
418
|
-
settings: z.object({
|
|
419
|
-
preventAutoRedirect: z.boolean().describe(
|
|
418
|
+
settings: /* @__PURE__ */ z.object({
|
|
419
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
420
420
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
421
421
|
).optional(),
|
|
422
|
-
keywords: z.array(
|
|
423
|
-
z.object({
|
|
424
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
425
|
-
isMain: z.boolean().describe(
|
|
422
|
+
keywords: /* @__PURE__ */ z.array(
|
|
423
|
+
/* @__PURE__ */ z.object({
|
|
424
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
425
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
426
426
|
"Whether the keyword is the main focus keyword."
|
|
427
427
|
).optional(),
|
|
428
|
-
origin: z.string().describe(
|
|
428
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
429
429
|
"The source that added the keyword terms to the SEO settings."
|
|
430
430
|
).max(1e3).optional().nullable()
|
|
431
431
|
})
|
|
432
432
|
).max(5).optional()
|
|
433
433
|
}).describe("SEO general settings.").optional()
|
|
434
434
|
}).describe("SEO data.").optional(),
|
|
435
|
-
url: z.string().describe(
|
|
435
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
436
436
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
437
437
|
).optional(),
|
|
438
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
439
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
440
|
-
media: z.intersection(
|
|
441
|
-
z.object({
|
|
442
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
443
|
-
custom: z.boolean().describe(
|
|
438
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
439
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
440
|
+
media: /* @__PURE__ */ z.intersection(
|
|
441
|
+
/* @__PURE__ */ z.object({
|
|
442
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
443
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
444
444
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
445
445
|
).optional(),
|
|
446
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
446
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
447
447
|
}),
|
|
448
|
-
z.xor([
|
|
449
|
-
z.object({
|
|
450
|
-
wixMedia: z.never().optional(),
|
|
451
|
-
embedMedia: z.never().optional()
|
|
448
|
+
/* @__PURE__ */ z.xor([
|
|
449
|
+
/* @__PURE__ */ z.object({
|
|
450
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
451
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
452
452
|
}),
|
|
453
|
-
z.object({
|
|
454
|
-
embedMedia: z.never().optional(),
|
|
455
|
-
wixMedia: z.object({
|
|
456
|
-
image: z.string().describe("Image details.").optional(),
|
|
457
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
453
|
+
/* @__PURE__ */ z.object({
|
|
454
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
455
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
456
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
457
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
458
458
|
}).describe("Wix Media details.")
|
|
459
459
|
}),
|
|
460
|
-
z.object({
|
|
461
|
-
wixMedia: z.never().optional(),
|
|
462
|
-
embedMedia: z.object({
|
|
463
|
-
thumbnail: z.object({
|
|
464
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
465
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
466
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
460
|
+
/* @__PURE__ */ z.object({
|
|
461
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
462
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
463
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
464
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
465
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
466
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
467
467
|
}).describe("Thumbnail details.").optional(),
|
|
468
|
-
video: z.object({
|
|
469
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
470
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
471
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
468
|
+
video: /* @__PURE__ */ z.object({
|
|
469
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
470
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
471
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
472
472
|
}).describe("Video details.").optional()
|
|
473
473
|
}).describe("Embed media details.")
|
|
474
474
|
})
|
|
475
475
|
])
|
|
476
476
|
).describe("Post cover media.").optional(),
|
|
477
|
-
previewTextParagraph: z.number().int().describe(
|
|
477
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
478
478
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
479
479
|
).min(0).optional().nullable()
|
|
480
480
|
})
|
|
481
481
|
).min(1).max(20),
|
|
482
|
-
options: z.object({
|
|
483
|
-
publish: z.boolean().describe("Whether the draft post should be published after creation.").optional(),
|
|
484
|
-
returnFullEntity: z.boolean().describe(
|
|
482
|
+
options: /* @__PURE__ */ z.object({
|
|
483
|
+
publish: /* @__PURE__ */ z.boolean().describe("Whether the draft post should be published after creation.").optional(),
|
|
484
|
+
returnFullEntity: /* @__PURE__ */ z.boolean().describe(
|
|
485
485
|
"Whether to return the full created draft post entities in the response."
|
|
486
486
|
).optional(),
|
|
487
|
-
fieldsets: z.array(
|
|
488
|
-
z.enum([
|
|
487
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
488
|
+
/* @__PURE__ */ z.enum([
|
|
489
489
|
"UNKNOWN",
|
|
490
490
|
"URL",
|
|
491
491
|
"CONTENT",
|
|
@@ -496,58 +496,58 @@ var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
496
496
|
}).describe("Options for creating multiple draft posts.").optional()
|
|
497
497
|
});
|
|
498
498
|
var BulkCreateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
499
|
-
results: z.array(
|
|
500
|
-
z.object({
|
|
501
|
-
itemMetadata: z.object({
|
|
502
|
-
_id: z.string().describe(
|
|
499
|
+
results: /* @__PURE__ */ z.array(
|
|
500
|
+
/* @__PURE__ */ z.object({
|
|
501
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
502
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
503
503
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
504
504
|
).optional().nullable(),
|
|
505
|
-
originalIndex: z.number().int().describe(
|
|
505
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
506
506
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
507
507
|
).optional(),
|
|
508
|
-
success: z.boolean().describe(
|
|
508
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
509
509
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
510
510
|
).optional(),
|
|
511
|
-
error: z.object({
|
|
512
|
-
code: z.string().describe("Error code.").optional(),
|
|
513
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
514
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
511
|
+
error: /* @__PURE__ */ z.object({
|
|
512
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
513
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
514
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
515
515
|
}).describe("Details about the error in case of failure.").optional()
|
|
516
516
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
517
|
-
item: z.object({
|
|
518
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
519
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
520
|
-
excerpt: z.string().describe(
|
|
517
|
+
item: /* @__PURE__ */ z.object({
|
|
518
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
519
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
520
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
521
521
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
522
522
|
).max(500).optional().nullable(),
|
|
523
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
524
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
525
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
523
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
524
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
525
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
526
526
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
527
527
|
"Must be a valid GUID"
|
|
528
528
|
).optional().nullable(),
|
|
529
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
530
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
531
|
-
minutesToRead: z.number().int().describe(
|
|
529
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
530
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
531
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
532
532
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
533
533
|
).optional(),
|
|
534
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
535
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
536
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
537
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
538
|
-
translationId: z.string().describe(
|
|
534
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
535
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
536
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
537
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
538
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
539
539
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
540
540
|
).regex(
|
|
541
541
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
542
542
|
"Must be a valid GUID"
|
|
543
543
|
).optional().nullable(),
|
|
544
|
-
language: z.string().describe(
|
|
544
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
545
545
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
546
546
|
).optional().nullable(),
|
|
547
|
-
richContent: z.any().describe(
|
|
547
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
548
548
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
549
549
|
).optional(),
|
|
550
|
-
status: z.enum([
|
|
550
|
+
status: /* @__PURE__ */ z.enum([
|
|
551
551
|
"UNKNOWN",
|
|
552
552
|
"PUBLISHED",
|
|
553
553
|
"UNPUBLISHED",
|
|
@@ -555,167 +555,167 @@ var BulkCreateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
555
555
|
"DELETED",
|
|
556
556
|
"IN_REVIEW"
|
|
557
557
|
]).describe("Status of the draft post.").optional(),
|
|
558
|
-
moderationDetails: z.object({
|
|
559
|
-
submittedBy: z.string().describe(
|
|
558
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
559
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
560
560
|
"Member ID of the person submitting the draft post for review."
|
|
561
561
|
).regex(
|
|
562
562
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
563
563
|
"Must be a valid GUID"
|
|
564
564
|
).optional(),
|
|
565
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
566
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
565
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
566
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
567
567
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
568
568
|
).optional(),
|
|
569
|
-
moderatedBy: z.string().describe(
|
|
569
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
570
570
|
"Member ID of the person who approved or rejected the post."
|
|
571
571
|
).regex(
|
|
572
572
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
573
573
|
"Must be a valid GUID"
|
|
574
574
|
).optional().nullable(),
|
|
575
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
575
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
576
576
|
}).describe(
|
|
577
577
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
578
578
|
).optional(),
|
|
579
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
579
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
580
580
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
581
581
|
).optional(),
|
|
582
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
583
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
584
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
585
|
-
seoData: z.object({
|
|
586
|
-
tags: z.array(
|
|
587
|
-
z.object({
|
|
588
|
-
type: z.string().describe(
|
|
582
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
583
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
584
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
585
|
+
seoData: /* @__PURE__ */ z.object({
|
|
586
|
+
tags: /* @__PURE__ */ z.array(
|
|
587
|
+
/* @__PURE__ */ z.object({
|
|
588
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
589
589
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
590
590
|
).optional(),
|
|
591
|
-
props: z.record(z.string(), z.any()).describe(
|
|
591
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
592
592
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
593
593
|
).optional().nullable(),
|
|
594
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
594
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
595
595
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
596
596
|
).optional().nullable(),
|
|
597
|
-
children: z.string().describe(
|
|
597
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
598
598
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
599
599
|
).optional(),
|
|
600
|
-
custom: z.boolean().describe(
|
|
600
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
601
601
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
602
602
|
).optional(),
|
|
603
|
-
disabled: z.boolean().describe(
|
|
603
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
604
604
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
605
605
|
).optional()
|
|
606
606
|
})
|
|
607
607
|
).optional(),
|
|
608
|
-
settings: z.object({
|
|
609
|
-
preventAutoRedirect: z.boolean().describe(
|
|
608
|
+
settings: /* @__PURE__ */ z.object({
|
|
609
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
610
610
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
611
611
|
).optional(),
|
|
612
|
-
keywords: z.array(
|
|
613
|
-
z.object({
|
|
614
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
615
|
-
isMain: z.boolean().describe(
|
|
612
|
+
keywords: /* @__PURE__ */ z.array(
|
|
613
|
+
/* @__PURE__ */ z.object({
|
|
614
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
615
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
616
616
|
"Whether the keyword is the main focus keyword."
|
|
617
617
|
).optional(),
|
|
618
|
-
origin: z.string().describe(
|
|
618
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
619
619
|
"The source that added the keyword terms to the SEO settings."
|
|
620
620
|
).max(1e3).optional().nullable()
|
|
621
621
|
})
|
|
622
622
|
).max(5).optional()
|
|
623
623
|
}).describe("SEO general settings.").optional()
|
|
624
624
|
}).describe("SEO data.").optional(),
|
|
625
|
-
url: z.string().describe(
|
|
625
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
626
626
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
627
627
|
).optional(),
|
|
628
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
629
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
630
|
-
media: z.intersection(
|
|
631
|
-
z.object({
|
|
632
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
633
|
-
custom: z.boolean().describe(
|
|
628
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
629
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
630
|
+
media: /* @__PURE__ */ z.intersection(
|
|
631
|
+
/* @__PURE__ */ z.object({
|
|
632
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
633
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
634
634
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
635
635
|
).optional(),
|
|
636
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
636
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
637
637
|
}),
|
|
638
|
-
z.xor([
|
|
639
|
-
z.object({
|
|
640
|
-
wixMedia: z.never().optional(),
|
|
641
|
-
embedMedia: z.never().optional()
|
|
638
|
+
/* @__PURE__ */ z.xor([
|
|
639
|
+
/* @__PURE__ */ z.object({
|
|
640
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
641
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
642
642
|
}),
|
|
643
|
-
z.object({
|
|
644
|
-
embedMedia: z.never().optional(),
|
|
645
|
-
wixMedia: z.object({
|
|
646
|
-
image: z.string().describe("Image details.").optional(),
|
|
647
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
643
|
+
/* @__PURE__ */ z.object({
|
|
644
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
645
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
646
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
647
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
648
648
|
}).describe("Wix Media details.")
|
|
649
649
|
}),
|
|
650
|
-
z.object({
|
|
651
|
-
wixMedia: z.never().optional(),
|
|
652
|
-
embedMedia: z.object({
|
|
653
|
-
thumbnail: z.object({
|
|
654
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
655
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
656
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
650
|
+
/* @__PURE__ */ z.object({
|
|
651
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
652
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
653
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
654
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
655
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
656
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
657
657
|
}).describe("Thumbnail details.").optional(),
|
|
658
|
-
video: z.object({
|
|
659
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
660
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
661
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
658
|
+
video: /* @__PURE__ */ z.object({
|
|
659
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
660
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
661
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
662
662
|
}).describe("Video details.").optional()
|
|
663
663
|
}).describe("Embed media details.")
|
|
664
664
|
})
|
|
665
665
|
])
|
|
666
666
|
).describe("Post cover media.").optional(),
|
|
667
|
-
previewTextParagraph: z.number().int().describe(
|
|
667
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
668
668
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
669
669
|
).min(0).optional().nullable()
|
|
670
670
|
}).describe("Optional full draft post.").optional()
|
|
671
671
|
})
|
|
672
672
|
).optional(),
|
|
673
|
-
bulkActionMetadata: z.object({
|
|
674
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
675
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
676
|
-
undetailedFailures: z.number().int().describe(
|
|
673
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
674
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
675
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
676
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
677
677
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
678
678
|
).optional()
|
|
679
679
|
}).describe("Bulk action metadata.").optional()
|
|
680
680
|
});
|
|
681
681
|
var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
682
|
-
options: z.object({
|
|
683
|
-
draftPosts: z.array(
|
|
684
|
-
z.object({
|
|
685
|
-
draftPost: z.object({
|
|
686
|
-
_id: z.string().describe("Draft post ID.").max(38),
|
|
687
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
688
|
-
excerpt: z.string().describe(
|
|
682
|
+
options: /* @__PURE__ */ z.object({
|
|
683
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
684
|
+
/* @__PURE__ */ z.object({
|
|
685
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
686
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
687
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
688
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
689
689
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
690
690
|
).max(500).optional().nullable(),
|
|
691
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
692
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
693
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
691
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
692
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
693
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
694
694
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
695
695
|
"Must be a valid GUID"
|
|
696
696
|
).optional().nullable(),
|
|
697
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
698
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
699
|
-
minutesToRead: z.number().int().describe(
|
|
697
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
698
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
699
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
700
700
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
701
701
|
).optional(),
|
|
702
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
703
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
704
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
705
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
706
|
-
translationId: z.string().describe(
|
|
702
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
703
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
704
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
705
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
706
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
707
707
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
708
708
|
).regex(
|
|
709
709
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
710
710
|
"Must be a valid GUID"
|
|
711
711
|
).optional().nullable(),
|
|
712
|
-
language: z.string().describe(
|
|
712
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
713
713
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
714
714
|
).optional().nullable(),
|
|
715
|
-
richContent: z.any().describe(
|
|
715
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
716
716
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
717
717
|
).optional(),
|
|
718
|
-
status: z.enum([
|
|
718
|
+
status: /* @__PURE__ */ z.enum([
|
|
719
719
|
"UNKNOWN",
|
|
720
720
|
"PUBLISHED",
|
|
721
721
|
"UNPUBLISHED",
|
|
@@ -723,121 +723,127 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
723
723
|
"DELETED",
|
|
724
724
|
"IN_REVIEW"
|
|
725
725
|
]).optional(),
|
|
726
|
-
moderationDetails: z.object({
|
|
727
|
-
submittedBy: z.string().describe(
|
|
726
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
727
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
728
728
|
"Member ID of the person submitting the draft post for review."
|
|
729
729
|
).regex(
|
|
730
730
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
731
731
|
"Must be a valid GUID"
|
|
732
732
|
).optional(),
|
|
733
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
734
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
735
|
-
moderatedBy: z.string().describe(
|
|
733
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
734
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
735
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
736
736
|
"Member ID of the person who approved or rejected the post."
|
|
737
737
|
).regex(
|
|
738
738
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
739
739
|
"Must be a valid GUID"
|
|
740
740
|
).optional().nullable(),
|
|
741
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
741
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
742
742
|
}).describe(
|
|
743
743
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
744
744
|
).optional(),
|
|
745
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
745
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
746
746
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
747
747
|
).optional(),
|
|
748
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
749
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
750
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
751
|
-
seoData: z.object({
|
|
752
|
-
tags: z.array(
|
|
753
|
-
z.object({
|
|
754
|
-
type: z.string().describe(
|
|
748
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
749
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
750
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
751
|
+
seoData: /* @__PURE__ */ z.object({
|
|
752
|
+
tags: /* @__PURE__ */ z.array(
|
|
753
|
+
/* @__PURE__ */ z.object({
|
|
754
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
755
755
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
756
756
|
).optional(),
|
|
757
|
-
props: z.record(
|
|
757
|
+
props: /* @__PURE__ */ z.record(
|
|
758
|
+
/* @__PURE__ */ z.string(),
|
|
759
|
+
/* @__PURE__ */ z.any()
|
|
760
|
+
).describe(
|
|
758
761
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
759
762
|
).optional().nullable(),
|
|
760
|
-
meta: z.record(
|
|
763
|
+
meta: /* @__PURE__ */ z.record(
|
|
764
|
+
/* @__PURE__ */ z.string(),
|
|
765
|
+
/* @__PURE__ */ z.any()
|
|
766
|
+
).describe(
|
|
761
767
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
762
768
|
).optional().nullable(),
|
|
763
|
-
children: z.string().describe(
|
|
769
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
764
770
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
765
771
|
).optional(),
|
|
766
|
-
custom: z.boolean().describe(
|
|
772
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
767
773
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
768
774
|
).optional(),
|
|
769
|
-
disabled: z.boolean().describe(
|
|
775
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
770
776
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
771
777
|
).optional()
|
|
772
778
|
})
|
|
773
779
|
).optional(),
|
|
774
|
-
settings: z.object({
|
|
775
|
-
preventAutoRedirect: z.boolean().describe(
|
|
780
|
+
settings: /* @__PURE__ */ z.object({
|
|
781
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
776
782
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
777
783
|
).optional(),
|
|
778
|
-
keywords: z.array(
|
|
779
|
-
z.object({
|
|
780
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
781
|
-
isMain: z.boolean().describe(
|
|
784
|
+
keywords: /* @__PURE__ */ z.array(
|
|
785
|
+
/* @__PURE__ */ z.object({
|
|
786
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
787
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
782
788
|
"Whether the keyword is the main focus keyword."
|
|
783
789
|
).optional(),
|
|
784
|
-
origin: z.string().describe(
|
|
790
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
785
791
|
"The source that added the keyword terms to the SEO settings."
|
|
786
792
|
).max(1e3).optional().nullable()
|
|
787
793
|
})
|
|
788
794
|
).max(5).optional()
|
|
789
795
|
}).describe("SEO general settings.").optional()
|
|
790
796
|
}).describe("SEO data.").optional(),
|
|
791
|
-
url: z.string().describe(
|
|
797
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
792
798
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
793
799
|
).optional(),
|
|
794
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
795
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
796
|
-
media: z.intersection(
|
|
797
|
-
z.object({
|
|
798
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
799
|
-
custom: z.boolean().describe(
|
|
800
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
801
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
802
|
+
media: /* @__PURE__ */ z.intersection(
|
|
803
|
+
/* @__PURE__ */ z.object({
|
|
804
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
805
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
800
806
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
801
807
|
).optional(),
|
|
802
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
808
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
803
809
|
}),
|
|
804
|
-
z.xor([
|
|
805
|
-
z.object({
|
|
806
|
-
wixMedia: z.never().optional(),
|
|
807
|
-
embedMedia: z.never().optional()
|
|
810
|
+
/* @__PURE__ */ z.xor([
|
|
811
|
+
/* @__PURE__ */ z.object({
|
|
812
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
813
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
808
814
|
}),
|
|
809
|
-
z.object({
|
|
810
|
-
embedMedia: z.never().optional(),
|
|
811
|
-
wixMedia: z.object({
|
|
812
|
-
image: z.string().describe("Image details.").optional(),
|
|
813
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
815
|
+
/* @__PURE__ */ z.object({
|
|
816
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
817
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
818
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
819
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
814
820
|
}).describe("Wix Media details.")
|
|
815
821
|
}),
|
|
816
|
-
z.object({
|
|
817
|
-
wixMedia: z.never().optional(),
|
|
818
|
-
embedMedia: z.object({
|
|
819
|
-
thumbnail: z.object({
|
|
820
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
821
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
822
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
822
|
+
/* @__PURE__ */ z.object({
|
|
823
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
824
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
825
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
826
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
827
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
828
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
823
829
|
}).describe("Thumbnail details.").optional(),
|
|
824
|
-
video: z.object({
|
|
825
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
826
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
827
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
830
|
+
video: /* @__PURE__ */ z.object({
|
|
831
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
832
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
833
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
828
834
|
}).describe("Video details.").optional()
|
|
829
835
|
}).describe("Embed media details.")
|
|
830
836
|
})
|
|
831
837
|
])
|
|
832
838
|
).describe("Post cover media.").optional(),
|
|
833
|
-
previewTextParagraph: z.number().int().describe(
|
|
839
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
834
840
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
835
841
|
).min(0).optional().nullable()
|
|
836
842
|
}).describe("Draft post"),
|
|
837
|
-
fieldMask: z.array(z.string()).optional()
|
|
843
|
+
fieldMask: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).optional()
|
|
838
844
|
})
|
|
839
845
|
).min(1).max(20).optional(),
|
|
840
|
-
action: z.enum([
|
|
846
|
+
action: /* @__PURE__ */ z.enum([
|
|
841
847
|
"UPDATE",
|
|
842
848
|
"UPDATE_PUBLISH",
|
|
843
849
|
"UPDATE_SCHEDULE",
|
|
@@ -846,14 +852,14 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
846
852
|
"UPDATE_REJECT",
|
|
847
853
|
"UPDATE_PUBLICATION"
|
|
848
854
|
]).optional(),
|
|
849
|
-
scheduledPublishDate: z.date().describe(
|
|
855
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe(
|
|
850
856
|
"Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`."
|
|
851
857
|
).optional().nullable(),
|
|
852
|
-
returnFullEntity: z.boolean().describe(
|
|
858
|
+
returnFullEntity: /* @__PURE__ */ z.boolean().describe(
|
|
853
859
|
"Whether to return the full updated draft post entities in the response."
|
|
854
860
|
).optional(),
|
|
855
|
-
fieldsets: z.array(
|
|
856
|
-
z.enum([
|
|
861
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
862
|
+
/* @__PURE__ */ z.enum([
|
|
857
863
|
"UNKNOWN",
|
|
858
864
|
"URL",
|
|
859
865
|
"CONTENT",
|
|
@@ -864,58 +870,58 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
864
870
|
}).describe("Options for updating multiple draft posts.").optional()
|
|
865
871
|
});
|
|
866
872
|
var BulkUpdateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
867
|
-
results: z.array(
|
|
868
|
-
z.object({
|
|
869
|
-
itemMetadata: z.object({
|
|
870
|
-
_id: z.string().describe(
|
|
873
|
+
results: /* @__PURE__ */ z.array(
|
|
874
|
+
/* @__PURE__ */ z.object({
|
|
875
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
876
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
871
877
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
872
878
|
).optional().nullable(),
|
|
873
|
-
originalIndex: z.number().int().describe(
|
|
879
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
874
880
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
875
881
|
).optional(),
|
|
876
|
-
success: z.boolean().describe(
|
|
882
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
877
883
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
878
884
|
).optional(),
|
|
879
|
-
error: z.object({
|
|
880
|
-
code: z.string().describe("Error code.").optional(),
|
|
881
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
882
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
885
|
+
error: /* @__PURE__ */ z.object({
|
|
886
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
887
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
888
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
883
889
|
}).describe("Details about the error in case of failure.").optional()
|
|
884
890
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
885
|
-
item: z.object({
|
|
886
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
887
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
888
|
-
excerpt: z.string().describe(
|
|
891
|
+
item: /* @__PURE__ */ z.object({
|
|
892
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
893
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
894
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
889
895
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
890
896
|
).max(500).optional().nullable(),
|
|
891
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
892
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
893
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
897
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
898
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
899
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
894
900
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
895
901
|
"Must be a valid GUID"
|
|
896
902
|
).optional().nullable(),
|
|
897
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
898
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
899
|
-
minutesToRead: z.number().int().describe(
|
|
903
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
904
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
905
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
900
906
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
901
907
|
).optional(),
|
|
902
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
903
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
904
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
905
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
906
|
-
translationId: z.string().describe(
|
|
908
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
909
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
910
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
911
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
912
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
907
913
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
908
914
|
).regex(
|
|
909
915
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
910
916
|
"Must be a valid GUID"
|
|
911
917
|
).optional().nullable(),
|
|
912
|
-
language: z.string().describe(
|
|
918
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
913
919
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
914
920
|
).optional().nullable(),
|
|
915
|
-
richContent: z.any().describe(
|
|
921
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
916
922
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
917
923
|
).optional(),
|
|
918
|
-
status: z.enum([
|
|
924
|
+
status: /* @__PURE__ */ z.enum([
|
|
919
925
|
"UNKNOWN",
|
|
920
926
|
"PUBLISHED",
|
|
921
927
|
"UNPUBLISHED",
|
|
@@ -923,146 +929,146 @@ var BulkUpdateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
923
929
|
"DELETED",
|
|
924
930
|
"IN_REVIEW"
|
|
925
931
|
]).describe("Status of the draft post.").optional(),
|
|
926
|
-
moderationDetails: z.object({
|
|
927
|
-
submittedBy: z.string().describe(
|
|
932
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
933
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
928
934
|
"Member ID of the person submitting the draft post for review."
|
|
929
935
|
).regex(
|
|
930
936
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
931
937
|
"Must be a valid GUID"
|
|
932
938
|
).optional(),
|
|
933
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
934
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
939
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
940
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
935
941
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
936
942
|
).optional(),
|
|
937
|
-
moderatedBy: z.string().describe(
|
|
943
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
938
944
|
"Member ID of the person who approved or rejected the post."
|
|
939
945
|
).regex(
|
|
940
946
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
941
947
|
"Must be a valid GUID"
|
|
942
948
|
).optional().nullable(),
|
|
943
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
949
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
944
950
|
}).describe(
|
|
945
951
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
946
952
|
).optional(),
|
|
947
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
953
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
948
954
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
949
955
|
).optional(),
|
|
950
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
951
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
952
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
953
|
-
seoData: z.object({
|
|
954
|
-
tags: z.array(
|
|
955
|
-
z.object({
|
|
956
|
-
type: z.string().describe(
|
|
956
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
957
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
958
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
959
|
+
seoData: /* @__PURE__ */ z.object({
|
|
960
|
+
tags: /* @__PURE__ */ z.array(
|
|
961
|
+
/* @__PURE__ */ z.object({
|
|
962
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
957
963
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
958
964
|
).optional(),
|
|
959
|
-
props: z.record(z.string(), z.any()).describe(
|
|
965
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
960
966
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
961
967
|
).optional().nullable(),
|
|
962
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
968
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
963
969
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
964
970
|
).optional().nullable(),
|
|
965
|
-
children: z.string().describe(
|
|
971
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
966
972
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
967
973
|
).optional(),
|
|
968
|
-
custom: z.boolean().describe(
|
|
974
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
969
975
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
970
976
|
).optional(),
|
|
971
|
-
disabled: z.boolean().describe(
|
|
977
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
972
978
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
973
979
|
).optional()
|
|
974
980
|
})
|
|
975
981
|
).optional(),
|
|
976
|
-
settings: z.object({
|
|
977
|
-
preventAutoRedirect: z.boolean().describe(
|
|
982
|
+
settings: /* @__PURE__ */ z.object({
|
|
983
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
978
984
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
979
985
|
).optional(),
|
|
980
|
-
keywords: z.array(
|
|
981
|
-
z.object({
|
|
982
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
983
|
-
isMain: z.boolean().describe(
|
|
986
|
+
keywords: /* @__PURE__ */ z.array(
|
|
987
|
+
/* @__PURE__ */ z.object({
|
|
988
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
989
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
984
990
|
"Whether the keyword is the main focus keyword."
|
|
985
991
|
).optional(),
|
|
986
|
-
origin: z.string().describe(
|
|
992
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
987
993
|
"The source that added the keyword terms to the SEO settings."
|
|
988
994
|
).max(1e3).optional().nullable()
|
|
989
995
|
})
|
|
990
996
|
).max(5).optional()
|
|
991
997
|
}).describe("SEO general settings.").optional()
|
|
992
998
|
}).describe("SEO data.").optional(),
|
|
993
|
-
url: z.string().describe(
|
|
999
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
994
1000
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
995
1001
|
).optional(),
|
|
996
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
997
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
998
|
-
media: z.intersection(
|
|
999
|
-
z.object({
|
|
1000
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1001
|
-
custom: z.boolean().describe(
|
|
1002
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1003
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1004
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1005
|
+
/* @__PURE__ */ z.object({
|
|
1006
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1007
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1002
1008
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1003
1009
|
).optional(),
|
|
1004
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1010
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1005
1011
|
}),
|
|
1006
|
-
z.xor([
|
|
1007
|
-
z.object({
|
|
1008
|
-
wixMedia: z.never().optional(),
|
|
1009
|
-
embedMedia: z.never().optional()
|
|
1012
|
+
/* @__PURE__ */ z.xor([
|
|
1013
|
+
/* @__PURE__ */ z.object({
|
|
1014
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1015
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1010
1016
|
}),
|
|
1011
|
-
z.object({
|
|
1012
|
-
embedMedia: z.never().optional(),
|
|
1013
|
-
wixMedia: z.object({
|
|
1014
|
-
image: z.string().describe("Image details.").optional(),
|
|
1015
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1017
|
+
/* @__PURE__ */ z.object({
|
|
1018
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1019
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1020
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1021
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1016
1022
|
}).describe("Wix Media details.")
|
|
1017
1023
|
}),
|
|
1018
|
-
z.object({
|
|
1019
|
-
wixMedia: z.never().optional(),
|
|
1020
|
-
embedMedia: z.object({
|
|
1021
|
-
thumbnail: z.object({
|
|
1022
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1023
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1024
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1024
|
+
/* @__PURE__ */ z.object({
|
|
1025
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1026
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1027
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1028
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1029
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1030
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1025
1031
|
}).describe("Thumbnail details.").optional(),
|
|
1026
|
-
video: z.object({
|
|
1027
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1028
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1029
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1032
|
+
video: /* @__PURE__ */ z.object({
|
|
1033
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1034
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1035
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1030
1036
|
}).describe("Video details.").optional()
|
|
1031
1037
|
}).describe("Embed media details.")
|
|
1032
1038
|
})
|
|
1033
1039
|
])
|
|
1034
1040
|
).describe("Post cover media.").optional(),
|
|
1035
|
-
previewTextParagraph: z.number().int().describe(
|
|
1041
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1036
1042
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1037
1043
|
).min(0).optional().nullable()
|
|
1038
1044
|
}).describe("Optional full draft post.").optional()
|
|
1039
1045
|
})
|
|
1040
1046
|
).optional(),
|
|
1041
|
-
bulkActionMetadata: z.object({
|
|
1042
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1043
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1044
|
-
undetailedFailures: z.number().int().describe(
|
|
1047
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
1048
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1049
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1050
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
1045
1051
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
1046
1052
|
).optional()
|
|
1047
1053
|
}).describe("Bulk action metadata.").optional()
|
|
1048
1054
|
});
|
|
1049
1055
|
var ListDeletedDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
1050
|
-
options: z.object({
|
|
1051
|
-
language: z.string().describe(
|
|
1056
|
+
options: /* @__PURE__ */ z.object({
|
|
1057
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1052
1058
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf omitted, deleted draft posts in all languages are returned."
|
|
1053
1059
|
).optional().nullable(),
|
|
1054
|
-
sort: z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1055
|
-
paging: z.object({
|
|
1056
|
-
offset: z.number().int().describe(
|
|
1060
|
+
sort: /* @__PURE__ */ z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1061
|
+
paging: /* @__PURE__ */ z.object({
|
|
1062
|
+
offset: /* @__PURE__ */ z.number().int().describe(
|
|
1057
1063
|
"Number of items to skip in the current sort order.\n\n\nDefault: `0`"
|
|
1058
1064
|
).min(0).optional(),
|
|
1059
|
-
limit: z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1060
|
-
cursor: z.string().describe(
|
|
1065
|
+
limit: /* @__PURE__ */ z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1066
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
1061
1067
|
"Pointer to the next or previous page in the list of results."
|
|
1062
1068
|
).max(2e3).optional().nullable()
|
|
1063
1069
|
}).describe("Pagination options.").optional(),
|
|
1064
|
-
fieldsets: z.array(
|
|
1065
|
-
z.enum([
|
|
1070
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1071
|
+
/* @__PURE__ */ z.enum([
|
|
1066
1072
|
"UNKNOWN",
|
|
1067
1073
|
"URL",
|
|
1068
1074
|
"CONTENT",
|
|
@@ -1070,45 +1076,45 @@ var ListDeletedDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
1070
1076
|
"GENERATED_EXCERPT"
|
|
1071
1077
|
])
|
|
1072
1078
|
).max(10).optional(),
|
|
1073
|
-
draftPostIds: z.array(z.string()).max(100).optional()
|
|
1079
|
+
draftPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional()
|
|
1074
1080
|
}).describe("Options for listing deleted draft posts.").optional()
|
|
1075
1081
|
});
|
|
1076
1082
|
var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
1077
|
-
draftPosts: z.array(
|
|
1078
|
-
z.object({
|
|
1079
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1080
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1081
|
-
excerpt: z.string().describe(
|
|
1083
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
1084
|
+
/* @__PURE__ */ z.object({
|
|
1085
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1086
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1087
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1082
1088
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1083
1089
|
).max(500).optional().nullable(),
|
|
1084
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1085
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1086
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1090
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1091
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1092
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1087
1093
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1088
1094
|
"Must be a valid GUID"
|
|
1089
1095
|
).optional().nullable(),
|
|
1090
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1091
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1092
|
-
minutesToRead: z.number().int().describe(
|
|
1096
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1097
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1098
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1093
1099
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1094
1100
|
).optional(),
|
|
1095
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1096
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1097
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1098
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1099
|
-
translationId: z.string().describe(
|
|
1101
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1102
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1103
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1104
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1105
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1100
1106
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
1101
1107
|
).regex(
|
|
1102
1108
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1103
1109
|
"Must be a valid GUID"
|
|
1104
1110
|
).optional().nullable(),
|
|
1105
|
-
language: z.string().describe(
|
|
1111
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1106
1112
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
1107
1113
|
).optional().nullable(),
|
|
1108
|
-
richContent: z.any().describe(
|
|
1114
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1109
1115
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
1110
1116
|
).optional(),
|
|
1111
|
-
status: z.enum([
|
|
1117
|
+
status: /* @__PURE__ */ z.enum([
|
|
1112
1118
|
"UNKNOWN",
|
|
1113
1119
|
"PUBLISHED",
|
|
1114
1120
|
"UNPUBLISHED",
|
|
@@ -1116,132 +1122,132 @@ var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1116
1122
|
"DELETED",
|
|
1117
1123
|
"IN_REVIEW"
|
|
1118
1124
|
]).describe("Status of the draft post.").optional(),
|
|
1119
|
-
moderationDetails: z.object({
|
|
1120
|
-
submittedBy: z.string().describe(
|
|
1125
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1126
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1121
1127
|
"Member ID of the person submitting the draft post for review."
|
|
1122
1128
|
).regex(
|
|
1123
1129
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1124
1130
|
"Must be a valid GUID"
|
|
1125
1131
|
).optional(),
|
|
1126
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1127
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1132
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1133
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1128
1134
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1129
1135
|
).optional(),
|
|
1130
|
-
moderatedBy: z.string().describe(
|
|
1136
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1131
1137
|
"Member ID of the person who approved or rejected the post."
|
|
1132
1138
|
).regex(
|
|
1133
1139
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1134
1140
|
"Must be a valid GUID"
|
|
1135
1141
|
).optional().nullable(),
|
|
1136
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1142
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1137
1143
|
}).describe(
|
|
1138
1144
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1139
1145
|
).optional(),
|
|
1140
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1146
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1141
1147
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1142
1148
|
).optional(),
|
|
1143
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1144
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1145
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1146
|
-
seoData: z.object({
|
|
1147
|
-
tags: z.array(
|
|
1148
|
-
z.object({
|
|
1149
|
-
type: z.string().describe(
|
|
1149
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1150
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1151
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1152
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1153
|
+
tags: /* @__PURE__ */ z.array(
|
|
1154
|
+
/* @__PURE__ */ z.object({
|
|
1155
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1150
1156
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
1151
1157
|
).optional(),
|
|
1152
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1158
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1153
1159
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1154
1160
|
).optional().nullable(),
|
|
1155
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1161
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1156
1162
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1157
1163
|
).optional().nullable(),
|
|
1158
|
-
children: z.string().describe(
|
|
1164
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1159
1165
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1160
1166
|
).optional(),
|
|
1161
|
-
custom: z.boolean().describe(
|
|
1167
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1162
1168
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
1163
1169
|
).optional(),
|
|
1164
|
-
disabled: z.boolean().describe(
|
|
1170
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1165
1171
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1166
1172
|
).optional()
|
|
1167
1173
|
})
|
|
1168
1174
|
).optional(),
|
|
1169
|
-
settings: z.object({
|
|
1170
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1175
|
+
settings: /* @__PURE__ */ z.object({
|
|
1176
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1171
1177
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1172
1178
|
).optional(),
|
|
1173
|
-
keywords: z.array(
|
|
1174
|
-
z.object({
|
|
1175
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1176
|
-
isMain: z.boolean().describe(
|
|
1179
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1180
|
+
/* @__PURE__ */ z.object({
|
|
1181
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1182
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1177
1183
|
"Whether the keyword is the main focus keyword."
|
|
1178
1184
|
).optional(),
|
|
1179
|
-
origin: z.string().describe(
|
|
1185
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1180
1186
|
"The source that added the keyword terms to the SEO settings."
|
|
1181
1187
|
).max(1e3).optional().nullable()
|
|
1182
1188
|
})
|
|
1183
1189
|
).max(5).optional()
|
|
1184
1190
|
}).describe("SEO general settings.").optional()
|
|
1185
1191
|
}).describe("SEO data.").optional(),
|
|
1186
|
-
url: z.string().describe(
|
|
1192
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1187
1193
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1188
1194
|
).optional(),
|
|
1189
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1190
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1191
|
-
media: z.intersection(
|
|
1192
|
-
z.object({
|
|
1193
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1194
|
-
custom: z.boolean().describe(
|
|
1195
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1196
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1197
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1198
|
+
/* @__PURE__ */ z.object({
|
|
1199
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1200
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1195
1201
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1196
1202
|
).optional(),
|
|
1197
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1203
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1198
1204
|
}),
|
|
1199
|
-
z.xor([
|
|
1200
|
-
z.object({
|
|
1201
|
-
wixMedia: z.never().optional(),
|
|
1202
|
-
embedMedia: z.never().optional()
|
|
1205
|
+
/* @__PURE__ */ z.xor([
|
|
1206
|
+
/* @__PURE__ */ z.object({
|
|
1207
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1208
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1203
1209
|
}),
|
|
1204
|
-
z.object({
|
|
1205
|
-
embedMedia: z.never().optional(),
|
|
1206
|
-
wixMedia: z.object({
|
|
1207
|
-
image: z.string().describe("Image details.").optional(),
|
|
1208
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1210
|
+
/* @__PURE__ */ z.object({
|
|
1211
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1212
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1213
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1214
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1209
1215
|
}).describe("Wix Media details.")
|
|
1210
1216
|
}),
|
|
1211
|
-
z.object({
|
|
1212
|
-
wixMedia: z.never().optional(),
|
|
1213
|
-
embedMedia: z.object({
|
|
1214
|
-
thumbnail: z.object({
|
|
1215
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1216
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1217
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1217
|
+
/* @__PURE__ */ z.object({
|
|
1218
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1219
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1220
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1221
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1222
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1223
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1218
1224
|
}).describe("Thumbnail details.").optional(),
|
|
1219
|
-
video: z.object({
|
|
1220
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1221
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1222
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1225
|
+
video: /* @__PURE__ */ z.object({
|
|
1226
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1227
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1228
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1223
1229
|
}).describe("Video details.").optional()
|
|
1224
1230
|
}).describe("Embed media details.")
|
|
1225
1231
|
})
|
|
1226
1232
|
])
|
|
1227
1233
|
).describe("Post cover media.").optional(),
|
|
1228
|
-
previewTextParagraph: z.number().int().describe(
|
|
1234
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1229
1235
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1230
1236
|
).min(0).optional().nullable()
|
|
1231
1237
|
})
|
|
1232
1238
|
).optional(),
|
|
1233
|
-
pagingMetadata: z.object({
|
|
1234
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1235
|
-
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1236
|
-
total: z.number().int().describe(
|
|
1239
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
1240
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1241
|
+
offset: /* @__PURE__ */ z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1242
|
+
total: /* @__PURE__ */ z.number().int().describe(
|
|
1237
1243
|
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
1238
1244
|
).optional().nullable(),
|
|
1239
|
-
tooManyToCount: z.boolean().describe(
|
|
1245
|
+
tooManyToCount: /* @__PURE__ */ z.boolean().describe(
|
|
1240
1246
|
"Flag that indicates the server failed to calculate the `total` field."
|
|
1241
1247
|
).optional().nullable(),
|
|
1242
|
-
cursors: z.object({
|
|
1243
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
1244
|
-
prev: z.string().describe(
|
|
1248
|
+
cursors: /* @__PURE__ */ z.object({
|
|
1249
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
1250
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
1245
1251
|
"Cursor pointing to previous page in the list of results."
|
|
1246
1252
|
).max(2e3).optional().nullable()
|
|
1247
1253
|
}).describe(
|
|
@@ -1250,10 +1256,10 @@ var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1250
1256
|
}).describe("Details on the paged set of results returned.").optional()
|
|
1251
1257
|
});
|
|
1252
1258
|
var GetDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1253
|
-
draftPostId: z.string().describe("Draft post ID.").max(38),
|
|
1254
|
-
options: z.object({
|
|
1255
|
-
fieldsets: z.array(
|
|
1256
|
-
z.enum([
|
|
1259
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1260
|
+
options: /* @__PURE__ */ z.object({
|
|
1261
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1262
|
+
/* @__PURE__ */ z.enum([
|
|
1257
1263
|
"UNKNOWN",
|
|
1258
1264
|
"URL",
|
|
1259
1265
|
"CONTENT",
|
|
@@ -1264,40 +1270,40 @@ var GetDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1264
1270
|
}).describe("Options for getting a draft post.").optional()
|
|
1265
1271
|
});
|
|
1266
1272
|
var GetDraftPostResponse = /* @__PURE__ */ z.object({
|
|
1267
|
-
draftPost: z.object({
|
|
1268
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1269
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1270
|
-
excerpt: z.string().describe(
|
|
1273
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1274
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1275
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1276
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1271
1277
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1272
1278
|
).max(500).optional().nullable(),
|
|
1273
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1274
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1275
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1279
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1280
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1281
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1276
1282
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1277
1283
|
"Must be a valid GUID"
|
|
1278
1284
|
).optional().nullable(),
|
|
1279
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1280
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1281
|
-
minutesToRead: z.number().int().describe(
|
|
1285
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1286
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1287
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1282
1288
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1283
1289
|
).optional(),
|
|
1284
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1285
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1286
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1287
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1288
|
-
translationId: z.string().describe(
|
|
1290
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1291
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1292
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1293
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1294
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1289
1295
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
1290
1296
|
).regex(
|
|
1291
1297
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1292
1298
|
"Must be a valid GUID"
|
|
1293
1299
|
).optional().nullable(),
|
|
1294
|
-
language: z.string().describe(
|
|
1300
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1295
1301
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
1296
1302
|
).optional().nullable(),
|
|
1297
|
-
richContent: z.any().describe(
|
|
1303
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1298
1304
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
1299
1305
|
).optional(),
|
|
1300
|
-
status: z.enum([
|
|
1306
|
+
status: /* @__PURE__ */ z.enum([
|
|
1301
1307
|
"UNKNOWN",
|
|
1302
1308
|
"PUBLISHED",
|
|
1303
1309
|
"UNPUBLISHED",
|
|
@@ -1305,156 +1311,156 @@ var GetDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
1305
1311
|
"DELETED",
|
|
1306
1312
|
"IN_REVIEW"
|
|
1307
1313
|
]).describe("Status of the draft post.").optional(),
|
|
1308
|
-
moderationDetails: z.object({
|
|
1309
|
-
submittedBy: z.string().describe(
|
|
1314
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1315
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1310
1316
|
"Member ID of the person submitting the draft post for review."
|
|
1311
1317
|
).regex(
|
|
1312
1318
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1313
1319
|
"Must be a valid GUID"
|
|
1314
1320
|
).optional(),
|
|
1315
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1316
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1321
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1322
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1317
1323
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1318
1324
|
).optional(),
|
|
1319
|
-
moderatedBy: z.string().describe(
|
|
1325
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1320
1326
|
"Member ID of the person who approved or rejected the post."
|
|
1321
1327
|
).regex(
|
|
1322
1328
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1323
1329
|
"Must be a valid GUID"
|
|
1324
1330
|
).optional().nullable(),
|
|
1325
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1331
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1326
1332
|
}).describe(
|
|
1327
1333
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1328
1334
|
).optional(),
|
|
1329
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1335
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1330
1336
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1331
1337
|
).optional(),
|
|
1332
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1333
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1334
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1335
|
-
seoData: z.object({
|
|
1336
|
-
tags: z.array(
|
|
1337
|
-
z.object({
|
|
1338
|
-
type: z.string().describe(
|
|
1338
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1339
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1340
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1341
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1342
|
+
tags: /* @__PURE__ */ z.array(
|
|
1343
|
+
/* @__PURE__ */ z.object({
|
|
1344
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1339
1345
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
1340
1346
|
).optional(),
|
|
1341
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1347
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1342
1348
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1343
1349
|
).optional().nullable(),
|
|
1344
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1350
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1345
1351
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1346
1352
|
).optional().nullable(),
|
|
1347
|
-
children: z.string().describe(
|
|
1353
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1348
1354
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1349
1355
|
).optional(),
|
|
1350
|
-
custom: z.boolean().describe(
|
|
1356
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1351
1357
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
1352
1358
|
).optional(),
|
|
1353
|
-
disabled: z.boolean().describe(
|
|
1359
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1354
1360
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1355
1361
|
).optional()
|
|
1356
1362
|
})
|
|
1357
1363
|
).optional(),
|
|
1358
|
-
settings: z.object({
|
|
1359
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1364
|
+
settings: /* @__PURE__ */ z.object({
|
|
1365
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1360
1366
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1361
1367
|
).optional(),
|
|
1362
|
-
keywords: z.array(
|
|
1363
|
-
z.object({
|
|
1364
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1365
|
-
isMain: z.boolean().describe(
|
|
1368
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1369
|
+
/* @__PURE__ */ z.object({
|
|
1370
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1371
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1366
1372
|
"Whether the keyword is the main focus keyword."
|
|
1367
1373
|
).optional(),
|
|
1368
|
-
origin: z.string().describe(
|
|
1374
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1369
1375
|
"The source that added the keyword terms to the SEO settings."
|
|
1370
1376
|
).max(1e3).optional().nullable()
|
|
1371
1377
|
})
|
|
1372
1378
|
).max(5).optional()
|
|
1373
1379
|
}).describe("SEO general settings.").optional()
|
|
1374
1380
|
}).describe("SEO data.").optional(),
|
|
1375
|
-
url: z.string().describe(
|
|
1381
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1376
1382
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1377
1383
|
).optional(),
|
|
1378
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1379
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1380
|
-
media: z.intersection(
|
|
1381
|
-
z.object({
|
|
1382
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1383
|
-
custom: z.boolean().describe(
|
|
1384
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1385
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1386
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1387
|
+
/* @__PURE__ */ z.object({
|
|
1388
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1389
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1384
1390
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1385
1391
|
).optional(),
|
|
1386
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1392
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1387
1393
|
}),
|
|
1388
|
-
z.xor([
|
|
1389
|
-
z.object({
|
|
1390
|
-
wixMedia: z.never().optional(),
|
|
1391
|
-
embedMedia: z.never().optional()
|
|
1394
|
+
/* @__PURE__ */ z.xor([
|
|
1395
|
+
/* @__PURE__ */ z.object({
|
|
1396
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1397
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1392
1398
|
}),
|
|
1393
|
-
z.object({
|
|
1394
|
-
embedMedia: z.never().optional(),
|
|
1395
|
-
wixMedia: z.object({
|
|
1396
|
-
image: z.string().describe("Image details.").optional(),
|
|
1397
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1399
|
+
/* @__PURE__ */ z.object({
|
|
1400
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1401
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1402
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1403
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1398
1404
|
}).describe("Wix Media details.")
|
|
1399
1405
|
}),
|
|
1400
|
-
z.object({
|
|
1401
|
-
wixMedia: z.never().optional(),
|
|
1402
|
-
embedMedia: z.object({
|
|
1403
|
-
thumbnail: z.object({
|
|
1404
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1405
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1406
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1406
|
+
/* @__PURE__ */ z.object({
|
|
1407
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1408
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1409
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1410
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1411
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1412
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1407
1413
|
}).describe("Thumbnail details.").optional(),
|
|
1408
|
-
video: z.object({
|
|
1409
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1410
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1411
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1414
|
+
video: /* @__PURE__ */ z.object({
|
|
1415
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1416
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1417
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1412
1418
|
}).describe("Video details.").optional()
|
|
1413
1419
|
}).describe("Embed media details.")
|
|
1414
1420
|
})
|
|
1415
1421
|
])
|
|
1416
1422
|
).describe("Post cover media.").optional(),
|
|
1417
|
-
previewTextParagraph: z.number().int().describe(
|
|
1423
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1418
1424
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1419
1425
|
).min(0).optional().nullable()
|
|
1420
1426
|
}).describe("Draft post info.").optional()
|
|
1421
1427
|
});
|
|
1422
1428
|
var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1423
|
-
_id: z.string().describe("Draft post ID.").max(38),
|
|
1424
|
-
draftPost: z.object({
|
|
1425
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1426
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1427
|
-
excerpt: z.string().describe(
|
|
1429
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1430
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1431
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1432
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1433
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1428
1434
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1429
1435
|
).max(500).optional().nullable(),
|
|
1430
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1431
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1432
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1436
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1437
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1438
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1433
1439
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1434
1440
|
"Must be a valid GUID"
|
|
1435
1441
|
).optional().nullable(),
|
|
1436
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1437
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1438
|
-
minutesToRead: z.number().int().describe(
|
|
1442
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1443
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1444
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1439
1445
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1440
1446
|
).optional(),
|
|
1441
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1442
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1443
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1444
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1445
|
-
translationId: z.string().describe(
|
|
1447
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1448
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1449
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1450
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1451
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1446
1452
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
1447
1453
|
).regex(
|
|
1448
1454
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1449
1455
|
"Must be a valid GUID"
|
|
1450
1456
|
).optional().nullable(),
|
|
1451
|
-
language: z.string().describe(
|
|
1457
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1452
1458
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
1453
1459
|
).optional().nullable(),
|
|
1454
|
-
richContent: z.any().describe(
|
|
1460
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1455
1461
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
1456
1462
|
).optional(),
|
|
1457
|
-
status: z.enum([
|
|
1463
|
+
status: /* @__PURE__ */ z.enum([
|
|
1458
1464
|
"UNKNOWN",
|
|
1459
1465
|
"PUBLISHED",
|
|
1460
1466
|
"UNPUBLISHED",
|
|
@@ -1462,119 +1468,119 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1462
1468
|
"DELETED",
|
|
1463
1469
|
"IN_REVIEW"
|
|
1464
1470
|
]).optional(),
|
|
1465
|
-
moderationDetails: z.object({
|
|
1466
|
-
submittedBy: z.string().describe(
|
|
1471
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1472
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1467
1473
|
"Member ID of the person submitting the draft post for review."
|
|
1468
1474
|
).regex(
|
|
1469
1475
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1470
1476
|
"Must be a valid GUID"
|
|
1471
1477
|
).optional(),
|
|
1472
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1473
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
1474
|
-
moderatedBy: z.string().describe(
|
|
1478
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1479
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
1480
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1475
1481
|
"Member ID of the person who approved or rejected the post."
|
|
1476
1482
|
).regex(
|
|
1477
1483
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1478
1484
|
"Must be a valid GUID"
|
|
1479
1485
|
).optional().nullable(),
|
|
1480
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1486
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1481
1487
|
}).describe(
|
|
1482
1488
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1483
1489
|
).optional(),
|
|
1484
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1490
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1485
1491
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1486
1492
|
).optional(),
|
|
1487
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1488
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1489
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1490
|
-
seoData: z.object({
|
|
1491
|
-
tags: z.array(
|
|
1492
|
-
z.object({
|
|
1493
|
-
type: z.string().describe(
|
|
1493
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1494
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1495
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1496
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1497
|
+
tags: /* @__PURE__ */ z.array(
|
|
1498
|
+
/* @__PURE__ */ z.object({
|
|
1499
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1494
1500
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
1495
1501
|
).optional(),
|
|
1496
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1502
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1497
1503
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1498
1504
|
).optional().nullable(),
|
|
1499
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1505
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1500
1506
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1501
1507
|
).optional().nullable(),
|
|
1502
|
-
children: z.string().describe(
|
|
1508
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1503
1509
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1504
1510
|
).optional(),
|
|
1505
|
-
custom: z.boolean().describe(
|
|
1511
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1506
1512
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
1507
1513
|
).optional(),
|
|
1508
|
-
disabled: z.boolean().describe(
|
|
1514
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1509
1515
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1510
1516
|
).optional()
|
|
1511
1517
|
})
|
|
1512
1518
|
).optional(),
|
|
1513
|
-
settings: z.object({
|
|
1514
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1519
|
+
settings: /* @__PURE__ */ z.object({
|
|
1520
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1515
1521
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1516
1522
|
).optional(),
|
|
1517
|
-
keywords: z.array(
|
|
1518
|
-
z.object({
|
|
1519
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1520
|
-
isMain: z.boolean().describe(
|
|
1523
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1524
|
+
/* @__PURE__ */ z.object({
|
|
1525
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1526
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1521
1527
|
"Whether the keyword is the main focus keyword."
|
|
1522
1528
|
).optional(),
|
|
1523
|
-
origin: z.string().describe(
|
|
1529
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1524
1530
|
"The source that added the keyword terms to the SEO settings."
|
|
1525
1531
|
).max(1e3).optional().nullable()
|
|
1526
1532
|
})
|
|
1527
1533
|
).max(5).optional()
|
|
1528
1534
|
}).describe("SEO general settings.").optional()
|
|
1529
1535
|
}).describe("SEO data.").optional(),
|
|
1530
|
-
url: z.string().describe(
|
|
1536
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1531
1537
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1532
1538
|
).optional(),
|
|
1533
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1534
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1535
|
-
media: z.intersection(
|
|
1536
|
-
z.object({
|
|
1537
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1538
|
-
custom: z.boolean().describe(
|
|
1539
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1540
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1541
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1542
|
+
/* @__PURE__ */ z.object({
|
|
1543
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1544
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1539
1545
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1540
1546
|
).optional(),
|
|
1541
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1547
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1542
1548
|
}),
|
|
1543
|
-
z.xor([
|
|
1544
|
-
z.object({
|
|
1545
|
-
wixMedia: z.never().optional(),
|
|
1546
|
-
embedMedia: z.never().optional()
|
|
1549
|
+
/* @__PURE__ */ z.xor([
|
|
1550
|
+
/* @__PURE__ */ z.object({
|
|
1551
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1552
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1547
1553
|
}),
|
|
1548
|
-
z.object({
|
|
1549
|
-
embedMedia: z.never().optional(),
|
|
1550
|
-
wixMedia: z.object({
|
|
1551
|
-
image: z.string().describe("Image details.").optional(),
|
|
1552
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1554
|
+
/* @__PURE__ */ z.object({
|
|
1555
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1556
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1557
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1558
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1553
1559
|
}).describe("Wix Media details.")
|
|
1554
1560
|
}),
|
|
1555
|
-
z.object({
|
|
1556
|
-
wixMedia: z.never().optional(),
|
|
1557
|
-
embedMedia: z.object({
|
|
1558
|
-
thumbnail: z.object({
|
|
1559
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1560
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1561
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1561
|
+
/* @__PURE__ */ z.object({
|
|
1562
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1563
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1564
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1565
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1566
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1567
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1562
1568
|
}).describe("Thumbnail details.").optional(),
|
|
1563
|
-
video: z.object({
|
|
1564
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1565
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1566
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1569
|
+
video: /* @__PURE__ */ z.object({
|
|
1570
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1571
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1572
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1567
1573
|
}).describe("Video details.").optional()
|
|
1568
1574
|
}).describe("Embed media details.")
|
|
1569
1575
|
})
|
|
1570
1576
|
])
|
|
1571
1577
|
).describe("Post cover media.").optional(),
|
|
1572
|
-
previewTextParagraph: z.number().int().describe(
|
|
1578
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1573
1579
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1574
1580
|
).min(0).optional().nullable()
|
|
1575
1581
|
}).describe("Draft Post info."),
|
|
1576
|
-
options: z.object({
|
|
1577
|
-
action: z.enum([
|
|
1582
|
+
options: /* @__PURE__ */ z.object({
|
|
1583
|
+
action: /* @__PURE__ */ z.enum([
|
|
1578
1584
|
"UPDATE",
|
|
1579
1585
|
"UPDATE_PUBLISH",
|
|
1580
1586
|
"UPDATE_SCHEDULE",
|
|
@@ -1583,11 +1589,11 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1583
1589
|
"UPDATE_REJECT",
|
|
1584
1590
|
"UPDATE_PUBLICATION"
|
|
1585
1591
|
]).optional(),
|
|
1586
|
-
scheduledPublishDate: z.date().describe(
|
|
1592
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe(
|
|
1587
1593
|
"Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`."
|
|
1588
1594
|
).optional().nullable(),
|
|
1589
|
-
fieldsets: z.array(
|
|
1590
|
-
z.enum([
|
|
1595
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1596
|
+
/* @__PURE__ */ z.enum([
|
|
1591
1597
|
"UNKNOWN",
|
|
1592
1598
|
"URL",
|
|
1593
1599
|
"CONTENT",
|
|
@@ -1598,40 +1604,40 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1598
1604
|
}).describe("Options for updating a draft post.").optional()
|
|
1599
1605
|
});
|
|
1600
1606
|
var UpdateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
1601
|
-
draftPost: z.object({
|
|
1602
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1603
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1604
|
-
excerpt: z.string().describe(
|
|
1607
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1608
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1609
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1610
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1605
1611
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1606
1612
|
).max(500).optional().nullable(),
|
|
1607
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1608
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1609
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1613
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1614
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1615
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1610
1616
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1611
1617
|
"Must be a valid GUID"
|
|
1612
1618
|
).optional().nullable(),
|
|
1613
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1614
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1615
|
-
minutesToRead: z.number().int().describe(
|
|
1619
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1620
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1621
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1616
1622
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1617
1623
|
).optional(),
|
|
1618
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1619
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1620
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1621
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1622
|
-
translationId: z.string().describe(
|
|
1624
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1625
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1626
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1627
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1628
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1623
1629
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
1624
1630
|
).regex(
|
|
1625
1631
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1626
1632
|
"Must be a valid GUID"
|
|
1627
1633
|
).optional().nullable(),
|
|
1628
|
-
language: z.string().describe(
|
|
1634
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1629
1635
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
1630
1636
|
).optional().nullable(),
|
|
1631
|
-
richContent: z.any().describe(
|
|
1637
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1632
1638
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
1633
1639
|
).optional(),
|
|
1634
|
-
status: z.enum([
|
|
1640
|
+
status: /* @__PURE__ */ z.enum([
|
|
1635
1641
|
"UNKNOWN",
|
|
1636
1642
|
"PUBLISHED",
|
|
1637
1643
|
"UNPUBLISHED",
|
|
@@ -1639,192 +1645,192 @@ var UpdateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
1639
1645
|
"DELETED",
|
|
1640
1646
|
"IN_REVIEW"
|
|
1641
1647
|
]).describe("Status of the draft post.").optional(),
|
|
1642
|
-
moderationDetails: z.object({
|
|
1643
|
-
submittedBy: z.string().describe(
|
|
1648
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1649
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1644
1650
|
"Member ID of the person submitting the draft post for review."
|
|
1645
1651
|
).regex(
|
|
1646
1652
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1647
1653
|
"Must be a valid GUID"
|
|
1648
1654
|
).optional(),
|
|
1649
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1650
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1655
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1656
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1651
1657
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1652
1658
|
).optional(),
|
|
1653
|
-
moderatedBy: z.string().describe(
|
|
1659
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1654
1660
|
"Member ID of the person who approved or rejected the post."
|
|
1655
1661
|
).regex(
|
|
1656
1662
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1657
1663
|
"Must be a valid GUID"
|
|
1658
1664
|
).optional().nullable(),
|
|
1659
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1665
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1660
1666
|
}).describe(
|
|
1661
1667
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1662
1668
|
).optional(),
|
|
1663
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1669
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1664
1670
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1665
1671
|
).optional(),
|
|
1666
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1667
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1668
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1669
|
-
seoData: z.object({
|
|
1670
|
-
tags: z.array(
|
|
1671
|
-
z.object({
|
|
1672
|
-
type: z.string().describe(
|
|
1672
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1673
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1674
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1675
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1676
|
+
tags: /* @__PURE__ */ z.array(
|
|
1677
|
+
/* @__PURE__ */ z.object({
|
|
1678
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1673
1679
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
1674
1680
|
).optional(),
|
|
1675
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1681
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1676
1682
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1677
1683
|
).optional().nullable(),
|
|
1678
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1684
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1679
1685
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1680
1686
|
).optional().nullable(),
|
|
1681
|
-
children: z.string().describe(
|
|
1687
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1682
1688
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1683
1689
|
).optional(),
|
|
1684
|
-
custom: z.boolean().describe(
|
|
1690
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1685
1691
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
1686
1692
|
).optional(),
|
|
1687
|
-
disabled: z.boolean().describe(
|
|
1693
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1688
1694
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1689
1695
|
).optional()
|
|
1690
1696
|
})
|
|
1691
1697
|
).optional(),
|
|
1692
|
-
settings: z.object({
|
|
1693
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1698
|
+
settings: /* @__PURE__ */ z.object({
|
|
1699
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1694
1700
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1695
1701
|
).optional(),
|
|
1696
|
-
keywords: z.array(
|
|
1697
|
-
z.object({
|
|
1698
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1699
|
-
isMain: z.boolean().describe(
|
|
1702
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1703
|
+
/* @__PURE__ */ z.object({
|
|
1704
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1705
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1700
1706
|
"Whether the keyword is the main focus keyword."
|
|
1701
1707
|
).optional(),
|
|
1702
|
-
origin: z.string().describe(
|
|
1708
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1703
1709
|
"The source that added the keyword terms to the SEO settings."
|
|
1704
1710
|
).max(1e3).optional().nullable()
|
|
1705
1711
|
})
|
|
1706
1712
|
).max(5).optional()
|
|
1707
1713
|
}).describe("SEO general settings.").optional()
|
|
1708
1714
|
}).describe("SEO data.").optional(),
|
|
1709
|
-
url: z.string().describe(
|
|
1715
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1710
1716
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1711
1717
|
).optional(),
|
|
1712
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1713
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1714
|
-
media: z.intersection(
|
|
1715
|
-
z.object({
|
|
1716
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1717
|
-
custom: z.boolean().describe(
|
|
1718
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1719
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1720
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1721
|
+
/* @__PURE__ */ z.object({
|
|
1722
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1723
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1718
1724
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1719
1725
|
).optional(),
|
|
1720
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1726
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1721
1727
|
}),
|
|
1722
|
-
z.xor([
|
|
1723
|
-
z.object({
|
|
1724
|
-
wixMedia: z.never().optional(),
|
|
1725
|
-
embedMedia: z.never().optional()
|
|
1728
|
+
/* @__PURE__ */ z.xor([
|
|
1729
|
+
/* @__PURE__ */ z.object({
|
|
1730
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1731
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1726
1732
|
}),
|
|
1727
|
-
z.object({
|
|
1728
|
-
embedMedia: z.never().optional(),
|
|
1729
|
-
wixMedia: z.object({
|
|
1730
|
-
image: z.string().describe("Image details.").optional(),
|
|
1731
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1733
|
+
/* @__PURE__ */ z.object({
|
|
1734
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1735
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1736
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1737
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1732
1738
|
}).describe("Wix Media details.")
|
|
1733
1739
|
}),
|
|
1734
|
-
z.object({
|
|
1735
|
-
wixMedia: z.never().optional(),
|
|
1736
|
-
embedMedia: z.object({
|
|
1737
|
-
thumbnail: z.object({
|
|
1738
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1739
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1740
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1740
|
+
/* @__PURE__ */ z.object({
|
|
1741
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1742
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1743
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1744
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1745
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1746
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1741
1747
|
}).describe("Thumbnail details.").optional(),
|
|
1742
|
-
video: z.object({
|
|
1743
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1744
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1745
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1748
|
+
video: /* @__PURE__ */ z.object({
|
|
1749
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1750
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1751
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1746
1752
|
}).describe("Video details.").optional()
|
|
1747
1753
|
}).describe("Embed media details.")
|
|
1748
1754
|
})
|
|
1749
1755
|
])
|
|
1750
1756
|
).describe("Post cover media.").optional(),
|
|
1751
|
-
previewTextParagraph: z.number().int().describe(
|
|
1757
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1752
1758
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1753
1759
|
).min(0).optional().nullable()
|
|
1754
1760
|
}).describe("Updated draft post info.").optional()
|
|
1755
1761
|
});
|
|
1756
1762
|
var DeleteDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1757
|
-
draftPostId: z.string().describe("Draft post ID.").max(38),
|
|
1758
|
-
options: z.object({
|
|
1759
|
-
permanent: z.boolean().describe(
|
|
1763
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1764
|
+
options: /* @__PURE__ */ z.object({
|
|
1765
|
+
permanent: /* @__PURE__ */ z.boolean().describe(
|
|
1760
1766
|
"Whether to bypass the trash bin and delete the post permanently.\n\nDefault: `false`"
|
|
1761
1767
|
).optional()
|
|
1762
1768
|
}).describe("Options for deleting a draft post.").optional()
|
|
1763
1769
|
});
|
|
1764
1770
|
var DeleteDraftPostResponse = /* @__PURE__ */ z.object({});
|
|
1765
1771
|
var RemoveFromTrashBinRequest = /* @__PURE__ */ z.object({
|
|
1766
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
1772
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
1767
1773
|
});
|
|
1768
1774
|
var RemoveFromTrashBinResponse = /* @__PURE__ */ z.object({});
|
|
1769
1775
|
var BulkDeleteDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
1770
|
-
postIds: z.array(z.string()).min(1).max(100),
|
|
1771
|
-
options: z.object({
|
|
1772
|
-
permanent: z.boolean().describe("Should delete bypassing the trash-bin.").optional()
|
|
1776
|
+
postIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).min(1).max(100),
|
|
1777
|
+
options: /* @__PURE__ */ z.object({
|
|
1778
|
+
permanent: /* @__PURE__ */ z.boolean().describe("Should delete bypassing the trash-bin.").optional()
|
|
1773
1779
|
}).describe("Options for deleting multiple draft posts.").optional()
|
|
1774
1780
|
});
|
|
1775
1781
|
var BulkDeleteDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
1776
|
-
results: z.array(
|
|
1777
|
-
z.object({
|
|
1778
|
-
itemMetadata: z.object({
|
|
1779
|
-
_id: z.string().describe(
|
|
1782
|
+
results: /* @__PURE__ */ z.array(
|
|
1783
|
+
/* @__PURE__ */ z.object({
|
|
1784
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
1785
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
1780
1786
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
1781
1787
|
).optional().nullable(),
|
|
1782
|
-
originalIndex: z.number().int().describe(
|
|
1788
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
1783
1789
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
1784
1790
|
).optional(),
|
|
1785
|
-
success: z.boolean().describe(
|
|
1791
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
1786
1792
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
1787
1793
|
).optional(),
|
|
1788
|
-
error: z.object({
|
|
1789
|
-
code: z.string().describe("Error code.").optional(),
|
|
1790
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
1791
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
1794
|
+
error: /* @__PURE__ */ z.object({
|
|
1795
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
1796
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
1797
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
1792
1798
|
}).describe("Details about the error in case of failure.").optional()
|
|
1793
1799
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
1794
|
-
item: z.object({
|
|
1795
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1796
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1797
|
-
excerpt: z.string().describe(
|
|
1800
|
+
item: /* @__PURE__ */ z.object({
|
|
1801
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1802
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1803
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1798
1804
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1799
1805
|
).max(500).optional().nullable(),
|
|
1800
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1801
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1802
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1806
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1807
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1808
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1803
1809
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1804
1810
|
"Must be a valid GUID"
|
|
1805
1811
|
).optional().nullable(),
|
|
1806
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1807
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1808
|
-
minutesToRead: z.number().int().describe(
|
|
1812
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1813
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1814
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1809
1815
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1810
1816
|
).optional(),
|
|
1811
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1812
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1813
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1814
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1815
|
-
translationId: z.string().describe(
|
|
1817
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1818
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1819
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1820
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1821
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1816
1822
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
1817
1823
|
).regex(
|
|
1818
1824
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1819
1825
|
"Must be a valid GUID"
|
|
1820
1826
|
).optional().nullable(),
|
|
1821
|
-
language: z.string().describe(
|
|
1827
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1822
1828
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
1823
1829
|
).optional().nullable(),
|
|
1824
|
-
richContent: z.any().describe(
|
|
1830
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1825
1831
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
1826
1832
|
).optional(),
|
|
1827
|
-
status: z.enum([
|
|
1833
|
+
status: /* @__PURE__ */ z.enum([
|
|
1828
1834
|
"UNKNOWN",
|
|
1829
1835
|
"PUBLISHED",
|
|
1830
1836
|
"UNPUBLISHED",
|
|
@@ -1832,132 +1838,132 @@ var BulkDeleteDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1832
1838
|
"DELETED",
|
|
1833
1839
|
"IN_REVIEW"
|
|
1834
1840
|
]).describe("Status of the draft post.").optional(),
|
|
1835
|
-
moderationDetails: z.object({
|
|
1836
|
-
submittedBy: z.string().describe(
|
|
1841
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1842
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1837
1843
|
"Member ID of the person submitting the draft post for review."
|
|
1838
1844
|
).regex(
|
|
1839
1845
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1840
1846
|
"Must be a valid GUID"
|
|
1841
1847
|
).optional(),
|
|
1842
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1843
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1848
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1849
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1844
1850
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1845
1851
|
).optional(),
|
|
1846
|
-
moderatedBy: z.string().describe(
|
|
1852
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1847
1853
|
"Member ID of the person who approved or rejected the post."
|
|
1848
1854
|
).regex(
|
|
1849
1855
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1850
1856
|
"Must be a valid GUID"
|
|
1851
1857
|
).optional().nullable(),
|
|
1852
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1858
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1853
1859
|
}).describe(
|
|
1854
1860
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1855
1861
|
).optional(),
|
|
1856
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1862
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1857
1863
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1858
1864
|
).optional(),
|
|
1859
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1860
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1861
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1862
|
-
seoData: z.object({
|
|
1863
|
-
tags: z.array(
|
|
1864
|
-
z.object({
|
|
1865
|
-
type: z.string().describe(
|
|
1865
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1866
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1867
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1868
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1869
|
+
tags: /* @__PURE__ */ z.array(
|
|
1870
|
+
/* @__PURE__ */ z.object({
|
|
1871
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1866
1872
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
1867
1873
|
).optional(),
|
|
1868
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1874
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1869
1875
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1870
1876
|
).optional().nullable(),
|
|
1871
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1877
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1872
1878
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1873
1879
|
).optional().nullable(),
|
|
1874
|
-
children: z.string().describe(
|
|
1880
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1875
1881
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1876
1882
|
).optional(),
|
|
1877
|
-
custom: z.boolean().describe(
|
|
1883
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1878
1884
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
1879
1885
|
).optional(),
|
|
1880
|
-
disabled: z.boolean().describe(
|
|
1886
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1881
1887
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1882
1888
|
).optional()
|
|
1883
1889
|
})
|
|
1884
1890
|
).optional(),
|
|
1885
|
-
settings: z.object({
|
|
1886
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1891
|
+
settings: /* @__PURE__ */ z.object({
|
|
1892
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1887
1893
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1888
1894
|
).optional(),
|
|
1889
|
-
keywords: z.array(
|
|
1890
|
-
z.object({
|
|
1891
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1892
|
-
isMain: z.boolean().describe(
|
|
1895
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1896
|
+
/* @__PURE__ */ z.object({
|
|
1897
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1898
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1893
1899
|
"Whether the keyword is the main focus keyword."
|
|
1894
1900
|
).optional(),
|
|
1895
|
-
origin: z.string().describe(
|
|
1901
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1896
1902
|
"The source that added the keyword terms to the SEO settings."
|
|
1897
1903
|
).max(1e3).optional().nullable()
|
|
1898
1904
|
})
|
|
1899
1905
|
).max(5).optional()
|
|
1900
1906
|
}).describe("SEO general settings.").optional()
|
|
1901
1907
|
}).describe("SEO data.").optional(),
|
|
1902
|
-
url: z.string().describe(
|
|
1908
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1903
1909
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1904
1910
|
).optional(),
|
|
1905
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1906
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1907
|
-
media: z.intersection(
|
|
1908
|
-
z.object({
|
|
1909
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1910
|
-
custom: z.boolean().describe(
|
|
1911
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1912
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1913
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1914
|
+
/* @__PURE__ */ z.object({
|
|
1915
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1916
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1911
1917
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1912
1918
|
).optional(),
|
|
1913
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1919
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1914
1920
|
}),
|
|
1915
|
-
z.xor([
|
|
1916
|
-
z.object({
|
|
1917
|
-
wixMedia: z.never().optional(),
|
|
1918
|
-
embedMedia: z.never().optional()
|
|
1921
|
+
/* @__PURE__ */ z.xor([
|
|
1922
|
+
/* @__PURE__ */ z.object({
|
|
1923
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1924
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1919
1925
|
}),
|
|
1920
|
-
z.object({
|
|
1921
|
-
embedMedia: z.never().optional(),
|
|
1922
|
-
wixMedia: z.object({
|
|
1923
|
-
image: z.string().describe("Image details.").optional(),
|
|
1924
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1926
|
+
/* @__PURE__ */ z.object({
|
|
1927
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1928
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1929
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1930
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1925
1931
|
}).describe("Wix Media details.")
|
|
1926
1932
|
}),
|
|
1927
|
-
z.object({
|
|
1928
|
-
wixMedia: z.never().optional(),
|
|
1929
|
-
embedMedia: z.object({
|
|
1930
|
-
thumbnail: z.object({
|
|
1931
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1932
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1933
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1933
|
+
/* @__PURE__ */ z.object({
|
|
1934
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1935
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1936
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1937
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1938
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1939
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1934
1940
|
}).describe("Thumbnail details.").optional(),
|
|
1935
|
-
video: z.object({
|
|
1936
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1937
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1938
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1941
|
+
video: /* @__PURE__ */ z.object({
|
|
1942
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1943
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1944
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1939
1945
|
}).describe("Video details.").optional()
|
|
1940
1946
|
}).describe("Embed media details.")
|
|
1941
1947
|
})
|
|
1942
1948
|
])
|
|
1943
1949
|
).describe("Post cover media.").optional(),
|
|
1944
|
-
previewTextParagraph: z.number().int().describe(
|
|
1950
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1945
1951
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1946
1952
|
).min(0).optional().nullable()
|
|
1947
1953
|
}).describe("Optional full draft post.").optional()
|
|
1948
1954
|
})
|
|
1949
1955
|
).optional(),
|
|
1950
|
-
bulkActionMetadata: z.object({
|
|
1951
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1952
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1953
|
-
undetailedFailures: z.number().int().describe(
|
|
1956
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
1957
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1958
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1959
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
1954
1960
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
1955
1961
|
).optional()
|
|
1956
1962
|
}).describe("Bulk action metadata.").optional()
|
|
1957
1963
|
});
|
|
1958
1964
|
var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
1959
|
-
options: z.object({
|
|
1960
|
-
status: z.enum([
|
|
1965
|
+
options: /* @__PURE__ */ z.object({
|
|
1966
|
+
status: /* @__PURE__ */ z.enum([
|
|
1961
1967
|
"UNKNOWN",
|
|
1962
1968
|
"PUBLISHED",
|
|
1963
1969
|
"UNPUBLISHED",
|
|
@@ -1965,21 +1971,21 @@ var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
1965
1971
|
"DELETED",
|
|
1966
1972
|
"IN_REVIEW"
|
|
1967
1973
|
]).optional(),
|
|
1968
|
-
language: z.string().describe(
|
|
1974
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1969
1975
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf omitted, draft posts in all languages are returned."
|
|
1970
1976
|
).optional().nullable(),
|
|
1971
|
-
sort: z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1972
|
-
paging: z.object({
|
|
1973
|
-
offset: z.number().int().describe(
|
|
1977
|
+
sort: /* @__PURE__ */ z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1978
|
+
paging: /* @__PURE__ */ z.object({
|
|
1979
|
+
offset: /* @__PURE__ */ z.number().int().describe(
|
|
1974
1980
|
"Number of items to skip in the current sort order.\n\n\nDefault: `0`"
|
|
1975
1981
|
).min(0).optional(),
|
|
1976
|
-
limit: z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1977
|
-
cursor: z.string().describe(
|
|
1982
|
+
limit: /* @__PURE__ */ z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1983
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
1978
1984
|
"Pointer to the next or previous page in the list of results."
|
|
1979
1985
|
).max(2e3).optional().nullable()
|
|
1980
1986
|
}).describe("Pagination options.").optional(),
|
|
1981
|
-
fieldsets: z.array(
|
|
1982
|
-
z.enum([
|
|
1987
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1988
|
+
/* @__PURE__ */ z.enum([
|
|
1983
1989
|
"UNKNOWN",
|
|
1984
1990
|
"URL",
|
|
1985
1991
|
"CONTENT",
|
|
@@ -1990,41 +1996,41 @@ var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
1990
1996
|
}).describe("Options for listing multiple draft posts.").optional()
|
|
1991
1997
|
});
|
|
1992
1998
|
var ListDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
1993
|
-
draftPosts: z.array(
|
|
1994
|
-
z.object({
|
|
1995
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1996
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1997
|
-
excerpt: z.string().describe(
|
|
1999
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
2000
|
+
/* @__PURE__ */ z.object({
|
|
2001
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2002
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2003
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1998
2004
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
1999
2005
|
).max(500).optional().nullable(),
|
|
2000
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2001
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2002
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2006
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2007
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2008
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2003
2009
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2004
2010
|
"Must be a valid GUID"
|
|
2005
2011
|
).optional().nullable(),
|
|
2006
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2007
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2008
|
-
minutesToRead: z.number().int().describe(
|
|
2012
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2013
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2014
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2009
2015
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2010
2016
|
).optional(),
|
|
2011
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2012
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2013
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2014
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2015
|
-
translationId: z.string().describe(
|
|
2017
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2018
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2019
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2020
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2021
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2016
2022
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
2017
2023
|
).regex(
|
|
2018
2024
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2019
2025
|
"Must be a valid GUID"
|
|
2020
2026
|
).optional().nullable(),
|
|
2021
|
-
language: z.string().describe(
|
|
2027
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2022
2028
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
2023
2029
|
).optional().nullable(),
|
|
2024
|
-
richContent: z.any().describe(
|
|
2030
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2025
2031
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
2026
2032
|
).optional(),
|
|
2027
|
-
status: z.enum([
|
|
2033
|
+
status: /* @__PURE__ */ z.enum([
|
|
2028
2034
|
"UNKNOWN",
|
|
2029
2035
|
"PUBLISHED",
|
|
2030
2036
|
"UNPUBLISHED",
|
|
@@ -2032,167 +2038,167 @@ var ListDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2032
2038
|
"DELETED",
|
|
2033
2039
|
"IN_REVIEW"
|
|
2034
2040
|
]).describe("Status of the draft post.").optional(),
|
|
2035
|
-
moderationDetails: z.object({
|
|
2036
|
-
submittedBy: z.string().describe(
|
|
2041
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2042
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2037
2043
|
"Member ID of the person submitting the draft post for review."
|
|
2038
2044
|
).regex(
|
|
2039
2045
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2040
2046
|
"Must be a valid GUID"
|
|
2041
2047
|
).optional(),
|
|
2042
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2043
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2048
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2049
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2044
2050
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2045
2051
|
).optional(),
|
|
2046
|
-
moderatedBy: z.string().describe(
|
|
2052
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2047
2053
|
"Member ID of the person who approved or rejected the post."
|
|
2048
2054
|
).regex(
|
|
2049
2055
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2050
2056
|
"Must be a valid GUID"
|
|
2051
2057
|
).optional().nullable(),
|
|
2052
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2058
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2053
2059
|
}).describe(
|
|
2054
2060
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2055
2061
|
).optional(),
|
|
2056
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2062
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2057
2063
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2058
2064
|
).optional(),
|
|
2059
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2060
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2061
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2062
|
-
seoData: z.object({
|
|
2063
|
-
tags: z.array(
|
|
2064
|
-
z.object({
|
|
2065
|
-
type: z.string().describe(
|
|
2065
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2066
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2067
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2068
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2069
|
+
tags: /* @__PURE__ */ z.array(
|
|
2070
|
+
/* @__PURE__ */ z.object({
|
|
2071
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2066
2072
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
2067
2073
|
).optional(),
|
|
2068
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2074
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2069
2075
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2070
2076
|
).optional().nullable(),
|
|
2071
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2077
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2072
2078
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2073
2079
|
).optional().nullable(),
|
|
2074
|
-
children: z.string().describe(
|
|
2080
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2075
2081
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2076
2082
|
).optional(),
|
|
2077
|
-
custom: z.boolean().describe(
|
|
2083
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2078
2084
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
2079
2085
|
).optional(),
|
|
2080
|
-
disabled: z.boolean().describe(
|
|
2086
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2081
2087
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2082
2088
|
).optional()
|
|
2083
2089
|
})
|
|
2084
2090
|
).optional(),
|
|
2085
|
-
settings: z.object({
|
|
2086
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2091
|
+
settings: /* @__PURE__ */ z.object({
|
|
2092
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2087
2093
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2088
2094
|
).optional(),
|
|
2089
|
-
keywords: z.array(
|
|
2090
|
-
z.object({
|
|
2091
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2092
|
-
isMain: z.boolean().describe(
|
|
2095
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2096
|
+
/* @__PURE__ */ z.object({
|
|
2097
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2098
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2093
2099
|
"Whether the keyword is the main focus keyword."
|
|
2094
2100
|
).optional(),
|
|
2095
|
-
origin: z.string().describe(
|
|
2101
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2096
2102
|
"The source that added the keyword terms to the SEO settings."
|
|
2097
2103
|
).max(1e3).optional().nullable()
|
|
2098
2104
|
})
|
|
2099
2105
|
).max(5).optional()
|
|
2100
2106
|
}).describe("SEO general settings.").optional()
|
|
2101
2107
|
}).describe("SEO data.").optional(),
|
|
2102
|
-
url: z.string().describe(
|
|
2108
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2103
2109
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2104
2110
|
).optional(),
|
|
2105
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2106
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2107
|
-
media: z.intersection(
|
|
2108
|
-
z.object({
|
|
2109
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2110
|
-
custom: z.boolean().describe(
|
|
2111
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2112
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2113
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2114
|
+
/* @__PURE__ */ z.object({
|
|
2115
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2116
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2111
2117
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2112
2118
|
).optional(),
|
|
2113
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2119
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2114
2120
|
}),
|
|
2115
|
-
z.xor([
|
|
2116
|
-
z.object({
|
|
2117
|
-
wixMedia: z.never().optional(),
|
|
2118
|
-
embedMedia: z.never().optional()
|
|
2121
|
+
/* @__PURE__ */ z.xor([
|
|
2122
|
+
/* @__PURE__ */ z.object({
|
|
2123
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2124
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2119
2125
|
}),
|
|
2120
|
-
z.object({
|
|
2121
|
-
embedMedia: z.never().optional(),
|
|
2122
|
-
wixMedia: z.object({
|
|
2123
|
-
image: z.string().describe("Image details.").optional(),
|
|
2124
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2126
|
+
/* @__PURE__ */ z.object({
|
|
2127
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2128
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2129
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2130
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2125
2131
|
}).describe("Wix Media details.")
|
|
2126
2132
|
}),
|
|
2127
|
-
z.object({
|
|
2128
|
-
wixMedia: z.never().optional(),
|
|
2129
|
-
embedMedia: z.object({
|
|
2130
|
-
thumbnail: z.object({
|
|
2131
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2132
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2133
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2133
|
+
/* @__PURE__ */ z.object({
|
|
2134
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2135
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2136
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2137
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2138
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2139
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2134
2140
|
}).describe("Thumbnail details.").optional(),
|
|
2135
|
-
video: z.object({
|
|
2136
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2137
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2138
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2141
|
+
video: /* @__PURE__ */ z.object({
|
|
2142
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2143
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2144
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2139
2145
|
}).describe("Video details.").optional()
|
|
2140
2146
|
}).describe("Embed media details.")
|
|
2141
2147
|
})
|
|
2142
2148
|
])
|
|
2143
2149
|
).describe("Post cover media.").optional(),
|
|
2144
|
-
previewTextParagraph: z.number().int().describe(
|
|
2150
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2145
2151
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2146
2152
|
).min(0).optional().nullable()
|
|
2147
2153
|
})
|
|
2148
2154
|
).optional(),
|
|
2149
|
-
metaData: z.object({
|
|
2150
|
-
count: z.number().int().describe("Number of items returned in this response.").optional(),
|
|
2151
|
-
offset: z.number().int().describe("Requested offset.").optional(),
|
|
2152
|
-
total: z.number().int().describe("Total number of items that match the query.").optional(),
|
|
2153
|
-
cursor: z.string().describe(
|
|
2155
|
+
metaData: /* @__PURE__ */ z.object({
|
|
2156
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in this response.").optional(),
|
|
2157
|
+
offset: /* @__PURE__ */ z.number().int().describe("Requested offset.").optional(),
|
|
2158
|
+
total: /* @__PURE__ */ z.number().int().describe("Total number of items that match the query.").optional(),
|
|
2159
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
2154
2160
|
"Pointer to the next or previous page in the list of results."
|
|
2155
2161
|
).max(2e3).optional().nullable()
|
|
2156
2162
|
}).describe("Details on the paged set of results returned.").optional()
|
|
2157
2163
|
});
|
|
2158
2164
|
var GetDeletedDraftPostRequest = /* @__PURE__ */ z.object({
|
|
2159
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2165
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2160
2166
|
});
|
|
2161
2167
|
var GetDeletedDraftPostResponse = /* @__PURE__ */ z.object({
|
|
2162
|
-
draftPost: z.object({
|
|
2163
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2164
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2165
|
-
excerpt: z.string().describe(
|
|
2168
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
2169
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2170
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2171
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2166
2172
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
2167
2173
|
).max(500).optional().nullable(),
|
|
2168
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2169
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2170
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2174
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2175
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2176
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2171
2177
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2172
2178
|
"Must be a valid GUID"
|
|
2173
2179
|
).optional().nullable(),
|
|
2174
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2175
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2176
|
-
minutesToRead: z.number().int().describe(
|
|
2180
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2181
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2182
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2177
2183
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2178
2184
|
).optional(),
|
|
2179
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2180
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2181
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2182
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2183
|
-
translationId: z.string().describe(
|
|
2185
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2186
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2187
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2188
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2189
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2184
2190
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
2185
2191
|
).regex(
|
|
2186
2192
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2187
2193
|
"Must be a valid GUID"
|
|
2188
2194
|
).optional().nullable(),
|
|
2189
|
-
language: z.string().describe(
|
|
2195
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2190
2196
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
2191
2197
|
).optional().nullable(),
|
|
2192
|
-
richContent: z.any().describe(
|
|
2198
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2193
2199
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
2194
2200
|
).optional(),
|
|
2195
|
-
status: z.enum([
|
|
2201
|
+
status: /* @__PURE__ */ z.enum([
|
|
2196
2202
|
"UNKNOWN",
|
|
2197
2203
|
"PUBLISHED",
|
|
2198
2204
|
"UNPUBLISHED",
|
|
@@ -2200,158 +2206,158 @@ var GetDeletedDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
2200
2206
|
"DELETED",
|
|
2201
2207
|
"IN_REVIEW"
|
|
2202
2208
|
]).describe("Status of the draft post.").optional(),
|
|
2203
|
-
moderationDetails: z.object({
|
|
2204
|
-
submittedBy: z.string().describe(
|
|
2209
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2210
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2205
2211
|
"Member ID of the person submitting the draft post for review."
|
|
2206
2212
|
).regex(
|
|
2207
2213
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2208
2214
|
"Must be a valid GUID"
|
|
2209
2215
|
).optional(),
|
|
2210
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2211
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2216
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2217
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2212
2218
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2213
2219
|
).optional(),
|
|
2214
|
-
moderatedBy: z.string().describe(
|
|
2220
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2215
2221
|
"Member ID of the person who approved or rejected the post."
|
|
2216
2222
|
).regex(
|
|
2217
2223
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2218
2224
|
"Must be a valid GUID"
|
|
2219
2225
|
).optional().nullable(),
|
|
2220
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2226
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2221
2227
|
}).describe(
|
|
2222
2228
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2223
2229
|
).optional(),
|
|
2224
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2230
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2225
2231
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2226
2232
|
).optional(),
|
|
2227
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2228
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2229
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2230
|
-
seoData: z.object({
|
|
2231
|
-
tags: z.array(
|
|
2232
|
-
z.object({
|
|
2233
|
-
type: z.string().describe(
|
|
2233
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2234
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2235
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2236
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2237
|
+
tags: /* @__PURE__ */ z.array(
|
|
2238
|
+
/* @__PURE__ */ z.object({
|
|
2239
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2234
2240
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
2235
2241
|
).optional(),
|
|
2236
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2242
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2237
2243
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2238
2244
|
).optional().nullable(),
|
|
2239
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2245
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2240
2246
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2241
2247
|
).optional().nullable(),
|
|
2242
|
-
children: z.string().describe(
|
|
2248
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2243
2249
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2244
2250
|
).optional(),
|
|
2245
|
-
custom: z.boolean().describe(
|
|
2251
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2246
2252
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
2247
2253
|
).optional(),
|
|
2248
|
-
disabled: z.boolean().describe(
|
|
2254
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2249
2255
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2250
2256
|
).optional()
|
|
2251
2257
|
})
|
|
2252
2258
|
).optional(),
|
|
2253
|
-
settings: z.object({
|
|
2254
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2259
|
+
settings: /* @__PURE__ */ z.object({
|
|
2260
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2255
2261
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2256
2262
|
).optional(),
|
|
2257
|
-
keywords: z.array(
|
|
2258
|
-
z.object({
|
|
2259
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2260
|
-
isMain: z.boolean().describe(
|
|
2263
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2264
|
+
/* @__PURE__ */ z.object({
|
|
2265
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2266
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2261
2267
|
"Whether the keyword is the main focus keyword."
|
|
2262
2268
|
).optional(),
|
|
2263
|
-
origin: z.string().describe(
|
|
2269
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2264
2270
|
"The source that added the keyword terms to the SEO settings."
|
|
2265
2271
|
).max(1e3).optional().nullable()
|
|
2266
2272
|
})
|
|
2267
2273
|
).max(5).optional()
|
|
2268
2274
|
}).describe("SEO general settings.").optional()
|
|
2269
2275
|
}).describe("SEO data.").optional(),
|
|
2270
|
-
url: z.string().describe(
|
|
2276
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2271
2277
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2272
2278
|
).optional(),
|
|
2273
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2274
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2275
|
-
media: z.intersection(
|
|
2276
|
-
z.object({
|
|
2277
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2278
|
-
custom: z.boolean().describe(
|
|
2279
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2280
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2281
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2282
|
+
/* @__PURE__ */ z.object({
|
|
2283
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2284
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2279
2285
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2280
2286
|
).optional(),
|
|
2281
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2287
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2282
2288
|
}),
|
|
2283
|
-
z.xor([
|
|
2284
|
-
z.object({
|
|
2285
|
-
wixMedia: z.never().optional(),
|
|
2286
|
-
embedMedia: z.never().optional()
|
|
2289
|
+
/* @__PURE__ */ z.xor([
|
|
2290
|
+
/* @__PURE__ */ z.object({
|
|
2291
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2292
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2287
2293
|
}),
|
|
2288
|
-
z.object({
|
|
2289
|
-
embedMedia: z.never().optional(),
|
|
2290
|
-
wixMedia: z.object({
|
|
2291
|
-
image: z.string().describe("Image details.").optional(),
|
|
2292
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2294
|
+
/* @__PURE__ */ z.object({
|
|
2295
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2296
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2297
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2298
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2293
2299
|
}).describe("Wix Media details.")
|
|
2294
2300
|
}),
|
|
2295
|
-
z.object({
|
|
2296
|
-
wixMedia: z.never().optional(),
|
|
2297
|
-
embedMedia: z.object({
|
|
2298
|
-
thumbnail: z.object({
|
|
2299
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2300
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2301
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2301
|
+
/* @__PURE__ */ z.object({
|
|
2302
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2303
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2304
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2305
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2306
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2307
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2302
2308
|
}).describe("Thumbnail details.").optional(),
|
|
2303
|
-
video: z.object({
|
|
2304
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2305
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2306
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2309
|
+
video: /* @__PURE__ */ z.object({
|
|
2310
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2311
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2312
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2307
2313
|
}).describe("Video details.").optional()
|
|
2308
2314
|
}).describe("Embed media details.")
|
|
2309
2315
|
})
|
|
2310
2316
|
])
|
|
2311
2317
|
).describe("Post cover media.").optional(),
|
|
2312
|
-
previewTextParagraph: z.number().int().describe(
|
|
2318
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2313
2319
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2314
2320
|
).min(0).optional().nullable()
|
|
2315
2321
|
}).describe("Draft post info.").optional()
|
|
2316
2322
|
});
|
|
2317
2323
|
var RestoreFromTrashBinRequest = /* @__PURE__ */ z.object({
|
|
2318
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2324
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2319
2325
|
});
|
|
2320
2326
|
var RestoreFromTrashBinResponse = /* @__PURE__ */ z.object({
|
|
2321
|
-
draftPost: z.object({
|
|
2322
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2323
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2324
|
-
excerpt: z.string().describe(
|
|
2327
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
2328
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2329
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2330
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2325
2331
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
2326
2332
|
).max(500).optional().nullable(),
|
|
2327
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2328
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2329
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2333
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2334
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2335
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2330
2336
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2331
2337
|
"Must be a valid GUID"
|
|
2332
2338
|
).optional().nullable(),
|
|
2333
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2334
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2335
|
-
minutesToRead: z.number().int().describe(
|
|
2339
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2340
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2341
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2336
2342
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2337
2343
|
).optional(),
|
|
2338
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2339
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2340
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2341
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2342
|
-
translationId: z.string().describe(
|
|
2344
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2345
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2346
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2347
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2348
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2343
2349
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
2344
2350
|
).regex(
|
|
2345
2351
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2346
2352
|
"Must be a valid GUID"
|
|
2347
2353
|
).optional().nullable(),
|
|
2348
|
-
language: z.string().describe(
|
|
2354
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2349
2355
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
2350
2356
|
).optional().nullable(),
|
|
2351
|
-
richContent: z.any().describe(
|
|
2357
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2352
2358
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
2353
2359
|
).optional(),
|
|
2354
|
-
status: z.enum([
|
|
2360
|
+
status: /* @__PURE__ */ z.enum([
|
|
2355
2361
|
"UNKNOWN",
|
|
2356
2362
|
"PUBLISHED",
|
|
2357
2363
|
"UNPUBLISHED",
|
|
@@ -2359,225 +2365,234 @@ var RestoreFromTrashBinResponse = /* @__PURE__ */ z.object({
|
|
|
2359
2365
|
"DELETED",
|
|
2360
2366
|
"IN_REVIEW"
|
|
2361
2367
|
]).describe("Status of the draft post.").optional(),
|
|
2362
|
-
moderationDetails: z.object({
|
|
2363
|
-
submittedBy: z.string().describe(
|
|
2368
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2369
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2364
2370
|
"Member ID of the person submitting the draft post for review."
|
|
2365
2371
|
).regex(
|
|
2366
2372
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2367
2373
|
"Must be a valid GUID"
|
|
2368
2374
|
).optional(),
|
|
2369
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2370
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2375
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2376
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2371
2377
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2372
2378
|
).optional(),
|
|
2373
|
-
moderatedBy: z.string().describe(
|
|
2379
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2374
2380
|
"Member ID of the person who approved or rejected the post."
|
|
2375
2381
|
).regex(
|
|
2376
2382
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2377
2383
|
"Must be a valid GUID"
|
|
2378
2384
|
).optional().nullable(),
|
|
2379
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2385
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2380
2386
|
}).describe(
|
|
2381
2387
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2382
2388
|
).optional(),
|
|
2383
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2389
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2384
2390
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2385
2391
|
).optional(),
|
|
2386
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2387
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2388
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2389
|
-
seoData: z.object({
|
|
2390
|
-
tags: z.array(
|
|
2391
|
-
z.object({
|
|
2392
|
-
type: z.string().describe(
|
|
2392
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2393
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2394
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2395
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2396
|
+
tags: /* @__PURE__ */ z.array(
|
|
2397
|
+
/* @__PURE__ */ z.object({
|
|
2398
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2393
2399
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
2394
2400
|
).optional(),
|
|
2395
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2401
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2396
2402
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2397
2403
|
).optional().nullable(),
|
|
2398
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2404
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2399
2405
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2400
2406
|
).optional().nullable(),
|
|
2401
|
-
children: z.string().describe(
|
|
2407
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2402
2408
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2403
2409
|
).optional(),
|
|
2404
|
-
custom: z.boolean().describe(
|
|
2410
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2405
2411
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
2406
2412
|
).optional(),
|
|
2407
|
-
disabled: z.boolean().describe(
|
|
2413
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2408
2414
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2409
2415
|
).optional()
|
|
2410
2416
|
})
|
|
2411
2417
|
).optional(),
|
|
2412
|
-
settings: z.object({
|
|
2413
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2418
|
+
settings: /* @__PURE__ */ z.object({
|
|
2419
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2414
2420
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2415
2421
|
).optional(),
|
|
2416
|
-
keywords: z.array(
|
|
2417
|
-
z.object({
|
|
2418
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2419
|
-
isMain: z.boolean().describe(
|
|
2422
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2423
|
+
/* @__PURE__ */ z.object({
|
|
2424
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2425
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2420
2426
|
"Whether the keyword is the main focus keyword."
|
|
2421
2427
|
).optional(),
|
|
2422
|
-
origin: z.string().describe(
|
|
2428
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2423
2429
|
"The source that added the keyword terms to the SEO settings."
|
|
2424
2430
|
).max(1e3).optional().nullable()
|
|
2425
2431
|
})
|
|
2426
2432
|
).max(5).optional()
|
|
2427
2433
|
}).describe("SEO general settings.").optional()
|
|
2428
2434
|
}).describe("SEO data.").optional(),
|
|
2429
|
-
url: z.string().describe(
|
|
2435
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2430
2436
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2431
2437
|
).optional(),
|
|
2432
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2433
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2434
|
-
media: z.intersection(
|
|
2435
|
-
z.object({
|
|
2436
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2437
|
-
custom: z.boolean().describe(
|
|
2438
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2439
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2440
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2441
|
+
/* @__PURE__ */ z.object({
|
|
2442
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2443
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2438
2444
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2439
2445
|
).optional(),
|
|
2440
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2446
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2441
2447
|
}),
|
|
2442
|
-
z.xor([
|
|
2443
|
-
z.object({
|
|
2444
|
-
wixMedia: z.never().optional(),
|
|
2445
|
-
embedMedia: z.never().optional()
|
|
2448
|
+
/* @__PURE__ */ z.xor([
|
|
2449
|
+
/* @__PURE__ */ z.object({
|
|
2450
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2451
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2446
2452
|
}),
|
|
2447
|
-
z.object({
|
|
2448
|
-
embedMedia: z.never().optional(),
|
|
2449
|
-
wixMedia: z.object({
|
|
2450
|
-
image: z.string().describe("Image details.").optional(),
|
|
2451
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2453
|
+
/* @__PURE__ */ z.object({
|
|
2454
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2455
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2456
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2457
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2452
2458
|
}).describe("Wix Media details.")
|
|
2453
2459
|
}),
|
|
2454
|
-
z.object({
|
|
2455
|
-
wixMedia: z.never().optional(),
|
|
2456
|
-
embedMedia: z.object({
|
|
2457
|
-
thumbnail: z.object({
|
|
2458
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2459
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2460
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2460
|
+
/* @__PURE__ */ z.object({
|
|
2461
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2462
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2463
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2464
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2465
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2466
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2461
2467
|
}).describe("Thumbnail details.").optional(),
|
|
2462
|
-
video: z.object({
|
|
2463
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2464
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2465
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2468
|
+
video: /* @__PURE__ */ z.object({
|
|
2469
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2470
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2471
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2466
2472
|
}).describe("Video details.").optional()
|
|
2467
2473
|
}).describe("Embed media details.")
|
|
2468
2474
|
})
|
|
2469
2475
|
])
|
|
2470
2476
|
).describe("Post cover media.").optional(),
|
|
2471
|
-
previewTextParagraph: z.number().int().describe(
|
|
2477
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2472
2478
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2473
2479
|
).min(0).optional().nullable()
|
|
2474
2480
|
}).describe("Restored draft post info.").optional()
|
|
2475
2481
|
});
|
|
2476
2482
|
var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
2477
|
-
query: z.object({
|
|
2478
|
-
filter: z.object({
|
|
2479
|
-
_id: z.object({
|
|
2480
|
-
$eq: z.string(),
|
|
2481
|
-
$in: z.array(z.string()),
|
|
2482
|
-
$ne: z.string(),
|
|
2483
|
-
$nin: z.array(z.string())
|
|
2483
|
+
query: /* @__PURE__ */ z.object({
|
|
2484
|
+
filter: /* @__PURE__ */ z.object({
|
|
2485
|
+
_id: /* @__PURE__ */ z.object({
|
|
2486
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2487
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2488
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2489
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2484
2490
|
}).partial().strict().optional(),
|
|
2485
|
-
title: z.object({
|
|
2486
|
-
$eq: z.string(),
|
|
2487
|
-
$exists: z.boolean(),
|
|
2488
|
-
$gt: z.string(),
|
|
2489
|
-
$gte: z.string(),
|
|
2490
|
-
$in: z.array(z.string()),
|
|
2491
|
-
$lt: z.string(),
|
|
2492
|
-
$lte: z.string(),
|
|
2493
|
-
$ne: z.string(),
|
|
2494
|
-
$startsWith: z.string()
|
|
2491
|
+
title: /* @__PURE__ */ z.object({
|
|
2492
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2493
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2494
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2495
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2496
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2497
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2498
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2499
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2500
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2495
2501
|
}).partial().strict().optional(),
|
|
2496
|
-
excerpt: z.object({
|
|
2497
|
-
$eq: z.string(),
|
|
2498
|
-
$exists: z.boolean(),
|
|
2499
|
-
$gt: z.string(),
|
|
2500
|
-
$gte: z.string(),
|
|
2501
|
-
$in: z.array(z.string()),
|
|
2502
|
-
$lt: z.string(),
|
|
2503
|
-
$lte: z.string(),
|
|
2504
|
-
$ne: z.string(),
|
|
2505
|
-
$startsWith: z.string()
|
|
2502
|
+
excerpt: /* @__PURE__ */ z.object({
|
|
2503
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2504
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2505
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2506
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2507
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2508
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2509
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2510
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2511
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2506
2512
|
}).partial().strict().optional(),
|
|
2507
|
-
status: z.object({
|
|
2508
|
-
$eq: z.string(),
|
|
2509
|
-
$in: z.array(z.string()),
|
|
2510
|
-
$ne: z.string(),
|
|
2511
|
-
$nin: z.array(z.string())
|
|
2513
|
+
status: /* @__PURE__ */ z.object({
|
|
2514
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2515
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2516
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2517
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2512
2518
|
}).partial().strict().optional(),
|
|
2513
|
-
scheduledPublishDate: z.object({
|
|
2514
|
-
$eq: z.string(),
|
|
2515
|
-
$gt: z.string(),
|
|
2516
|
-
$gte: z.string(),
|
|
2517
|
-
$in: z.array(z.string()),
|
|
2518
|
-
$lt: z.string(),
|
|
2519
|
-
$lte: z.string(),
|
|
2520
|
-
$ne: z.string()
|
|
2519
|
+
scheduledPublishDate: /* @__PURE__ */ z.object({
|
|
2520
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2521
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2522
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2523
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2524
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2525
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2526
|
+
$ne: /* @__PURE__ */ z.string()
|
|
2521
2527
|
}).partial().strict().optional(),
|
|
2522
|
-
editedDate: z.object({
|
|
2523
|
-
$eq: z.string(),
|
|
2524
|
-
$gt: z.string(),
|
|
2525
|
-
$gte: z.string(),
|
|
2526
|
-
$in: z.array(z.string()),
|
|
2527
|
-
$lt: z.string(),
|
|
2528
|
-
$lte: z.string(),
|
|
2529
|
-
$ne: z.string()
|
|
2528
|
+
editedDate: /* @__PURE__ */ z.object({
|
|
2529
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2530
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2531
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2532
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2533
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2534
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2535
|
+
$ne: /* @__PURE__ */ z.string()
|
|
2530
2536
|
}).partial().strict().optional(),
|
|
2531
|
-
categoryIds: z.object({
|
|
2532
|
-
$hasAll: z.array(z.string()),
|
|
2533
|
-
$hasSome: z.array(z.string())
|
|
2537
|
+
categoryIds: /* @__PURE__ */ z.object({
|
|
2538
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2539
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2534
2540
|
}).partial().strict().optional(),
|
|
2535
|
-
hashtags: z.object({
|
|
2536
|
-
$hasAll: z.array(z.string()),
|
|
2537
|
-
$hasSome: z.array(z.string())
|
|
2541
|
+
hashtags: /* @__PURE__ */ z.object({
|
|
2542
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2543
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2538
2544
|
}).partial().strict().optional(),
|
|
2539
|
-
tagIds: z.object({
|
|
2540
|
-
$hasAll: z.array(z.string()),
|
|
2541
|
-
$hasSome: z.array(z.string())
|
|
2545
|
+
tagIds: /* @__PURE__ */ z.object({
|
|
2546
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2547
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2542
2548
|
}).partial().strict().optional(),
|
|
2543
|
-
pricingPlanIds: z.object({
|
|
2544
|
-
$hasAll: z.array(z.string()),
|
|
2545
|
-
$hasSome: z.array(z.string())
|
|
2549
|
+
pricingPlanIds: /* @__PURE__ */ z.object({
|
|
2550
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2551
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2546
2552
|
}).partial().strict().optional(),
|
|
2547
|
-
memberId: z.object({}).partial().strict().optional(),
|
|
2548
|
-
featured:
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
minutesToRead: z.object({
|
|
2552
|
-
$eq: z.number(),
|
|
2553
|
-
$gt: z.number(),
|
|
2554
|
-
$gte: z.number(),
|
|
2555
|
-
$in: z.array(z.number()),
|
|
2556
|
-
$lt: z.number(),
|
|
2557
|
-
$lte: z.number(),
|
|
2558
|
-
$ne: z.number()
|
|
2553
|
+
memberId: /* @__PURE__ */ z.object({}).partial().strict().optional(),
|
|
2554
|
+
featured: /* @__PURE__ */ z.object({
|
|
2555
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2556
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2559
2557
|
}).partial().strict().optional(),
|
|
2560
|
-
|
|
2561
|
-
$eq: z.
|
|
2562
|
-
$
|
|
2563
|
-
$in: z.array(z.string()),
|
|
2564
|
-
$ne: z.string(),
|
|
2565
|
-
$nin: z.array(z.string())
|
|
2558
|
+
commentingEnabled: /* @__PURE__ */ z.object({
|
|
2559
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2560
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2566
2561
|
}).partial().strict().optional(),
|
|
2567
|
-
|
|
2568
|
-
$eq: z.
|
|
2569
|
-
$
|
|
2570
|
-
$in: z.array(z.string()),
|
|
2571
|
-
$ne: z.string(),
|
|
2572
|
-
$nin: z.array(z.string())
|
|
2562
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.object({
|
|
2563
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2564
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2573
2565
|
}).partial().strict().optional(),
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
|
|
2566
|
+
minutesToRead: /* @__PURE__ */ z.object({
|
|
2567
|
+
$eq: /* @__PURE__ */ z.number(),
|
|
2568
|
+
$gt: /* @__PURE__ */ z.number(),
|
|
2569
|
+
$gte: /* @__PURE__ */ z.number(),
|
|
2570
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.number()),
|
|
2571
|
+
$lt: /* @__PURE__ */ z.number(),
|
|
2572
|
+
$lte: /* @__PURE__ */ z.number(),
|
|
2573
|
+
$ne: /* @__PURE__ */ z.number()
|
|
2574
|
+
}).partial().strict().optional(),
|
|
2575
|
+
language: /* @__PURE__ */ z.object({
|
|
2576
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2577
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2578
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2579
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2580
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2581
|
+
}).partial().strict().optional(),
|
|
2582
|
+
translationId: /* @__PURE__ */ z.object({
|
|
2583
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2584
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2585
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2586
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2587
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2588
|
+
}).partial().strict().optional(),
|
|
2589
|
+
$and: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2590
|
+
$or: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2591
|
+
$not: /* @__PURE__ */ z.any().optional()
|
|
2577
2592
|
}).strict().optional(),
|
|
2578
|
-
sort: z.array(
|
|
2579
|
-
z.object({
|
|
2580
|
-
fieldName: z.enum([
|
|
2593
|
+
sort: /* @__PURE__ */ z.array(
|
|
2594
|
+
/* @__PURE__ */ z.object({
|
|
2595
|
+
fieldName: /* @__PURE__ */ z.enum([
|
|
2581
2596
|
"_id",
|
|
2582
2597
|
"title",
|
|
2583
2598
|
"excerpt",
|
|
@@ -2588,13 +2603,13 @@ var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2588
2603
|
"commentingEnabled",
|
|
2589
2604
|
"hasUnpublishedChanges"
|
|
2590
2605
|
]).optional(),
|
|
2591
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
2606
|
+
order: /* @__PURE__ */ z.enum(["ASC", "DESC"]).optional()
|
|
2592
2607
|
})
|
|
2593
2608
|
).optional()
|
|
2594
|
-
}).catchall(z.any()).describe("Query options."),
|
|
2595
|
-
options: z.object({
|
|
2596
|
-
fieldsets: z.array(
|
|
2597
|
-
z.enum([
|
|
2609
|
+
}).catchall(/* @__PURE__ */ z.any()).describe("Query options."),
|
|
2610
|
+
options: /* @__PURE__ */ z.object({
|
|
2611
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
2612
|
+
/* @__PURE__ */ z.enum([
|
|
2598
2613
|
"UNKNOWN",
|
|
2599
2614
|
"URL",
|
|
2600
2615
|
"CONTENT",
|
|
@@ -2605,41 +2620,41 @@ var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2605
2620
|
}).describe("Options for querying draft posts.").optional()
|
|
2606
2621
|
});
|
|
2607
2622
|
var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
2608
|
-
draftPosts: z.array(
|
|
2609
|
-
z.object({
|
|
2610
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2611
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2612
|
-
excerpt: z.string().describe(
|
|
2623
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
2624
|
+
/* @__PURE__ */ z.object({
|
|
2625
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2626
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2627
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2613
2628
|
"Draft post excerpt.\n\nIf no excerpt has been manually set, an excerpt is automatically generated from the post's text.\nThis can be retrieved using the `GENERATED_EXCERPT` fieldset."
|
|
2614
2629
|
).max(500).optional().nullable(),
|
|
2615
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2616
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2617
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2630
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2631
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2632
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2618
2633
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2619
2634
|
"Must be a valid GUID"
|
|
2620
2635
|
).optional().nullable(),
|
|
2621
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2622
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2623
|
-
minutesToRead: z.number().int().describe(
|
|
2636
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2637
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2638
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2624
2639
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2625
2640
|
).optional(),
|
|
2626
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2627
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2628
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2629
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2630
|
-
translationId: z.string().describe(
|
|
2641
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2642
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2643
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2644
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2645
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2631
2646
|
"ID of the draft post's translations.\n\nAll translations of a single post share the same `translationId`.\nAvailable only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed."
|
|
2632
2647
|
).regex(
|
|
2633
2648
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2634
2649
|
"Must be a valid GUID"
|
|
2635
2650
|
).optional().nullable(),
|
|
2636
|
-
language: z.string().describe(
|
|
2651
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2637
2652
|
"Language the draft post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
2638
2653
|
).optional().nullable(),
|
|
2639
|
-
richContent: z.any().describe(
|
|
2654
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2640
2655
|
'Draft Post rich content.\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
2641
2656
|
).optional(),
|
|
2642
|
-
status: z.enum([
|
|
2657
|
+
status: /* @__PURE__ */ z.enum([
|
|
2643
2658
|
"UNKNOWN",
|
|
2644
2659
|
"PUBLISHED",
|
|
2645
2660
|
"UNPUBLISHED",
|
|
@@ -2647,132 +2662,132 @@ var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2647
2662
|
"DELETED",
|
|
2648
2663
|
"IN_REVIEW"
|
|
2649
2664
|
]).describe("Status of the draft post.").optional(),
|
|
2650
|
-
moderationDetails: z.object({
|
|
2651
|
-
submittedBy: z.string().describe(
|
|
2665
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2666
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2652
2667
|
"Member ID of the person submitting the draft post for review."
|
|
2653
2668
|
).regex(
|
|
2654
2669
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2655
2670
|
"Must be a valid GUID"
|
|
2656
2671
|
).optional(),
|
|
2657
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2658
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2672
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2673
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2659
2674
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2660
2675
|
).optional(),
|
|
2661
|
-
moderatedBy: z.string().describe(
|
|
2676
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2662
2677
|
"Member ID of the person who approved or rejected the post."
|
|
2663
2678
|
).regex(
|
|
2664
2679
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2665
2680
|
"Must be a valid GUID"
|
|
2666
2681
|
).optional().nullable(),
|
|
2667
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2682
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2668
2683
|
}).describe(
|
|
2669
2684
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2670
2685
|
).optional(),
|
|
2671
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2686
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2672
2687
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2673
2688
|
).optional(),
|
|
2674
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2675
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2676
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2677
|
-
seoData: z.object({
|
|
2678
|
-
tags: z.array(
|
|
2679
|
-
z.object({
|
|
2680
|
-
type: z.string().describe(
|
|
2689
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2690
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2691
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2692
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2693
|
+
tags: /* @__PURE__ */ z.array(
|
|
2694
|
+
/* @__PURE__ */ z.object({
|
|
2695
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2681
2696
|
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
2682
2697
|
).optional(),
|
|
2683
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2698
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2684
2699
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2685
2700
|
).optional().nullable(),
|
|
2686
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2701
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2687
2702
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2688
2703
|
).optional().nullable(),
|
|
2689
|
-
children: z.string().describe(
|
|
2704
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2690
2705
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2691
2706
|
).optional(),
|
|
2692
|
-
custom: z.boolean().describe(
|
|
2707
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2693
2708
|
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
2694
2709
|
).optional(),
|
|
2695
|
-
disabled: z.boolean().describe(
|
|
2710
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2696
2711
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2697
2712
|
).optional()
|
|
2698
2713
|
})
|
|
2699
2714
|
).optional(),
|
|
2700
|
-
settings: z.object({
|
|
2701
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2715
|
+
settings: /* @__PURE__ */ z.object({
|
|
2716
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2702
2717
|
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2703
2718
|
).optional(),
|
|
2704
|
-
keywords: z.array(
|
|
2705
|
-
z.object({
|
|
2706
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2707
|
-
isMain: z.boolean().describe(
|
|
2719
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2720
|
+
/* @__PURE__ */ z.object({
|
|
2721
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2722
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2708
2723
|
"Whether the keyword is the main focus keyword."
|
|
2709
2724
|
).optional(),
|
|
2710
|
-
origin: z.string().describe(
|
|
2725
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2711
2726
|
"The source that added the keyword terms to the SEO settings."
|
|
2712
2727
|
).max(1e3).optional().nullable()
|
|
2713
2728
|
})
|
|
2714
2729
|
).max(5).optional()
|
|
2715
2730
|
}).describe("SEO general settings.").optional()
|
|
2716
2731
|
}).describe("SEO data.").optional(),
|
|
2717
|
-
url: z.string().describe(
|
|
2732
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2718
2733
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2719
2734
|
).optional(),
|
|
2720
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2721
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2722
|
-
media: z.intersection(
|
|
2723
|
-
z.object({
|
|
2724
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2725
|
-
custom: z.boolean().describe(
|
|
2735
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2736
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2737
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2738
|
+
/* @__PURE__ */ z.object({
|
|
2739
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2740
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2726
2741
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2727
2742
|
).optional(),
|
|
2728
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2743
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2729
2744
|
}),
|
|
2730
|
-
z.xor([
|
|
2731
|
-
z.object({
|
|
2732
|
-
wixMedia: z.never().optional(),
|
|
2733
|
-
embedMedia: z.never().optional()
|
|
2745
|
+
/* @__PURE__ */ z.xor([
|
|
2746
|
+
/* @__PURE__ */ z.object({
|
|
2747
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2748
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2734
2749
|
}),
|
|
2735
|
-
z.object({
|
|
2736
|
-
embedMedia: z.never().optional(),
|
|
2737
|
-
wixMedia: z.object({
|
|
2738
|
-
image: z.string().describe("Image details.").optional(),
|
|
2739
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2750
|
+
/* @__PURE__ */ z.object({
|
|
2751
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2752
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2753
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2754
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2740
2755
|
}).describe("Wix Media details.")
|
|
2741
2756
|
}),
|
|
2742
|
-
z.object({
|
|
2743
|
-
wixMedia: z.never().optional(),
|
|
2744
|
-
embedMedia: z.object({
|
|
2745
|
-
thumbnail: z.object({
|
|
2746
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2747
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2748
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2757
|
+
/* @__PURE__ */ z.object({
|
|
2758
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2759
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2760
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2761
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2762
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2763
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2749
2764
|
}).describe("Thumbnail details.").optional(),
|
|
2750
|
-
video: z.object({
|
|
2751
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2752
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2753
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2765
|
+
video: /* @__PURE__ */ z.object({
|
|
2766
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2767
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2768
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2754
2769
|
}).describe("Video details.").optional()
|
|
2755
2770
|
}).describe("Embed media details.")
|
|
2756
2771
|
})
|
|
2757
2772
|
])
|
|
2758
2773
|
).describe("Post cover media.").optional(),
|
|
2759
|
-
previewTextParagraph: z.number().int().describe(
|
|
2774
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2760
2775
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2761
2776
|
).min(0).optional().nullable()
|
|
2762
2777
|
})
|
|
2763
2778
|
).optional(),
|
|
2764
|
-
pagingMetadata: z.object({
|
|
2765
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2766
|
-
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
2767
|
-
total: z.number().int().describe(
|
|
2779
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
2780
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2781
|
+
offset: /* @__PURE__ */ z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
2782
|
+
total: /* @__PURE__ */ z.number().int().describe(
|
|
2768
2783
|
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
2769
2784
|
).optional().nullable(),
|
|
2770
|
-
tooManyToCount: z.boolean().describe(
|
|
2785
|
+
tooManyToCount: /* @__PURE__ */ z.boolean().describe(
|
|
2771
2786
|
"Flag that indicates the server failed to calculate the `total` field."
|
|
2772
2787
|
).optional().nullable(),
|
|
2773
|
-
cursors: z.object({
|
|
2774
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
2775
|
-
prev: z.string().describe(
|
|
2788
|
+
cursors: /* @__PURE__ */ z.object({
|
|
2789
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
2790
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
2776
2791
|
"Cursor pointing to previous page in the list of results."
|
|
2777
2792
|
).max(2e3).optional().nullable()
|
|
2778
2793
|
}).describe(
|
|
@@ -2781,10 +2796,10 @@ var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2781
2796
|
}).describe("Details on the paged set of results returned.").optional()
|
|
2782
2797
|
});
|
|
2783
2798
|
var PublishDraftPostRequest = /* @__PURE__ */ z.object({
|
|
2784
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2799
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2785
2800
|
});
|
|
2786
2801
|
var PublishDraftPostResponse = /* @__PURE__ */ z.object({
|
|
2787
|
-
postId: z.string().describe("Published post ID.").regex(
|
|
2802
|
+
postId: /* @__PURE__ */ z.string().describe("Published post ID.").regex(
|
|
2788
2803
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2789
2804
|
"Must be a valid GUID"
|
|
2790
2805
|
).optional()
|