@wix/auto_sdk_blog_draft-posts 1.0.98 → 1.0.99
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/schemas.js +1331 -1316
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/schemas.mjs +1331 -1316
- package/build/es/schemas.mjs.map +1 -1
- 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/cjs/schemas.js
CHANGED
|
@@ -64,40 +64,40 @@ module.exports = __toCommonJS(schemas_exports);
|
|
|
64
64
|
// src/blog-v3-draft-draft-posts.schemas.ts
|
|
65
65
|
var z = __toESM(require("zod"));
|
|
66
66
|
var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
67
|
-
draftPost: z.object({
|
|
68
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
69
|
-
title: z.string().describe("Draft post title.").max(200),
|
|
70
|
-
excerpt: z.string().describe(
|
|
67
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
68
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
69
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200),
|
|
70
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
71
71
|
"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."
|
|
72
72
|
).max(500).optional().nullable(),
|
|
73
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
74
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
75
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
73
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
74
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
75
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
76
76
|
/^[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}$/,
|
|
77
77
|
"Must be a valid GUID"
|
|
78
78
|
).optional().nullable(),
|
|
79
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
80
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
81
|
-
minutesToRead: z.number().int().describe(
|
|
79
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
80
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
81
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
82
82
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
83
83
|
).optional(),
|
|
84
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
85
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
86
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
87
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
88
|
-
translationId: z.string().describe(
|
|
84
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
85
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
86
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
87
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
88
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
89
89
|
"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."
|
|
90
90
|
).regex(
|
|
91
91
|
/^[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}$/,
|
|
92
92
|
"Must be a valid GUID"
|
|
93
93
|
).optional().nullable(),
|
|
94
|
-
language: z.string().describe(
|
|
94
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
95
95
|
"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."
|
|
96
96
|
).optional().nullable(),
|
|
97
|
-
richContent: z.any().describe(
|
|
97
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
98
98
|
'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>'
|
|
99
99
|
).optional(),
|
|
100
|
-
status: z.enum([
|
|
100
|
+
status: /* @__PURE__ */ z.enum([
|
|
101
101
|
"UNKNOWN",
|
|
102
102
|
"PUBLISHED",
|
|
103
103
|
"UNPUBLISHED",
|
|
@@ -105,123 +105,123 @@ var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
105
105
|
"DELETED",
|
|
106
106
|
"IN_REVIEW"
|
|
107
107
|
]).optional(),
|
|
108
|
-
moderationDetails: z.object({
|
|
109
|
-
submittedBy: z.string().describe(
|
|
108
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
109
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
110
110
|
"Member ID of the person submitting the draft post for review."
|
|
111
111
|
).regex(
|
|
112
112
|
/^[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}$/,
|
|
113
113
|
"Must be a valid GUID"
|
|
114
114
|
).optional(),
|
|
115
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
116
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
117
|
-
moderatedBy: z.string().describe(
|
|
115
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
116
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
117
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
118
118
|
"Member ID of the person who approved or rejected the post."
|
|
119
119
|
).regex(
|
|
120
120
|
/^[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}$/,
|
|
121
121
|
"Must be a valid GUID"
|
|
122
122
|
).optional().nullable(),
|
|
123
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
123
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
124
124
|
}).describe(
|
|
125
125
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
126
126
|
).optional(),
|
|
127
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
127
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
128
128
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
129
129
|
).optional(),
|
|
130
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
131
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
132
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
133
|
-
seoData: z.object({
|
|
134
|
-
tags: z.array(
|
|
135
|
-
z.object({
|
|
136
|
-
type: z.string().describe(
|
|
130
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
131
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
132
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
133
|
+
seoData: /* @__PURE__ */ z.object({
|
|
134
|
+
tags: /* @__PURE__ */ z.array(
|
|
135
|
+
/* @__PURE__ */ z.object({
|
|
136
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
137
137
|
"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`)."
|
|
138
138
|
).optional(),
|
|
139
|
-
props: z.record(z.string(), z.any()).describe(
|
|
139
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
140
140
|
'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"}`.'
|
|
141
141
|
).optional().nullable(),
|
|
142
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
142
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
143
143
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
144
144
|
).optional().nullable(),
|
|
145
|
-
children: z.string().describe(
|
|
145
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
146
146
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
147
147
|
).optional(),
|
|
148
|
-
custom: z.boolean().describe(
|
|
148
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
149
149
|
"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."
|
|
150
150
|
).optional(),
|
|
151
|
-
disabled: z.boolean().describe(
|
|
151
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
152
152
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
153
153
|
).optional()
|
|
154
154
|
})
|
|
155
155
|
).optional(),
|
|
156
|
-
settings: z.object({
|
|
157
|
-
preventAutoRedirect: z.boolean().describe(
|
|
156
|
+
settings: /* @__PURE__ */ z.object({
|
|
157
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
158
158
|
"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)."
|
|
159
159
|
).optional(),
|
|
160
|
-
keywords: z.array(
|
|
161
|
-
z.object({
|
|
162
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
163
|
-
isMain: z.boolean().describe(
|
|
160
|
+
keywords: /* @__PURE__ */ z.array(
|
|
161
|
+
/* @__PURE__ */ z.object({
|
|
162
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
163
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
164
164
|
"Whether the keyword is the main focus keyword."
|
|
165
165
|
).optional(),
|
|
166
|
-
origin: z.string().describe(
|
|
166
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
167
167
|
"The source that added the keyword terms to the SEO settings."
|
|
168
168
|
).max(1e3).optional().nullable()
|
|
169
169
|
})
|
|
170
170
|
).max(5).optional()
|
|
171
171
|
}).describe("SEO general settings.").optional()
|
|
172
172
|
}).describe("SEO data.").optional(),
|
|
173
|
-
url: z.string().describe(
|
|
173
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
174
174
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
175
175
|
).optional(),
|
|
176
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
177
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
178
|
-
media: z.intersection(
|
|
179
|
-
z.object({
|
|
180
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
181
|
-
custom: z.boolean().describe(
|
|
176
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
177
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
178
|
+
media: /* @__PURE__ */ z.intersection(
|
|
179
|
+
/* @__PURE__ */ z.object({
|
|
180
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
181
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
182
182
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
183
183
|
).optional(),
|
|
184
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
184
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
185
185
|
}),
|
|
186
|
-
z.xor([
|
|
187
|
-
z.object({
|
|
188
|
-
wixMedia: z.never().optional(),
|
|
189
|
-
embedMedia: z.never().optional()
|
|
186
|
+
/* @__PURE__ */ z.xor([
|
|
187
|
+
/* @__PURE__ */ z.object({
|
|
188
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
189
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
190
190
|
}),
|
|
191
|
-
z.object({
|
|
192
|
-
embedMedia: z.never().optional(),
|
|
193
|
-
wixMedia: z.object({
|
|
194
|
-
image: z.string().describe("Image details.").optional(),
|
|
195
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
191
|
+
/* @__PURE__ */ z.object({
|
|
192
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
193
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
194
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
195
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
196
196
|
}).describe("Wix Media details.")
|
|
197
197
|
}),
|
|
198
|
-
z.object({
|
|
199
|
-
wixMedia: z.never().optional(),
|
|
200
|
-
embedMedia: z.object({
|
|
201
|
-
thumbnail: z.object({
|
|
202
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
203
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
204
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
198
|
+
/* @__PURE__ */ z.object({
|
|
199
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
200
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
201
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
202
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
203
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
204
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
205
205
|
}).describe("Thumbnail details.").optional(),
|
|
206
|
-
video: z.object({
|
|
207
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
208
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
209
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
206
|
+
video: /* @__PURE__ */ z.object({
|
|
207
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
208
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
209
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
210
210
|
}).describe("Video details.").optional()
|
|
211
211
|
}).describe("Embed media details.")
|
|
212
212
|
})
|
|
213
213
|
])
|
|
214
214
|
).describe("Post cover media.").optional(),
|
|
215
|
-
previewTextParagraph: z.number().int().describe(
|
|
215
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
216
216
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
217
217
|
).min(0).optional().nullable()
|
|
218
218
|
}).describe("Draft post to create."),
|
|
219
|
-
options: z.object({
|
|
220
|
-
publish: z.boolean().describe(
|
|
219
|
+
options: /* @__PURE__ */ z.object({
|
|
220
|
+
publish: /* @__PURE__ */ z.boolean().describe(
|
|
221
221
|
"Whether the draft post should be published on creation.\n\nDefault: `false`"
|
|
222
222
|
).optional(),
|
|
223
|
-
fieldsets: z.array(
|
|
224
|
-
z.enum([
|
|
223
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
224
|
+
/* @__PURE__ */ z.enum([
|
|
225
225
|
"UNKNOWN",
|
|
226
226
|
"URL",
|
|
227
227
|
"CONTENT",
|
|
@@ -232,40 +232,40 @@ var CreateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
232
232
|
}).describe("Options for creating a draft post.").optional()
|
|
233
233
|
});
|
|
234
234
|
var CreateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
235
|
-
draftPost: z.object({
|
|
236
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
237
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
238
|
-
excerpt: z.string().describe(
|
|
235
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
236
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
237
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
238
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
239
239
|
"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."
|
|
240
240
|
).max(500).optional().nullable(),
|
|
241
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
242
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
243
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
241
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
242
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
243
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
244
244
|
/^[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}$/,
|
|
245
245
|
"Must be a valid GUID"
|
|
246
246
|
).optional().nullable(),
|
|
247
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
248
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
249
|
-
minutesToRead: z.number().int().describe(
|
|
247
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
248
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
249
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
250
250
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
251
251
|
).optional(),
|
|
252
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
253
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
254
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
255
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
256
|
-
translationId: z.string().describe(
|
|
252
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
253
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
254
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
255
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
256
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
257
257
|
"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."
|
|
258
258
|
).regex(
|
|
259
259
|
/^[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}$/,
|
|
260
260
|
"Must be a valid GUID"
|
|
261
261
|
).optional().nullable(),
|
|
262
|
-
language: z.string().describe(
|
|
262
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
263
263
|
"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."
|
|
264
264
|
).optional().nullable(),
|
|
265
|
-
richContent: z.any().describe(
|
|
265
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
266
266
|
'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>'
|
|
267
267
|
).optional(),
|
|
268
|
-
status: z.enum([
|
|
268
|
+
status: /* @__PURE__ */ z.enum([
|
|
269
269
|
"UNKNOWN",
|
|
270
270
|
"PUBLISHED",
|
|
271
271
|
"UNPUBLISHED",
|
|
@@ -273,156 +273,156 @@ var CreateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
273
273
|
"DELETED",
|
|
274
274
|
"IN_REVIEW"
|
|
275
275
|
]).describe("Status of the draft post.").optional(),
|
|
276
|
-
moderationDetails: z.object({
|
|
277
|
-
submittedBy: z.string().describe(
|
|
276
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
277
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
278
278
|
"Member ID of the person submitting the draft post for review."
|
|
279
279
|
).regex(
|
|
280
280
|
/^[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}$/,
|
|
281
281
|
"Must be a valid GUID"
|
|
282
282
|
).optional(),
|
|
283
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
284
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
283
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
284
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
285
285
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
286
286
|
).optional(),
|
|
287
|
-
moderatedBy: z.string().describe(
|
|
287
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
288
288
|
"Member ID of the person who approved or rejected the post."
|
|
289
289
|
).regex(
|
|
290
290
|
/^[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}$/,
|
|
291
291
|
"Must be a valid GUID"
|
|
292
292
|
).optional().nullable(),
|
|
293
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
293
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
294
294
|
}).describe(
|
|
295
295
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
296
296
|
).optional(),
|
|
297
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
297
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
298
298
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
299
299
|
).optional(),
|
|
300
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
301
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
302
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
303
|
-
seoData: z.object({
|
|
304
|
-
tags: z.array(
|
|
305
|
-
z.object({
|
|
306
|
-
type: z.string().describe(
|
|
300
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
301
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
302
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
303
|
+
seoData: /* @__PURE__ */ z.object({
|
|
304
|
+
tags: /* @__PURE__ */ z.array(
|
|
305
|
+
/* @__PURE__ */ z.object({
|
|
306
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
307
307
|
"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`)."
|
|
308
308
|
).optional(),
|
|
309
|
-
props: z.record(z.string(), z.any()).describe(
|
|
309
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
310
310
|
'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"}`.'
|
|
311
311
|
).optional().nullable(),
|
|
312
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
312
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
313
313
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
314
314
|
).optional().nullable(),
|
|
315
|
-
children: z.string().describe(
|
|
315
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
316
316
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
317
317
|
).optional(),
|
|
318
|
-
custom: z.boolean().describe(
|
|
318
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
319
319
|
"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."
|
|
320
320
|
).optional(),
|
|
321
|
-
disabled: z.boolean().describe(
|
|
321
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
322
322
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
323
323
|
).optional()
|
|
324
324
|
})
|
|
325
325
|
).optional(),
|
|
326
|
-
settings: z.object({
|
|
327
|
-
preventAutoRedirect: z.boolean().describe(
|
|
326
|
+
settings: /* @__PURE__ */ z.object({
|
|
327
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
328
328
|
"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)."
|
|
329
329
|
).optional(),
|
|
330
|
-
keywords: z.array(
|
|
331
|
-
z.object({
|
|
332
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
333
|
-
isMain: z.boolean().describe(
|
|
330
|
+
keywords: /* @__PURE__ */ z.array(
|
|
331
|
+
/* @__PURE__ */ z.object({
|
|
332
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
333
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
334
334
|
"Whether the keyword is the main focus keyword."
|
|
335
335
|
).optional(),
|
|
336
|
-
origin: z.string().describe(
|
|
336
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
337
337
|
"The source that added the keyword terms to the SEO settings."
|
|
338
338
|
).max(1e3).optional().nullable()
|
|
339
339
|
})
|
|
340
340
|
).max(5).optional()
|
|
341
341
|
}).describe("SEO general settings.").optional()
|
|
342
342
|
}).describe("SEO data.").optional(),
|
|
343
|
-
url: z.string().describe(
|
|
343
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
344
344
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
345
345
|
).optional(),
|
|
346
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
347
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
348
|
-
media: z.intersection(
|
|
349
|
-
z.object({
|
|
350
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
351
|
-
custom: z.boolean().describe(
|
|
346
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
347
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
348
|
+
media: /* @__PURE__ */ z.intersection(
|
|
349
|
+
/* @__PURE__ */ z.object({
|
|
350
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
351
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
352
352
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
353
353
|
).optional(),
|
|
354
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
354
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
355
355
|
}),
|
|
356
|
-
z.xor([
|
|
357
|
-
z.object({
|
|
358
|
-
wixMedia: z.never().optional(),
|
|
359
|
-
embedMedia: z.never().optional()
|
|
356
|
+
/* @__PURE__ */ z.xor([
|
|
357
|
+
/* @__PURE__ */ z.object({
|
|
358
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
359
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
360
360
|
}),
|
|
361
|
-
z.object({
|
|
362
|
-
embedMedia: z.never().optional(),
|
|
363
|
-
wixMedia: z.object({
|
|
364
|
-
image: z.string().describe("Image details.").optional(),
|
|
365
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
361
|
+
/* @__PURE__ */ z.object({
|
|
362
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
363
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
364
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
365
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
366
366
|
}).describe("Wix Media details.")
|
|
367
367
|
}),
|
|
368
|
-
z.object({
|
|
369
|
-
wixMedia: z.never().optional(),
|
|
370
|
-
embedMedia: z.object({
|
|
371
|
-
thumbnail: z.object({
|
|
372
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
373
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
374
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
368
|
+
/* @__PURE__ */ z.object({
|
|
369
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
370
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
371
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
372
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
373
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
374
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
375
375
|
}).describe("Thumbnail details.").optional(),
|
|
376
|
-
video: z.object({
|
|
377
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
378
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
379
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
376
|
+
video: /* @__PURE__ */ z.object({
|
|
377
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
378
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
379
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
380
380
|
}).describe("Video details.").optional()
|
|
381
381
|
}).describe("Embed media details.")
|
|
382
382
|
})
|
|
383
383
|
])
|
|
384
384
|
).describe("Post cover media.").optional(),
|
|
385
|
-
previewTextParagraph: z.number().int().describe(
|
|
385
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
386
386
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
387
387
|
).min(0).optional().nullable()
|
|
388
388
|
}).describe("Created draft post info.").optional()
|
|
389
389
|
});
|
|
390
390
|
var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
391
|
-
draftPosts: z.array(
|
|
392
|
-
z.object({
|
|
393
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
394
|
-
title: z.string().describe("Draft post title.").max(200),
|
|
395
|
-
excerpt: z.string().describe(
|
|
391
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
392
|
+
/* @__PURE__ */ z.object({
|
|
393
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
394
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200),
|
|
395
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
396
396
|
"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."
|
|
397
397
|
).max(500).optional().nullable(),
|
|
398
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
399
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
400
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
398
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
399
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
400
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
401
401
|
/^[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}$/,
|
|
402
402
|
"Must be a valid GUID"
|
|
403
403
|
).optional().nullable(),
|
|
404
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
405
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
406
|
-
minutesToRead: z.number().int().describe(
|
|
404
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
405
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
406
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
407
407
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
408
408
|
).optional(),
|
|
409
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
410
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
411
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
412
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
413
|
-
translationId: z.string().describe(
|
|
409
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
410
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
411
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
412
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
413
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
414
414
|
"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."
|
|
415
415
|
).regex(
|
|
416
416
|
/^[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}$/,
|
|
417
417
|
"Must be a valid GUID"
|
|
418
418
|
).optional().nullable(),
|
|
419
|
-
language: z.string().describe(
|
|
419
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
420
420
|
"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."
|
|
421
421
|
).optional().nullable(),
|
|
422
|
-
richContent: z.any().describe(
|
|
422
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
423
423
|
'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>'
|
|
424
424
|
).optional(),
|
|
425
|
-
status: z.enum([
|
|
425
|
+
status: /* @__PURE__ */ z.enum([
|
|
426
426
|
"UNKNOWN",
|
|
427
427
|
"PUBLISHED",
|
|
428
428
|
"UNPUBLISHED",
|
|
@@ -430,125 +430,125 @@ var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
430
430
|
"DELETED",
|
|
431
431
|
"IN_REVIEW"
|
|
432
432
|
]).optional(),
|
|
433
|
-
moderationDetails: z.object({
|
|
434
|
-
submittedBy: z.string().describe(
|
|
433
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
434
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
435
435
|
"Member ID of the person submitting the draft post for review."
|
|
436
436
|
).regex(
|
|
437
437
|
/^[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}$/,
|
|
438
438
|
"Must be a valid GUID"
|
|
439
439
|
).optional(),
|
|
440
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
441
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
442
|
-
moderatedBy: z.string().describe(
|
|
440
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
441
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
442
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
443
443
|
"Member ID of the person who approved or rejected the post."
|
|
444
444
|
).regex(
|
|
445
445
|
/^[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}$/,
|
|
446
446
|
"Must be a valid GUID"
|
|
447
447
|
).optional().nullable(),
|
|
448
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
448
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
449
449
|
}).describe(
|
|
450
450
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
451
451
|
).optional(),
|
|
452
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
452
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
453
453
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
454
454
|
).optional(),
|
|
455
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
456
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
457
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
458
|
-
seoData: z.object({
|
|
459
|
-
tags: z.array(
|
|
460
|
-
z.object({
|
|
461
|
-
type: z.string().describe(
|
|
455
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
456
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
457
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
458
|
+
seoData: /* @__PURE__ */ z.object({
|
|
459
|
+
tags: /* @__PURE__ */ z.array(
|
|
460
|
+
/* @__PURE__ */ z.object({
|
|
461
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
462
462
|
"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`)."
|
|
463
463
|
).optional(),
|
|
464
|
-
props: z.record(z.string(), z.any()).describe(
|
|
464
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
465
465
|
'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"}`.'
|
|
466
466
|
).optional().nullable(),
|
|
467
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
467
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
468
468
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
469
469
|
).optional().nullable(),
|
|
470
|
-
children: z.string().describe(
|
|
470
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
471
471
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
472
472
|
).optional(),
|
|
473
|
-
custom: z.boolean().describe(
|
|
473
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
474
474
|
"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."
|
|
475
475
|
).optional(),
|
|
476
|
-
disabled: z.boolean().describe(
|
|
476
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
477
477
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
478
478
|
).optional()
|
|
479
479
|
})
|
|
480
480
|
).optional(),
|
|
481
|
-
settings: z.object({
|
|
482
|
-
preventAutoRedirect: z.boolean().describe(
|
|
481
|
+
settings: /* @__PURE__ */ z.object({
|
|
482
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
483
483
|
"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)."
|
|
484
484
|
).optional(),
|
|
485
|
-
keywords: z.array(
|
|
486
|
-
z.object({
|
|
487
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
488
|
-
isMain: z.boolean().describe(
|
|
485
|
+
keywords: /* @__PURE__ */ z.array(
|
|
486
|
+
/* @__PURE__ */ z.object({
|
|
487
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
488
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
489
489
|
"Whether the keyword is the main focus keyword."
|
|
490
490
|
).optional(),
|
|
491
|
-
origin: z.string().describe(
|
|
491
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
492
492
|
"The source that added the keyword terms to the SEO settings."
|
|
493
493
|
).max(1e3).optional().nullable()
|
|
494
494
|
})
|
|
495
495
|
).max(5).optional()
|
|
496
496
|
}).describe("SEO general settings.").optional()
|
|
497
497
|
}).describe("SEO data.").optional(),
|
|
498
|
-
url: z.string().describe(
|
|
498
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
499
499
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
500
500
|
).optional(),
|
|
501
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
502
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
503
|
-
media: z.intersection(
|
|
504
|
-
z.object({
|
|
505
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
506
|
-
custom: z.boolean().describe(
|
|
501
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
502
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
503
|
+
media: /* @__PURE__ */ z.intersection(
|
|
504
|
+
/* @__PURE__ */ z.object({
|
|
505
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
506
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
507
507
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
508
508
|
).optional(),
|
|
509
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
509
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
510
510
|
}),
|
|
511
|
-
z.xor([
|
|
512
|
-
z.object({
|
|
513
|
-
wixMedia: z.never().optional(),
|
|
514
|
-
embedMedia: z.never().optional()
|
|
511
|
+
/* @__PURE__ */ z.xor([
|
|
512
|
+
/* @__PURE__ */ z.object({
|
|
513
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
514
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
515
515
|
}),
|
|
516
|
-
z.object({
|
|
517
|
-
embedMedia: z.never().optional(),
|
|
518
|
-
wixMedia: z.object({
|
|
519
|
-
image: z.string().describe("Image details.").optional(),
|
|
520
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
516
|
+
/* @__PURE__ */ z.object({
|
|
517
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
518
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
519
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
520
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
521
521
|
}).describe("Wix Media details.")
|
|
522
522
|
}),
|
|
523
|
-
z.object({
|
|
524
|
-
wixMedia: z.never().optional(),
|
|
525
|
-
embedMedia: z.object({
|
|
526
|
-
thumbnail: z.object({
|
|
527
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
528
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
529
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
523
|
+
/* @__PURE__ */ z.object({
|
|
524
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
525
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
526
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
527
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
528
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
529
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
530
530
|
}).describe("Thumbnail details.").optional(),
|
|
531
|
-
video: z.object({
|
|
532
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
533
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
534
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
531
|
+
video: /* @__PURE__ */ z.object({
|
|
532
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
533
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
534
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
535
535
|
}).describe("Video details.").optional()
|
|
536
536
|
}).describe("Embed media details.")
|
|
537
537
|
})
|
|
538
538
|
])
|
|
539
539
|
).describe("Post cover media.").optional(),
|
|
540
|
-
previewTextParagraph: z.number().int().describe(
|
|
540
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
541
541
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
542
542
|
).min(0).optional().nullable()
|
|
543
543
|
})
|
|
544
544
|
).min(1).max(20),
|
|
545
|
-
options: z.object({
|
|
546
|
-
publish: z.boolean().describe("Whether the draft post should be published after creation.").optional(),
|
|
547
|
-
returnFullEntity: z.boolean().describe(
|
|
545
|
+
options: /* @__PURE__ */ z.object({
|
|
546
|
+
publish: /* @__PURE__ */ z.boolean().describe("Whether the draft post should be published after creation.").optional(),
|
|
547
|
+
returnFullEntity: /* @__PURE__ */ z.boolean().describe(
|
|
548
548
|
"Whether to return the full created draft post entities in the response."
|
|
549
549
|
).optional(),
|
|
550
|
-
fieldsets: z.array(
|
|
551
|
-
z.enum([
|
|
550
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
551
|
+
/* @__PURE__ */ z.enum([
|
|
552
552
|
"UNKNOWN",
|
|
553
553
|
"URL",
|
|
554
554
|
"CONTENT",
|
|
@@ -559,58 +559,58 @@ var BulkCreateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
559
559
|
}).describe("Options for creating multiple draft posts.").optional()
|
|
560
560
|
});
|
|
561
561
|
var BulkCreateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
562
|
-
results: z.array(
|
|
563
|
-
z.object({
|
|
564
|
-
itemMetadata: z.object({
|
|
565
|
-
_id: z.string().describe(
|
|
562
|
+
results: /* @__PURE__ */ z.array(
|
|
563
|
+
/* @__PURE__ */ z.object({
|
|
564
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
565
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
566
566
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
567
567
|
).optional().nullable(),
|
|
568
|
-
originalIndex: z.number().int().describe(
|
|
568
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
569
569
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
570
570
|
).optional(),
|
|
571
|
-
success: z.boolean().describe(
|
|
571
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
572
572
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
573
573
|
).optional(),
|
|
574
|
-
error: z.object({
|
|
575
|
-
code: z.string().describe("Error code.").optional(),
|
|
576
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
577
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
574
|
+
error: /* @__PURE__ */ z.object({
|
|
575
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
576
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
577
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
578
578
|
}).describe("Details about the error in case of failure.").optional()
|
|
579
579
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
580
|
-
item: z.object({
|
|
581
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
582
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
583
|
-
excerpt: z.string().describe(
|
|
580
|
+
item: /* @__PURE__ */ z.object({
|
|
581
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
582
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
583
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
584
584
|
"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."
|
|
585
585
|
).max(500).optional().nullable(),
|
|
586
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
587
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
588
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
586
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
587
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
588
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
589
589
|
/^[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}$/,
|
|
590
590
|
"Must be a valid GUID"
|
|
591
591
|
).optional().nullable(),
|
|
592
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
593
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
594
|
-
minutesToRead: z.number().int().describe(
|
|
592
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
593
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
594
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
595
595
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
596
596
|
).optional(),
|
|
597
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
598
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
599
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
600
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
601
|
-
translationId: z.string().describe(
|
|
597
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
598
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
599
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
600
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
601
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
602
602
|
"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."
|
|
603
603
|
).regex(
|
|
604
604
|
/^[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}$/,
|
|
605
605
|
"Must be a valid GUID"
|
|
606
606
|
).optional().nullable(),
|
|
607
|
-
language: z.string().describe(
|
|
607
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
608
608
|
"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."
|
|
609
609
|
).optional().nullable(),
|
|
610
|
-
richContent: z.any().describe(
|
|
610
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
611
611
|
'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>'
|
|
612
612
|
).optional(),
|
|
613
|
-
status: z.enum([
|
|
613
|
+
status: /* @__PURE__ */ z.enum([
|
|
614
614
|
"UNKNOWN",
|
|
615
615
|
"PUBLISHED",
|
|
616
616
|
"UNPUBLISHED",
|
|
@@ -618,167 +618,167 @@ var BulkCreateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
618
618
|
"DELETED",
|
|
619
619
|
"IN_REVIEW"
|
|
620
620
|
]).describe("Status of the draft post.").optional(),
|
|
621
|
-
moderationDetails: z.object({
|
|
622
|
-
submittedBy: z.string().describe(
|
|
621
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
622
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
623
623
|
"Member ID of the person submitting the draft post for review."
|
|
624
624
|
).regex(
|
|
625
625
|
/^[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}$/,
|
|
626
626
|
"Must be a valid GUID"
|
|
627
627
|
).optional(),
|
|
628
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
629
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
628
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
629
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
630
630
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
631
631
|
).optional(),
|
|
632
|
-
moderatedBy: z.string().describe(
|
|
632
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
633
633
|
"Member ID of the person who approved or rejected the post."
|
|
634
634
|
).regex(
|
|
635
635
|
/^[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}$/,
|
|
636
636
|
"Must be a valid GUID"
|
|
637
637
|
).optional().nullable(),
|
|
638
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
638
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
639
639
|
}).describe(
|
|
640
640
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
641
641
|
).optional(),
|
|
642
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
642
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
643
643
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
644
644
|
).optional(),
|
|
645
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
646
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
647
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
648
|
-
seoData: z.object({
|
|
649
|
-
tags: z.array(
|
|
650
|
-
z.object({
|
|
651
|
-
type: z.string().describe(
|
|
645
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
646
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
647
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
648
|
+
seoData: /* @__PURE__ */ z.object({
|
|
649
|
+
tags: /* @__PURE__ */ z.array(
|
|
650
|
+
/* @__PURE__ */ z.object({
|
|
651
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
652
652
|
"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`)."
|
|
653
653
|
).optional(),
|
|
654
|
-
props: z.record(z.string(), z.any()).describe(
|
|
654
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
655
655
|
'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"}`.'
|
|
656
656
|
).optional().nullable(),
|
|
657
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
657
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
658
658
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
659
659
|
).optional().nullable(),
|
|
660
|
-
children: z.string().describe(
|
|
660
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
661
661
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
662
662
|
).optional(),
|
|
663
|
-
custom: z.boolean().describe(
|
|
663
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
664
664
|
"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."
|
|
665
665
|
).optional(),
|
|
666
|
-
disabled: z.boolean().describe(
|
|
666
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
667
667
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
668
668
|
).optional()
|
|
669
669
|
})
|
|
670
670
|
).optional(),
|
|
671
|
-
settings: z.object({
|
|
672
|
-
preventAutoRedirect: z.boolean().describe(
|
|
671
|
+
settings: /* @__PURE__ */ z.object({
|
|
672
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
673
673
|
"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)."
|
|
674
674
|
).optional(),
|
|
675
|
-
keywords: z.array(
|
|
676
|
-
z.object({
|
|
677
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
678
|
-
isMain: z.boolean().describe(
|
|
675
|
+
keywords: /* @__PURE__ */ z.array(
|
|
676
|
+
/* @__PURE__ */ z.object({
|
|
677
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
678
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
679
679
|
"Whether the keyword is the main focus keyword."
|
|
680
680
|
).optional(),
|
|
681
|
-
origin: z.string().describe(
|
|
681
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
682
682
|
"The source that added the keyword terms to the SEO settings."
|
|
683
683
|
).max(1e3).optional().nullable()
|
|
684
684
|
})
|
|
685
685
|
).max(5).optional()
|
|
686
686
|
}).describe("SEO general settings.").optional()
|
|
687
687
|
}).describe("SEO data.").optional(),
|
|
688
|
-
url: z.string().describe(
|
|
688
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
689
689
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
690
690
|
).optional(),
|
|
691
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
692
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
693
|
-
media: z.intersection(
|
|
694
|
-
z.object({
|
|
695
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
696
|
-
custom: z.boolean().describe(
|
|
691
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
692
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
693
|
+
media: /* @__PURE__ */ z.intersection(
|
|
694
|
+
/* @__PURE__ */ z.object({
|
|
695
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
696
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
697
697
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
698
698
|
).optional(),
|
|
699
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
699
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
700
700
|
}),
|
|
701
|
-
z.xor([
|
|
702
|
-
z.object({
|
|
703
|
-
wixMedia: z.never().optional(),
|
|
704
|
-
embedMedia: z.never().optional()
|
|
701
|
+
/* @__PURE__ */ z.xor([
|
|
702
|
+
/* @__PURE__ */ z.object({
|
|
703
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
704
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
705
705
|
}),
|
|
706
|
-
z.object({
|
|
707
|
-
embedMedia: z.never().optional(),
|
|
708
|
-
wixMedia: z.object({
|
|
709
|
-
image: z.string().describe("Image details.").optional(),
|
|
710
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
706
|
+
/* @__PURE__ */ z.object({
|
|
707
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
708
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
709
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
710
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
711
711
|
}).describe("Wix Media details.")
|
|
712
712
|
}),
|
|
713
|
-
z.object({
|
|
714
|
-
wixMedia: z.never().optional(),
|
|
715
|
-
embedMedia: z.object({
|
|
716
|
-
thumbnail: z.object({
|
|
717
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
718
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
719
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
713
|
+
/* @__PURE__ */ z.object({
|
|
714
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
715
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
716
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
717
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
718
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
719
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
720
720
|
}).describe("Thumbnail details.").optional(),
|
|
721
|
-
video: z.object({
|
|
722
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
723
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
724
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
721
|
+
video: /* @__PURE__ */ z.object({
|
|
722
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
723
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
724
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
725
725
|
}).describe("Video details.").optional()
|
|
726
726
|
}).describe("Embed media details.")
|
|
727
727
|
})
|
|
728
728
|
])
|
|
729
729
|
).describe("Post cover media.").optional(),
|
|
730
|
-
previewTextParagraph: z.number().int().describe(
|
|
730
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
731
731
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
732
732
|
).min(0).optional().nullable()
|
|
733
733
|
}).describe("Optional full draft post.").optional()
|
|
734
734
|
})
|
|
735
735
|
).optional(),
|
|
736
|
-
bulkActionMetadata: z.object({
|
|
737
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
738
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
739
|
-
undetailedFailures: z.number().int().describe(
|
|
736
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
737
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
738
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
739
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
740
740
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
741
741
|
).optional()
|
|
742
742
|
}).describe("Bulk action metadata.").optional()
|
|
743
743
|
});
|
|
744
744
|
var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
745
|
-
options: z.object({
|
|
746
|
-
draftPosts: z.array(
|
|
747
|
-
z.object({
|
|
748
|
-
draftPost: z.object({
|
|
749
|
-
_id: z.string().describe("Draft post ID.").max(38),
|
|
750
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
751
|
-
excerpt: z.string().describe(
|
|
745
|
+
options: /* @__PURE__ */ z.object({
|
|
746
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
747
|
+
/* @__PURE__ */ z.object({
|
|
748
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
749
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
750
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
751
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
752
752
|
"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."
|
|
753
753
|
).max(500).optional().nullable(),
|
|
754
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
755
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
756
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
754
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
755
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
756
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
757
757
|
/^[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}$/,
|
|
758
758
|
"Must be a valid GUID"
|
|
759
759
|
).optional().nullable(),
|
|
760
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
761
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
762
|
-
minutesToRead: z.number().int().describe(
|
|
760
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
761
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
762
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
763
763
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
764
764
|
).optional(),
|
|
765
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
766
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
767
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
768
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
769
|
-
translationId: z.string().describe(
|
|
765
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
766
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
767
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
768
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
769
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
770
770
|
"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."
|
|
771
771
|
).regex(
|
|
772
772
|
/^[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}$/,
|
|
773
773
|
"Must be a valid GUID"
|
|
774
774
|
).optional().nullable(),
|
|
775
|
-
language: z.string().describe(
|
|
775
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
776
776
|
"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."
|
|
777
777
|
).optional().nullable(),
|
|
778
|
-
richContent: z.any().describe(
|
|
778
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
779
779
|
'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>'
|
|
780
780
|
).optional(),
|
|
781
|
-
status: z.enum([
|
|
781
|
+
status: /* @__PURE__ */ z.enum([
|
|
782
782
|
"UNKNOWN",
|
|
783
783
|
"PUBLISHED",
|
|
784
784
|
"UNPUBLISHED",
|
|
@@ -786,121 +786,127 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
786
786
|
"DELETED",
|
|
787
787
|
"IN_REVIEW"
|
|
788
788
|
]).optional(),
|
|
789
|
-
moderationDetails: z.object({
|
|
790
|
-
submittedBy: z.string().describe(
|
|
789
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
790
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
791
791
|
"Member ID of the person submitting the draft post for review."
|
|
792
792
|
).regex(
|
|
793
793
|
/^[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}$/,
|
|
794
794
|
"Must be a valid GUID"
|
|
795
795
|
).optional(),
|
|
796
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
797
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
798
|
-
moderatedBy: z.string().describe(
|
|
796
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
797
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
798
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
799
799
|
"Member ID of the person who approved or rejected the post."
|
|
800
800
|
).regex(
|
|
801
801
|
/^[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}$/,
|
|
802
802
|
"Must be a valid GUID"
|
|
803
803
|
).optional().nullable(),
|
|
804
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
804
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
805
805
|
}).describe(
|
|
806
806
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
807
807
|
).optional(),
|
|
808
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
808
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
809
809
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
810
810
|
).optional(),
|
|
811
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
812
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
813
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
814
|
-
seoData: z.object({
|
|
815
|
-
tags: z.array(
|
|
816
|
-
z.object({
|
|
817
|
-
type: z.string().describe(
|
|
811
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
812
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
813
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
814
|
+
seoData: /* @__PURE__ */ z.object({
|
|
815
|
+
tags: /* @__PURE__ */ z.array(
|
|
816
|
+
/* @__PURE__ */ z.object({
|
|
817
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
818
818
|
"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`)."
|
|
819
819
|
).optional(),
|
|
820
|
-
props: z.record(
|
|
820
|
+
props: /* @__PURE__ */ z.record(
|
|
821
|
+
/* @__PURE__ */ z.string(),
|
|
822
|
+
/* @__PURE__ */ z.any()
|
|
823
|
+
).describe(
|
|
821
824
|
'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"}`.'
|
|
822
825
|
).optional().nullable(),
|
|
823
|
-
meta: z.record(
|
|
826
|
+
meta: /* @__PURE__ */ z.record(
|
|
827
|
+
/* @__PURE__ */ z.string(),
|
|
828
|
+
/* @__PURE__ */ z.any()
|
|
829
|
+
).describe(
|
|
824
830
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
825
831
|
).optional().nullable(),
|
|
826
|
-
children: z.string().describe(
|
|
832
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
827
833
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
828
834
|
).optional(),
|
|
829
|
-
custom: z.boolean().describe(
|
|
835
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
830
836
|
"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."
|
|
831
837
|
).optional(),
|
|
832
|
-
disabled: z.boolean().describe(
|
|
838
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
833
839
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
834
840
|
).optional()
|
|
835
841
|
})
|
|
836
842
|
).optional(),
|
|
837
|
-
settings: z.object({
|
|
838
|
-
preventAutoRedirect: z.boolean().describe(
|
|
843
|
+
settings: /* @__PURE__ */ z.object({
|
|
844
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
839
845
|
"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)."
|
|
840
846
|
).optional(),
|
|
841
|
-
keywords: z.array(
|
|
842
|
-
z.object({
|
|
843
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
844
|
-
isMain: z.boolean().describe(
|
|
847
|
+
keywords: /* @__PURE__ */ z.array(
|
|
848
|
+
/* @__PURE__ */ z.object({
|
|
849
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
850
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
845
851
|
"Whether the keyword is the main focus keyword."
|
|
846
852
|
).optional(),
|
|
847
|
-
origin: z.string().describe(
|
|
853
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
848
854
|
"The source that added the keyword terms to the SEO settings."
|
|
849
855
|
).max(1e3).optional().nullable()
|
|
850
856
|
})
|
|
851
857
|
).max(5).optional()
|
|
852
858
|
}).describe("SEO general settings.").optional()
|
|
853
859
|
}).describe("SEO data.").optional(),
|
|
854
|
-
url: z.string().describe(
|
|
860
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
855
861
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
856
862
|
).optional(),
|
|
857
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
858
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
859
|
-
media: z.intersection(
|
|
860
|
-
z.object({
|
|
861
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
862
|
-
custom: z.boolean().describe(
|
|
863
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
864
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
865
|
+
media: /* @__PURE__ */ z.intersection(
|
|
866
|
+
/* @__PURE__ */ z.object({
|
|
867
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
868
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
863
869
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
864
870
|
).optional(),
|
|
865
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
871
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
866
872
|
}),
|
|
867
|
-
z.xor([
|
|
868
|
-
z.object({
|
|
869
|
-
wixMedia: z.never().optional(),
|
|
870
|
-
embedMedia: z.never().optional()
|
|
873
|
+
/* @__PURE__ */ z.xor([
|
|
874
|
+
/* @__PURE__ */ z.object({
|
|
875
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
876
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
871
877
|
}),
|
|
872
|
-
z.object({
|
|
873
|
-
embedMedia: z.never().optional(),
|
|
874
|
-
wixMedia: z.object({
|
|
875
|
-
image: z.string().describe("Image details.").optional(),
|
|
876
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
878
|
+
/* @__PURE__ */ z.object({
|
|
879
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
880
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
881
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
882
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
877
883
|
}).describe("Wix Media details.")
|
|
878
884
|
}),
|
|
879
|
-
z.object({
|
|
880
|
-
wixMedia: z.never().optional(),
|
|
881
|
-
embedMedia: z.object({
|
|
882
|
-
thumbnail: z.object({
|
|
883
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
884
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
885
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
885
|
+
/* @__PURE__ */ z.object({
|
|
886
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
887
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
888
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
889
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
890
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
891
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
886
892
|
}).describe("Thumbnail details.").optional(),
|
|
887
|
-
video: z.object({
|
|
888
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
889
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
890
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
893
|
+
video: /* @__PURE__ */ z.object({
|
|
894
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
895
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
896
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
891
897
|
}).describe("Video details.").optional()
|
|
892
898
|
}).describe("Embed media details.")
|
|
893
899
|
})
|
|
894
900
|
])
|
|
895
901
|
).describe("Post cover media.").optional(),
|
|
896
|
-
previewTextParagraph: z.number().int().describe(
|
|
902
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
897
903
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
898
904
|
).min(0).optional().nullable()
|
|
899
905
|
}).describe("Draft post"),
|
|
900
|
-
fieldMask: z.array(z.string()).optional()
|
|
906
|
+
fieldMask: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).optional()
|
|
901
907
|
})
|
|
902
908
|
).min(1).max(20).optional(),
|
|
903
|
-
action: z.enum([
|
|
909
|
+
action: /* @__PURE__ */ z.enum([
|
|
904
910
|
"UPDATE",
|
|
905
911
|
"UPDATE_PUBLISH",
|
|
906
912
|
"UPDATE_SCHEDULE",
|
|
@@ -909,14 +915,14 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
909
915
|
"UPDATE_REJECT",
|
|
910
916
|
"UPDATE_PUBLICATION"
|
|
911
917
|
]).optional(),
|
|
912
|
-
scheduledPublishDate: z.date().describe(
|
|
918
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe(
|
|
913
919
|
"Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`."
|
|
914
920
|
).optional().nullable(),
|
|
915
|
-
returnFullEntity: z.boolean().describe(
|
|
921
|
+
returnFullEntity: /* @__PURE__ */ z.boolean().describe(
|
|
916
922
|
"Whether to return the full updated draft post entities in the response."
|
|
917
923
|
).optional(),
|
|
918
|
-
fieldsets: z.array(
|
|
919
|
-
z.enum([
|
|
924
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
925
|
+
/* @__PURE__ */ z.enum([
|
|
920
926
|
"UNKNOWN",
|
|
921
927
|
"URL",
|
|
922
928
|
"CONTENT",
|
|
@@ -927,58 +933,58 @@ var BulkUpdateDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
927
933
|
}).describe("Options for updating multiple draft posts.").optional()
|
|
928
934
|
});
|
|
929
935
|
var BulkUpdateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
930
|
-
results: z.array(
|
|
931
|
-
z.object({
|
|
932
|
-
itemMetadata: z.object({
|
|
933
|
-
_id: z.string().describe(
|
|
936
|
+
results: /* @__PURE__ */ z.array(
|
|
937
|
+
/* @__PURE__ */ z.object({
|
|
938
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
939
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
934
940
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
935
941
|
).optional().nullable(),
|
|
936
|
-
originalIndex: z.number().int().describe(
|
|
942
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
937
943
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
938
944
|
).optional(),
|
|
939
|
-
success: z.boolean().describe(
|
|
945
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
940
946
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
941
947
|
).optional(),
|
|
942
|
-
error: z.object({
|
|
943
|
-
code: z.string().describe("Error code.").optional(),
|
|
944
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
945
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
948
|
+
error: /* @__PURE__ */ z.object({
|
|
949
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
950
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
951
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
946
952
|
}).describe("Details about the error in case of failure.").optional()
|
|
947
953
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
948
|
-
item: z.object({
|
|
949
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
950
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
951
|
-
excerpt: z.string().describe(
|
|
954
|
+
item: /* @__PURE__ */ z.object({
|
|
955
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
956
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
957
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
952
958
|
"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."
|
|
953
959
|
).max(500).optional().nullable(),
|
|
954
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
955
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
956
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
960
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
961
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
962
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
957
963
|
/^[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}$/,
|
|
958
964
|
"Must be a valid GUID"
|
|
959
965
|
).optional().nullable(),
|
|
960
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
961
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
962
|
-
minutesToRead: z.number().int().describe(
|
|
966
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
967
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
968
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
963
969
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
964
970
|
).optional(),
|
|
965
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
966
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
967
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
968
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
969
|
-
translationId: z.string().describe(
|
|
971
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
972
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
973
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
974
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
975
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
970
976
|
"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."
|
|
971
977
|
).regex(
|
|
972
978
|
/^[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}$/,
|
|
973
979
|
"Must be a valid GUID"
|
|
974
980
|
).optional().nullable(),
|
|
975
|
-
language: z.string().describe(
|
|
981
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
976
982
|
"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."
|
|
977
983
|
).optional().nullable(),
|
|
978
|
-
richContent: z.any().describe(
|
|
984
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
979
985
|
'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>'
|
|
980
986
|
).optional(),
|
|
981
|
-
status: z.enum([
|
|
987
|
+
status: /* @__PURE__ */ z.enum([
|
|
982
988
|
"UNKNOWN",
|
|
983
989
|
"PUBLISHED",
|
|
984
990
|
"UNPUBLISHED",
|
|
@@ -986,146 +992,146 @@ var BulkUpdateDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
986
992
|
"DELETED",
|
|
987
993
|
"IN_REVIEW"
|
|
988
994
|
]).describe("Status of the draft post.").optional(),
|
|
989
|
-
moderationDetails: z.object({
|
|
990
|
-
submittedBy: z.string().describe(
|
|
995
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
996
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
991
997
|
"Member ID of the person submitting the draft post for review."
|
|
992
998
|
).regex(
|
|
993
999
|
/^[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}$/,
|
|
994
1000
|
"Must be a valid GUID"
|
|
995
1001
|
).optional(),
|
|
996
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
997
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1002
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1003
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
998
1004
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
999
1005
|
).optional(),
|
|
1000
|
-
moderatedBy: z.string().describe(
|
|
1006
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1001
1007
|
"Member ID of the person who approved or rejected the post."
|
|
1002
1008
|
).regex(
|
|
1003
1009
|
/^[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}$/,
|
|
1004
1010
|
"Must be a valid GUID"
|
|
1005
1011
|
).optional().nullable(),
|
|
1006
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1012
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1007
1013
|
}).describe(
|
|
1008
1014
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1009
1015
|
).optional(),
|
|
1010
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1016
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1011
1017
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1012
1018
|
).optional(),
|
|
1013
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1014
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1015
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1016
|
-
seoData: z.object({
|
|
1017
|
-
tags: z.array(
|
|
1018
|
-
z.object({
|
|
1019
|
-
type: z.string().describe(
|
|
1019
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1020
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1021
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1022
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1023
|
+
tags: /* @__PURE__ */ z.array(
|
|
1024
|
+
/* @__PURE__ */ z.object({
|
|
1025
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1020
1026
|
"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`)."
|
|
1021
1027
|
).optional(),
|
|
1022
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1028
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1023
1029
|
'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"}`.'
|
|
1024
1030
|
).optional().nullable(),
|
|
1025
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1031
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1026
1032
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1027
1033
|
).optional().nullable(),
|
|
1028
|
-
children: z.string().describe(
|
|
1034
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1029
1035
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1030
1036
|
).optional(),
|
|
1031
|
-
custom: z.boolean().describe(
|
|
1037
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1032
1038
|
"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."
|
|
1033
1039
|
).optional(),
|
|
1034
|
-
disabled: z.boolean().describe(
|
|
1040
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1035
1041
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1036
1042
|
).optional()
|
|
1037
1043
|
})
|
|
1038
1044
|
).optional(),
|
|
1039
|
-
settings: z.object({
|
|
1040
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1045
|
+
settings: /* @__PURE__ */ z.object({
|
|
1046
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1041
1047
|
"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)."
|
|
1042
1048
|
).optional(),
|
|
1043
|
-
keywords: z.array(
|
|
1044
|
-
z.object({
|
|
1045
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1046
|
-
isMain: z.boolean().describe(
|
|
1049
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1050
|
+
/* @__PURE__ */ z.object({
|
|
1051
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1052
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1047
1053
|
"Whether the keyword is the main focus keyword."
|
|
1048
1054
|
).optional(),
|
|
1049
|
-
origin: z.string().describe(
|
|
1055
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1050
1056
|
"The source that added the keyword terms to the SEO settings."
|
|
1051
1057
|
).max(1e3).optional().nullable()
|
|
1052
1058
|
})
|
|
1053
1059
|
).max(5).optional()
|
|
1054
1060
|
}).describe("SEO general settings.").optional()
|
|
1055
1061
|
}).describe("SEO data.").optional(),
|
|
1056
|
-
url: z.string().describe(
|
|
1062
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1057
1063
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1058
1064
|
).optional(),
|
|
1059
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1060
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1061
|
-
media: z.intersection(
|
|
1062
|
-
z.object({
|
|
1063
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1064
|
-
custom: z.boolean().describe(
|
|
1065
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1066
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1067
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1068
|
+
/* @__PURE__ */ z.object({
|
|
1069
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1070
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1065
1071
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1066
1072
|
).optional(),
|
|
1067
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1073
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1068
1074
|
}),
|
|
1069
|
-
z.xor([
|
|
1070
|
-
z.object({
|
|
1071
|
-
wixMedia: z.never().optional(),
|
|
1072
|
-
embedMedia: z.never().optional()
|
|
1075
|
+
/* @__PURE__ */ z.xor([
|
|
1076
|
+
/* @__PURE__ */ z.object({
|
|
1077
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1078
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1073
1079
|
}),
|
|
1074
|
-
z.object({
|
|
1075
|
-
embedMedia: z.never().optional(),
|
|
1076
|
-
wixMedia: z.object({
|
|
1077
|
-
image: z.string().describe("Image details.").optional(),
|
|
1078
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1080
|
+
/* @__PURE__ */ z.object({
|
|
1081
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1082
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1083
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1084
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1079
1085
|
}).describe("Wix Media details.")
|
|
1080
1086
|
}),
|
|
1081
|
-
z.object({
|
|
1082
|
-
wixMedia: z.never().optional(),
|
|
1083
|
-
embedMedia: z.object({
|
|
1084
|
-
thumbnail: z.object({
|
|
1085
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1086
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1087
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1087
|
+
/* @__PURE__ */ z.object({
|
|
1088
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1089
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1090
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1091
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1092
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1093
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1088
1094
|
}).describe("Thumbnail details.").optional(),
|
|
1089
|
-
video: z.object({
|
|
1090
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1091
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1092
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1095
|
+
video: /* @__PURE__ */ z.object({
|
|
1096
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1097
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1098
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1093
1099
|
}).describe("Video details.").optional()
|
|
1094
1100
|
}).describe("Embed media details.")
|
|
1095
1101
|
})
|
|
1096
1102
|
])
|
|
1097
1103
|
).describe("Post cover media.").optional(),
|
|
1098
|
-
previewTextParagraph: z.number().int().describe(
|
|
1104
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1099
1105
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1100
1106
|
).min(0).optional().nullable()
|
|
1101
1107
|
}).describe("Optional full draft post.").optional()
|
|
1102
1108
|
})
|
|
1103
1109
|
).optional(),
|
|
1104
|
-
bulkActionMetadata: z.object({
|
|
1105
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1106
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1107
|
-
undetailedFailures: z.number().int().describe(
|
|
1110
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
1111
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1112
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1113
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
1108
1114
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
1109
1115
|
).optional()
|
|
1110
1116
|
}).describe("Bulk action metadata.").optional()
|
|
1111
1117
|
});
|
|
1112
1118
|
var ListDeletedDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
1113
|
-
options: z.object({
|
|
1114
|
-
language: z.string().describe(
|
|
1119
|
+
options: /* @__PURE__ */ z.object({
|
|
1120
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1115
1121
|
"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."
|
|
1116
1122
|
).optional().nullable(),
|
|
1117
|
-
sort: z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1118
|
-
paging: z.object({
|
|
1119
|
-
offset: z.number().int().describe(
|
|
1123
|
+
sort: /* @__PURE__ */ z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
1124
|
+
paging: /* @__PURE__ */ z.object({
|
|
1125
|
+
offset: /* @__PURE__ */ z.number().int().describe(
|
|
1120
1126
|
"Number of items to skip in the current sort order.\n\n\nDefault: `0`"
|
|
1121
1127
|
).min(0).optional(),
|
|
1122
|
-
limit: z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1123
|
-
cursor: z.string().describe(
|
|
1128
|
+
limit: /* @__PURE__ */ z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
1129
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
1124
1130
|
"Pointer to the next or previous page in the list of results."
|
|
1125
1131
|
).max(2e3).optional().nullable()
|
|
1126
1132
|
}).describe("Pagination options.").optional(),
|
|
1127
|
-
fieldsets: z.array(
|
|
1128
|
-
z.enum([
|
|
1133
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1134
|
+
/* @__PURE__ */ z.enum([
|
|
1129
1135
|
"UNKNOWN",
|
|
1130
1136
|
"URL",
|
|
1131
1137
|
"CONTENT",
|
|
@@ -1133,45 +1139,45 @@ var ListDeletedDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
1133
1139
|
"GENERATED_EXCERPT"
|
|
1134
1140
|
])
|
|
1135
1141
|
).max(10).optional(),
|
|
1136
|
-
draftPostIds: z.array(z.string()).max(100).optional()
|
|
1142
|
+
draftPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional()
|
|
1137
1143
|
}).describe("Options for listing deleted draft posts.").optional()
|
|
1138
1144
|
});
|
|
1139
1145
|
var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
1140
|
-
draftPosts: z.array(
|
|
1141
|
-
z.object({
|
|
1142
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1143
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1144
|
-
excerpt: z.string().describe(
|
|
1146
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
1147
|
+
/* @__PURE__ */ z.object({
|
|
1148
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1149
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1150
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1145
1151
|
"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."
|
|
1146
1152
|
).max(500).optional().nullable(),
|
|
1147
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1148
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1149
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1153
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1154
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1155
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1150
1156
|
/^[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}$/,
|
|
1151
1157
|
"Must be a valid GUID"
|
|
1152
1158
|
).optional().nullable(),
|
|
1153
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1154
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1155
|
-
minutesToRead: z.number().int().describe(
|
|
1159
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1160
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1161
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1156
1162
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1157
1163
|
).optional(),
|
|
1158
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1159
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1160
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1161
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1162
|
-
translationId: z.string().describe(
|
|
1164
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1165
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1166
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1167
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1168
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1163
1169
|
"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."
|
|
1164
1170
|
).regex(
|
|
1165
1171
|
/^[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}$/,
|
|
1166
1172
|
"Must be a valid GUID"
|
|
1167
1173
|
).optional().nullable(),
|
|
1168
|
-
language: z.string().describe(
|
|
1174
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1169
1175
|
"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."
|
|
1170
1176
|
).optional().nullable(),
|
|
1171
|
-
richContent: z.any().describe(
|
|
1177
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1172
1178
|
'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>'
|
|
1173
1179
|
).optional(),
|
|
1174
|
-
status: z.enum([
|
|
1180
|
+
status: /* @__PURE__ */ z.enum([
|
|
1175
1181
|
"UNKNOWN",
|
|
1176
1182
|
"PUBLISHED",
|
|
1177
1183
|
"UNPUBLISHED",
|
|
@@ -1179,132 +1185,132 @@ var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1179
1185
|
"DELETED",
|
|
1180
1186
|
"IN_REVIEW"
|
|
1181
1187
|
]).describe("Status of the draft post.").optional(),
|
|
1182
|
-
moderationDetails: z.object({
|
|
1183
|
-
submittedBy: z.string().describe(
|
|
1188
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1189
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1184
1190
|
"Member ID of the person submitting the draft post for review."
|
|
1185
1191
|
).regex(
|
|
1186
1192
|
/^[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}$/,
|
|
1187
1193
|
"Must be a valid GUID"
|
|
1188
1194
|
).optional(),
|
|
1189
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1190
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1195
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1196
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1191
1197
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1192
1198
|
).optional(),
|
|
1193
|
-
moderatedBy: z.string().describe(
|
|
1199
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1194
1200
|
"Member ID of the person who approved or rejected the post."
|
|
1195
1201
|
).regex(
|
|
1196
1202
|
/^[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}$/,
|
|
1197
1203
|
"Must be a valid GUID"
|
|
1198
1204
|
).optional().nullable(),
|
|
1199
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1205
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1200
1206
|
}).describe(
|
|
1201
1207
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1202
1208
|
).optional(),
|
|
1203
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1209
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1204
1210
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1205
1211
|
).optional(),
|
|
1206
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1207
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1208
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1209
|
-
seoData: z.object({
|
|
1210
|
-
tags: z.array(
|
|
1211
|
-
z.object({
|
|
1212
|
-
type: z.string().describe(
|
|
1212
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1213
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1214
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1215
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1216
|
+
tags: /* @__PURE__ */ z.array(
|
|
1217
|
+
/* @__PURE__ */ z.object({
|
|
1218
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1213
1219
|
"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`)."
|
|
1214
1220
|
).optional(),
|
|
1215
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1221
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1216
1222
|
'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"}`.'
|
|
1217
1223
|
).optional().nullable(),
|
|
1218
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1224
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1219
1225
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1220
1226
|
).optional().nullable(),
|
|
1221
|
-
children: z.string().describe(
|
|
1227
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1222
1228
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1223
1229
|
).optional(),
|
|
1224
|
-
custom: z.boolean().describe(
|
|
1230
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1225
1231
|
"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."
|
|
1226
1232
|
).optional(),
|
|
1227
|
-
disabled: z.boolean().describe(
|
|
1233
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1228
1234
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1229
1235
|
).optional()
|
|
1230
1236
|
})
|
|
1231
1237
|
).optional(),
|
|
1232
|
-
settings: z.object({
|
|
1233
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1238
|
+
settings: /* @__PURE__ */ z.object({
|
|
1239
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1234
1240
|
"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)."
|
|
1235
1241
|
).optional(),
|
|
1236
|
-
keywords: z.array(
|
|
1237
|
-
z.object({
|
|
1238
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1239
|
-
isMain: z.boolean().describe(
|
|
1242
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1243
|
+
/* @__PURE__ */ z.object({
|
|
1244
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1245
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1240
1246
|
"Whether the keyword is the main focus keyword."
|
|
1241
1247
|
).optional(),
|
|
1242
|
-
origin: z.string().describe(
|
|
1248
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1243
1249
|
"The source that added the keyword terms to the SEO settings."
|
|
1244
1250
|
).max(1e3).optional().nullable()
|
|
1245
1251
|
})
|
|
1246
1252
|
).max(5).optional()
|
|
1247
1253
|
}).describe("SEO general settings.").optional()
|
|
1248
1254
|
}).describe("SEO data.").optional(),
|
|
1249
|
-
url: z.string().describe(
|
|
1255
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1250
1256
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1251
1257
|
).optional(),
|
|
1252
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1253
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1254
|
-
media: z.intersection(
|
|
1255
|
-
z.object({
|
|
1256
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1257
|
-
custom: z.boolean().describe(
|
|
1258
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1259
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1260
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1261
|
+
/* @__PURE__ */ z.object({
|
|
1262
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1263
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1258
1264
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1259
1265
|
).optional(),
|
|
1260
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1266
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1261
1267
|
}),
|
|
1262
|
-
z.xor([
|
|
1263
|
-
z.object({
|
|
1264
|
-
wixMedia: z.never().optional(),
|
|
1265
|
-
embedMedia: z.never().optional()
|
|
1268
|
+
/* @__PURE__ */ z.xor([
|
|
1269
|
+
/* @__PURE__ */ z.object({
|
|
1270
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1271
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1266
1272
|
}),
|
|
1267
|
-
z.object({
|
|
1268
|
-
embedMedia: z.never().optional(),
|
|
1269
|
-
wixMedia: z.object({
|
|
1270
|
-
image: z.string().describe("Image details.").optional(),
|
|
1271
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1273
|
+
/* @__PURE__ */ z.object({
|
|
1274
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1275
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1276
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1277
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1272
1278
|
}).describe("Wix Media details.")
|
|
1273
1279
|
}),
|
|
1274
|
-
z.object({
|
|
1275
|
-
wixMedia: z.never().optional(),
|
|
1276
|
-
embedMedia: z.object({
|
|
1277
|
-
thumbnail: z.object({
|
|
1278
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1279
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1280
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1280
|
+
/* @__PURE__ */ z.object({
|
|
1281
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1282
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1283
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1284
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1285
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1286
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1281
1287
|
}).describe("Thumbnail details.").optional(),
|
|
1282
|
-
video: z.object({
|
|
1283
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1284
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1285
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1288
|
+
video: /* @__PURE__ */ z.object({
|
|
1289
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1290
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1291
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1286
1292
|
}).describe("Video details.").optional()
|
|
1287
1293
|
}).describe("Embed media details.")
|
|
1288
1294
|
})
|
|
1289
1295
|
])
|
|
1290
1296
|
).describe("Post cover media.").optional(),
|
|
1291
|
-
previewTextParagraph: z.number().int().describe(
|
|
1297
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1292
1298
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1293
1299
|
).min(0).optional().nullable()
|
|
1294
1300
|
})
|
|
1295
1301
|
).optional(),
|
|
1296
|
-
pagingMetadata: z.object({
|
|
1297
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1298
|
-
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1299
|
-
total: z.number().int().describe(
|
|
1302
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
1303
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1304
|
+
offset: /* @__PURE__ */ z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1305
|
+
total: /* @__PURE__ */ z.number().int().describe(
|
|
1300
1306
|
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
1301
1307
|
).optional().nullable(),
|
|
1302
|
-
tooManyToCount: z.boolean().describe(
|
|
1308
|
+
tooManyToCount: /* @__PURE__ */ z.boolean().describe(
|
|
1303
1309
|
"Flag that indicates the server failed to calculate the `total` field."
|
|
1304
1310
|
).optional().nullable(),
|
|
1305
|
-
cursors: z.object({
|
|
1306
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
1307
|
-
prev: z.string().describe(
|
|
1311
|
+
cursors: /* @__PURE__ */ z.object({
|
|
1312
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
1313
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
1308
1314
|
"Cursor pointing to previous page in the list of results."
|
|
1309
1315
|
).max(2e3).optional().nullable()
|
|
1310
1316
|
}).describe(
|
|
@@ -1313,10 +1319,10 @@ var ListDeletedDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1313
1319
|
}).describe("Details on the paged set of results returned.").optional()
|
|
1314
1320
|
});
|
|
1315
1321
|
var GetDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1316
|
-
draftPostId: z.string().describe("Draft post ID.").max(38),
|
|
1317
|
-
options: z.object({
|
|
1318
|
-
fieldsets: z.array(
|
|
1319
|
-
z.enum([
|
|
1322
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1323
|
+
options: /* @__PURE__ */ z.object({
|
|
1324
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1325
|
+
/* @__PURE__ */ z.enum([
|
|
1320
1326
|
"UNKNOWN",
|
|
1321
1327
|
"URL",
|
|
1322
1328
|
"CONTENT",
|
|
@@ -1327,40 +1333,40 @@ var GetDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1327
1333
|
}).describe("Options for getting a draft post.").optional()
|
|
1328
1334
|
});
|
|
1329
1335
|
var GetDraftPostResponse = /* @__PURE__ */ z.object({
|
|
1330
|
-
draftPost: z.object({
|
|
1331
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1332
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1333
|
-
excerpt: z.string().describe(
|
|
1336
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1337
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1338
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1339
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1334
1340
|
"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."
|
|
1335
1341
|
).max(500).optional().nullable(),
|
|
1336
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1337
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1338
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1342
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1343
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1344
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1339
1345
|
/^[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}$/,
|
|
1340
1346
|
"Must be a valid GUID"
|
|
1341
1347
|
).optional().nullable(),
|
|
1342
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1343
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1344
|
-
minutesToRead: z.number().int().describe(
|
|
1348
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1349
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1350
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1345
1351
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1346
1352
|
).optional(),
|
|
1347
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1348
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1349
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1350
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1351
|
-
translationId: z.string().describe(
|
|
1353
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1354
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1355
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1356
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1357
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1352
1358
|
"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."
|
|
1353
1359
|
).regex(
|
|
1354
1360
|
/^[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}$/,
|
|
1355
1361
|
"Must be a valid GUID"
|
|
1356
1362
|
).optional().nullable(),
|
|
1357
|
-
language: z.string().describe(
|
|
1363
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1358
1364
|
"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."
|
|
1359
1365
|
).optional().nullable(),
|
|
1360
|
-
richContent: z.any().describe(
|
|
1366
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1361
1367
|
'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>'
|
|
1362
1368
|
).optional(),
|
|
1363
|
-
status: z.enum([
|
|
1369
|
+
status: /* @__PURE__ */ z.enum([
|
|
1364
1370
|
"UNKNOWN",
|
|
1365
1371
|
"PUBLISHED",
|
|
1366
1372
|
"UNPUBLISHED",
|
|
@@ -1368,156 +1374,156 @@ var GetDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
1368
1374
|
"DELETED",
|
|
1369
1375
|
"IN_REVIEW"
|
|
1370
1376
|
]).describe("Status of the draft post.").optional(),
|
|
1371
|
-
moderationDetails: z.object({
|
|
1372
|
-
submittedBy: z.string().describe(
|
|
1377
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1378
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1373
1379
|
"Member ID of the person submitting the draft post for review."
|
|
1374
1380
|
).regex(
|
|
1375
1381
|
/^[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}$/,
|
|
1376
1382
|
"Must be a valid GUID"
|
|
1377
1383
|
).optional(),
|
|
1378
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1379
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1384
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1385
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1380
1386
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1381
1387
|
).optional(),
|
|
1382
|
-
moderatedBy: z.string().describe(
|
|
1388
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1383
1389
|
"Member ID of the person who approved or rejected the post."
|
|
1384
1390
|
).regex(
|
|
1385
1391
|
/^[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}$/,
|
|
1386
1392
|
"Must be a valid GUID"
|
|
1387
1393
|
).optional().nullable(),
|
|
1388
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1394
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1389
1395
|
}).describe(
|
|
1390
1396
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1391
1397
|
).optional(),
|
|
1392
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1398
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1393
1399
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1394
1400
|
).optional(),
|
|
1395
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1396
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1397
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1398
|
-
seoData: z.object({
|
|
1399
|
-
tags: z.array(
|
|
1400
|
-
z.object({
|
|
1401
|
-
type: z.string().describe(
|
|
1401
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1402
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1403
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1404
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1405
|
+
tags: /* @__PURE__ */ z.array(
|
|
1406
|
+
/* @__PURE__ */ z.object({
|
|
1407
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1402
1408
|
"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`)."
|
|
1403
1409
|
).optional(),
|
|
1404
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1410
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1405
1411
|
'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"}`.'
|
|
1406
1412
|
).optional().nullable(),
|
|
1407
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1413
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1408
1414
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1409
1415
|
).optional().nullable(),
|
|
1410
|
-
children: z.string().describe(
|
|
1416
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1411
1417
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1412
1418
|
).optional(),
|
|
1413
|
-
custom: z.boolean().describe(
|
|
1419
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1414
1420
|
"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."
|
|
1415
1421
|
).optional(),
|
|
1416
|
-
disabled: z.boolean().describe(
|
|
1422
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1417
1423
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1418
1424
|
).optional()
|
|
1419
1425
|
})
|
|
1420
1426
|
).optional(),
|
|
1421
|
-
settings: z.object({
|
|
1422
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1427
|
+
settings: /* @__PURE__ */ z.object({
|
|
1428
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1423
1429
|
"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)."
|
|
1424
1430
|
).optional(),
|
|
1425
|
-
keywords: z.array(
|
|
1426
|
-
z.object({
|
|
1427
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1428
|
-
isMain: z.boolean().describe(
|
|
1431
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1432
|
+
/* @__PURE__ */ z.object({
|
|
1433
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1434
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1429
1435
|
"Whether the keyword is the main focus keyword."
|
|
1430
1436
|
).optional(),
|
|
1431
|
-
origin: z.string().describe(
|
|
1437
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1432
1438
|
"The source that added the keyword terms to the SEO settings."
|
|
1433
1439
|
).max(1e3).optional().nullable()
|
|
1434
1440
|
})
|
|
1435
1441
|
).max(5).optional()
|
|
1436
1442
|
}).describe("SEO general settings.").optional()
|
|
1437
1443
|
}).describe("SEO data.").optional(),
|
|
1438
|
-
url: z.string().describe(
|
|
1444
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1439
1445
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1440
1446
|
).optional(),
|
|
1441
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1442
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1443
|
-
media: z.intersection(
|
|
1444
|
-
z.object({
|
|
1445
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1446
|
-
custom: z.boolean().describe(
|
|
1447
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1448
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1449
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1450
|
+
/* @__PURE__ */ z.object({
|
|
1451
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1452
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1447
1453
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1448
1454
|
).optional(),
|
|
1449
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1455
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1450
1456
|
}),
|
|
1451
|
-
z.xor([
|
|
1452
|
-
z.object({
|
|
1453
|
-
wixMedia: z.never().optional(),
|
|
1454
|
-
embedMedia: z.never().optional()
|
|
1457
|
+
/* @__PURE__ */ z.xor([
|
|
1458
|
+
/* @__PURE__ */ z.object({
|
|
1459
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1460
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1455
1461
|
}),
|
|
1456
|
-
z.object({
|
|
1457
|
-
embedMedia: z.never().optional(),
|
|
1458
|
-
wixMedia: z.object({
|
|
1459
|
-
image: z.string().describe("Image details.").optional(),
|
|
1460
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1462
|
+
/* @__PURE__ */ z.object({
|
|
1463
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1464
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1465
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1466
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1461
1467
|
}).describe("Wix Media details.")
|
|
1462
1468
|
}),
|
|
1463
|
-
z.object({
|
|
1464
|
-
wixMedia: z.never().optional(),
|
|
1465
|
-
embedMedia: z.object({
|
|
1466
|
-
thumbnail: z.object({
|
|
1467
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1468
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1469
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1469
|
+
/* @__PURE__ */ z.object({
|
|
1470
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1471
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1472
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1473
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1474
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1475
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1470
1476
|
}).describe("Thumbnail details.").optional(),
|
|
1471
|
-
video: z.object({
|
|
1472
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1473
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1474
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1477
|
+
video: /* @__PURE__ */ z.object({
|
|
1478
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1479
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1480
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1475
1481
|
}).describe("Video details.").optional()
|
|
1476
1482
|
}).describe("Embed media details.")
|
|
1477
1483
|
})
|
|
1478
1484
|
])
|
|
1479
1485
|
).describe("Post cover media.").optional(),
|
|
1480
|
-
previewTextParagraph: z.number().int().describe(
|
|
1486
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1481
1487
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1482
1488
|
).min(0).optional().nullable()
|
|
1483
1489
|
}).describe("Draft post info.").optional()
|
|
1484
1490
|
});
|
|
1485
1491
|
var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1486
|
-
_id: z.string().describe("Draft post ID.").max(38),
|
|
1487
|
-
draftPost: z.object({
|
|
1488
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1489
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1490
|
-
excerpt: z.string().describe(
|
|
1492
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1493
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1494
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1495
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1496
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1491
1497
|
"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."
|
|
1492
1498
|
).max(500).optional().nullable(),
|
|
1493
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1494
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1495
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1499
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1500
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1501
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1496
1502
|
/^[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}$/,
|
|
1497
1503
|
"Must be a valid GUID"
|
|
1498
1504
|
).optional().nullable(),
|
|
1499
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1500
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1501
|
-
minutesToRead: z.number().int().describe(
|
|
1505
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1506
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1507
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1502
1508
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1503
1509
|
).optional(),
|
|
1504
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1505
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1506
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1507
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1508
|
-
translationId: z.string().describe(
|
|
1510
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1511
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1512
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1513
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1514
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1509
1515
|
"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."
|
|
1510
1516
|
).regex(
|
|
1511
1517
|
/^[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}$/,
|
|
1512
1518
|
"Must be a valid GUID"
|
|
1513
1519
|
).optional().nullable(),
|
|
1514
|
-
language: z.string().describe(
|
|
1520
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1515
1521
|
"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."
|
|
1516
1522
|
).optional().nullable(),
|
|
1517
|
-
richContent: z.any().describe(
|
|
1523
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1518
1524
|
'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>'
|
|
1519
1525
|
).optional(),
|
|
1520
|
-
status: z.enum([
|
|
1526
|
+
status: /* @__PURE__ */ z.enum([
|
|
1521
1527
|
"UNKNOWN",
|
|
1522
1528
|
"PUBLISHED",
|
|
1523
1529
|
"UNPUBLISHED",
|
|
@@ -1525,119 +1531,119 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1525
1531
|
"DELETED",
|
|
1526
1532
|
"IN_REVIEW"
|
|
1527
1533
|
]).optional(),
|
|
1528
|
-
moderationDetails: z.object({
|
|
1529
|
-
submittedBy: z.string().describe(
|
|
1534
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1535
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1530
1536
|
"Member ID of the person submitting the draft post for review."
|
|
1531
1537
|
).regex(
|
|
1532
1538
|
/^[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}$/,
|
|
1533
1539
|
"Must be a valid GUID"
|
|
1534
1540
|
).optional(),
|
|
1535
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1536
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
1537
|
-
moderatedBy: z.string().describe(
|
|
1541
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1542
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).optional(),
|
|
1543
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1538
1544
|
"Member ID of the person who approved or rejected the post."
|
|
1539
1545
|
).regex(
|
|
1540
1546
|
/^[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}$/,
|
|
1541
1547
|
"Must be a valid GUID"
|
|
1542
1548
|
).optional().nullable(),
|
|
1543
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1549
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1544
1550
|
}).describe(
|
|
1545
1551
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1546
1552
|
).optional(),
|
|
1547
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1553
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1548
1554
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1549
1555
|
).optional(),
|
|
1550
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1551
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1552
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1553
|
-
seoData: z.object({
|
|
1554
|
-
tags: z.array(
|
|
1555
|
-
z.object({
|
|
1556
|
-
type: z.string().describe(
|
|
1556
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1557
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1558
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1559
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1560
|
+
tags: /* @__PURE__ */ z.array(
|
|
1561
|
+
/* @__PURE__ */ z.object({
|
|
1562
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1557
1563
|
"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`)."
|
|
1558
1564
|
).optional(),
|
|
1559
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1565
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1560
1566
|
'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"}`.'
|
|
1561
1567
|
).optional().nullable(),
|
|
1562
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1568
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1563
1569
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1564
1570
|
).optional().nullable(),
|
|
1565
|
-
children: z.string().describe(
|
|
1571
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1566
1572
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1567
1573
|
).optional(),
|
|
1568
|
-
custom: z.boolean().describe(
|
|
1574
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1569
1575
|
"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."
|
|
1570
1576
|
).optional(),
|
|
1571
|
-
disabled: z.boolean().describe(
|
|
1577
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1572
1578
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1573
1579
|
).optional()
|
|
1574
1580
|
})
|
|
1575
1581
|
).optional(),
|
|
1576
|
-
settings: z.object({
|
|
1577
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1582
|
+
settings: /* @__PURE__ */ z.object({
|
|
1583
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1578
1584
|
"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)."
|
|
1579
1585
|
).optional(),
|
|
1580
|
-
keywords: z.array(
|
|
1581
|
-
z.object({
|
|
1582
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1583
|
-
isMain: z.boolean().describe(
|
|
1586
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1587
|
+
/* @__PURE__ */ z.object({
|
|
1588
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1589
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1584
1590
|
"Whether the keyword is the main focus keyword."
|
|
1585
1591
|
).optional(),
|
|
1586
|
-
origin: z.string().describe(
|
|
1592
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1587
1593
|
"The source that added the keyword terms to the SEO settings."
|
|
1588
1594
|
).max(1e3).optional().nullable()
|
|
1589
1595
|
})
|
|
1590
1596
|
).max(5).optional()
|
|
1591
1597
|
}).describe("SEO general settings.").optional()
|
|
1592
1598
|
}).describe("SEO data.").optional(),
|
|
1593
|
-
url: z.string().describe(
|
|
1599
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1594
1600
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1595
1601
|
).optional(),
|
|
1596
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1597
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1598
|
-
media: z.intersection(
|
|
1599
|
-
z.object({
|
|
1600
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1601
|
-
custom: z.boolean().describe(
|
|
1602
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1603
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1604
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1605
|
+
/* @__PURE__ */ z.object({
|
|
1606
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1607
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1602
1608
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1603
1609
|
).optional(),
|
|
1604
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1610
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1605
1611
|
}),
|
|
1606
|
-
z.xor([
|
|
1607
|
-
z.object({
|
|
1608
|
-
wixMedia: z.never().optional(),
|
|
1609
|
-
embedMedia: z.never().optional()
|
|
1612
|
+
/* @__PURE__ */ z.xor([
|
|
1613
|
+
/* @__PURE__ */ z.object({
|
|
1614
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1615
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1610
1616
|
}),
|
|
1611
|
-
z.object({
|
|
1612
|
-
embedMedia: z.never().optional(),
|
|
1613
|
-
wixMedia: z.object({
|
|
1614
|
-
image: z.string().describe("Image details.").optional(),
|
|
1615
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1617
|
+
/* @__PURE__ */ z.object({
|
|
1618
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1619
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1620
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1621
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1616
1622
|
}).describe("Wix Media details.")
|
|
1617
1623
|
}),
|
|
1618
|
-
z.object({
|
|
1619
|
-
wixMedia: z.never().optional(),
|
|
1620
|
-
embedMedia: z.object({
|
|
1621
|
-
thumbnail: z.object({
|
|
1622
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1623
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1624
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1624
|
+
/* @__PURE__ */ z.object({
|
|
1625
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1626
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1627
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1628
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1629
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1630
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1625
1631
|
}).describe("Thumbnail details.").optional(),
|
|
1626
|
-
video: z.object({
|
|
1627
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1628
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1629
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1632
|
+
video: /* @__PURE__ */ z.object({
|
|
1633
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1634
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1635
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1630
1636
|
}).describe("Video details.").optional()
|
|
1631
1637
|
}).describe("Embed media details.")
|
|
1632
1638
|
})
|
|
1633
1639
|
])
|
|
1634
1640
|
).describe("Post cover media.").optional(),
|
|
1635
|
-
previewTextParagraph: z.number().int().describe(
|
|
1641
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1636
1642
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1637
1643
|
).min(0).optional().nullable()
|
|
1638
1644
|
}).describe("Draft Post info."),
|
|
1639
|
-
options: z.object({
|
|
1640
|
-
action: z.enum([
|
|
1645
|
+
options: /* @__PURE__ */ z.object({
|
|
1646
|
+
action: /* @__PURE__ */ z.enum([
|
|
1641
1647
|
"UPDATE",
|
|
1642
1648
|
"UPDATE_PUBLISH",
|
|
1643
1649
|
"UPDATE_SCHEDULE",
|
|
@@ -1646,11 +1652,11 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1646
1652
|
"UPDATE_REJECT",
|
|
1647
1653
|
"UPDATE_PUBLICATION"
|
|
1648
1654
|
]).optional(),
|
|
1649
|
-
scheduledPublishDate: z.date().describe(
|
|
1655
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe(
|
|
1650
1656
|
"Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`."
|
|
1651
1657
|
).optional().nullable(),
|
|
1652
|
-
fieldsets: z.array(
|
|
1653
|
-
z.enum([
|
|
1658
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
1659
|
+
/* @__PURE__ */ z.enum([
|
|
1654
1660
|
"UNKNOWN",
|
|
1655
1661
|
"URL",
|
|
1656
1662
|
"CONTENT",
|
|
@@ -1661,40 +1667,40 @@ var UpdateDraftPostRequest = /* @__PURE__ */ z.object({
|
|
|
1661
1667
|
}).describe("Options for updating a draft post.").optional()
|
|
1662
1668
|
});
|
|
1663
1669
|
var UpdateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
1664
|
-
draftPost: z.object({
|
|
1665
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1666
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1667
|
-
excerpt: z.string().describe(
|
|
1670
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
1671
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1672
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1673
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1668
1674
|
"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."
|
|
1669
1675
|
).max(500).optional().nullable(),
|
|
1670
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1671
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1672
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1676
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1677
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1678
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1673
1679
|
/^[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}$/,
|
|
1674
1680
|
"Must be a valid GUID"
|
|
1675
1681
|
).optional().nullable(),
|
|
1676
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1677
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1678
|
-
minutesToRead: z.number().int().describe(
|
|
1682
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1683
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1684
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1679
1685
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1680
1686
|
).optional(),
|
|
1681
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1682
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1683
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1684
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1685
|
-
translationId: z.string().describe(
|
|
1687
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1688
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1689
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1690
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1691
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1686
1692
|
"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."
|
|
1687
1693
|
).regex(
|
|
1688
1694
|
/^[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}$/,
|
|
1689
1695
|
"Must be a valid GUID"
|
|
1690
1696
|
).optional().nullable(),
|
|
1691
|
-
language: z.string().describe(
|
|
1697
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1692
1698
|
"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."
|
|
1693
1699
|
).optional().nullable(),
|
|
1694
|
-
richContent: z.any().describe(
|
|
1700
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1695
1701
|
'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>'
|
|
1696
1702
|
).optional(),
|
|
1697
|
-
status: z.enum([
|
|
1703
|
+
status: /* @__PURE__ */ z.enum([
|
|
1698
1704
|
"UNKNOWN",
|
|
1699
1705
|
"PUBLISHED",
|
|
1700
1706
|
"UNPUBLISHED",
|
|
@@ -1702,192 +1708,192 @@ var UpdateDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
1702
1708
|
"DELETED",
|
|
1703
1709
|
"IN_REVIEW"
|
|
1704
1710
|
]).describe("Status of the draft post.").optional(),
|
|
1705
|
-
moderationDetails: z.object({
|
|
1706
|
-
submittedBy: z.string().describe(
|
|
1711
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1712
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1707
1713
|
"Member ID of the person submitting the draft post for review."
|
|
1708
1714
|
).regex(
|
|
1709
1715
|
/^[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}$/,
|
|
1710
1716
|
"Must be a valid GUID"
|
|
1711
1717
|
).optional(),
|
|
1712
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1713
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1718
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1719
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1714
1720
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1715
1721
|
).optional(),
|
|
1716
|
-
moderatedBy: z.string().describe(
|
|
1722
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1717
1723
|
"Member ID of the person who approved or rejected the post."
|
|
1718
1724
|
).regex(
|
|
1719
1725
|
/^[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}$/,
|
|
1720
1726
|
"Must be a valid GUID"
|
|
1721
1727
|
).optional().nullable(),
|
|
1722
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1728
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1723
1729
|
}).describe(
|
|
1724
1730
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1725
1731
|
).optional(),
|
|
1726
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1732
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1727
1733
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1728
1734
|
).optional(),
|
|
1729
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1730
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1731
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1732
|
-
seoData: z.object({
|
|
1733
|
-
tags: z.array(
|
|
1734
|
-
z.object({
|
|
1735
|
-
type: z.string().describe(
|
|
1735
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1736
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1737
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1738
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1739
|
+
tags: /* @__PURE__ */ z.array(
|
|
1740
|
+
/* @__PURE__ */ z.object({
|
|
1741
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1736
1742
|
"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`)."
|
|
1737
1743
|
).optional(),
|
|
1738
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1744
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1739
1745
|
'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"}`.'
|
|
1740
1746
|
).optional().nullable(),
|
|
1741
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1747
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1742
1748
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1743
1749
|
).optional().nullable(),
|
|
1744
|
-
children: z.string().describe(
|
|
1750
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1745
1751
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1746
1752
|
).optional(),
|
|
1747
|
-
custom: z.boolean().describe(
|
|
1753
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1748
1754
|
"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."
|
|
1749
1755
|
).optional(),
|
|
1750
|
-
disabled: z.boolean().describe(
|
|
1756
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1751
1757
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1752
1758
|
).optional()
|
|
1753
1759
|
})
|
|
1754
1760
|
).optional(),
|
|
1755
|
-
settings: z.object({
|
|
1756
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1761
|
+
settings: /* @__PURE__ */ z.object({
|
|
1762
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1757
1763
|
"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)."
|
|
1758
1764
|
).optional(),
|
|
1759
|
-
keywords: z.array(
|
|
1760
|
-
z.object({
|
|
1761
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1762
|
-
isMain: z.boolean().describe(
|
|
1765
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1766
|
+
/* @__PURE__ */ z.object({
|
|
1767
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1768
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1763
1769
|
"Whether the keyword is the main focus keyword."
|
|
1764
1770
|
).optional(),
|
|
1765
|
-
origin: z.string().describe(
|
|
1771
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1766
1772
|
"The source that added the keyword terms to the SEO settings."
|
|
1767
1773
|
).max(1e3).optional().nullable()
|
|
1768
1774
|
})
|
|
1769
1775
|
).max(5).optional()
|
|
1770
1776
|
}).describe("SEO general settings.").optional()
|
|
1771
1777
|
}).describe("SEO data.").optional(),
|
|
1772
|
-
url: z.string().describe(
|
|
1778
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1773
1779
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1774
1780
|
).optional(),
|
|
1775
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1776
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1777
|
-
media: z.intersection(
|
|
1778
|
-
z.object({
|
|
1779
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1780
|
-
custom: z.boolean().describe(
|
|
1781
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1782
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1783
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1784
|
+
/* @__PURE__ */ z.object({
|
|
1785
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1786
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1781
1787
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1782
1788
|
).optional(),
|
|
1783
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1789
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1784
1790
|
}),
|
|
1785
|
-
z.xor([
|
|
1786
|
-
z.object({
|
|
1787
|
-
wixMedia: z.never().optional(),
|
|
1788
|
-
embedMedia: z.never().optional()
|
|
1791
|
+
/* @__PURE__ */ z.xor([
|
|
1792
|
+
/* @__PURE__ */ z.object({
|
|
1793
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1794
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1789
1795
|
}),
|
|
1790
|
-
z.object({
|
|
1791
|
-
embedMedia: z.never().optional(),
|
|
1792
|
-
wixMedia: z.object({
|
|
1793
|
-
image: z.string().describe("Image details.").optional(),
|
|
1794
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1796
|
+
/* @__PURE__ */ z.object({
|
|
1797
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1798
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1799
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1800
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1795
1801
|
}).describe("Wix Media details.")
|
|
1796
1802
|
}),
|
|
1797
|
-
z.object({
|
|
1798
|
-
wixMedia: z.never().optional(),
|
|
1799
|
-
embedMedia: z.object({
|
|
1800
|
-
thumbnail: z.object({
|
|
1801
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1802
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1803
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1803
|
+
/* @__PURE__ */ z.object({
|
|
1804
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1805
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1806
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
1807
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1808
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1809
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1804
1810
|
}).describe("Thumbnail details.").optional(),
|
|
1805
|
-
video: z.object({
|
|
1806
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
1807
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
1808
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
1811
|
+
video: /* @__PURE__ */ z.object({
|
|
1812
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
1813
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
1814
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
1809
1815
|
}).describe("Video details.").optional()
|
|
1810
1816
|
}).describe("Embed media details.")
|
|
1811
1817
|
})
|
|
1812
1818
|
])
|
|
1813
1819
|
).describe("Post cover media.").optional(),
|
|
1814
|
-
previewTextParagraph: z.number().int().describe(
|
|
1820
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
1815
1821
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
1816
1822
|
).min(0).optional().nullable()
|
|
1817
1823
|
}).describe("Updated draft post info.").optional()
|
|
1818
1824
|
});
|
|
1819
1825
|
var DeleteDraftPostRequest = /* @__PURE__ */ z.object({
|
|
1820
|
-
draftPostId: z.string().describe("Draft post ID.").max(38),
|
|
1821
|
-
options: z.object({
|
|
1822
|
-
permanent: z.boolean().describe(
|
|
1826
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38),
|
|
1827
|
+
options: /* @__PURE__ */ z.object({
|
|
1828
|
+
permanent: /* @__PURE__ */ z.boolean().describe(
|
|
1823
1829
|
"Whether to bypass the trash bin and delete the post permanently.\n\nDefault: `false`"
|
|
1824
1830
|
).optional()
|
|
1825
1831
|
}).describe("Options for deleting a draft post.").optional()
|
|
1826
1832
|
});
|
|
1827
1833
|
var DeleteDraftPostResponse = /* @__PURE__ */ z.object({});
|
|
1828
1834
|
var RemoveFromTrashBinRequest = /* @__PURE__ */ z.object({
|
|
1829
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
1835
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
1830
1836
|
});
|
|
1831
1837
|
var RemoveFromTrashBinResponse = /* @__PURE__ */ z.object({});
|
|
1832
1838
|
var BulkDeleteDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
1833
|
-
postIds: z.array(z.string()).min(1).max(100),
|
|
1834
|
-
options: z.object({
|
|
1835
|
-
permanent: z.boolean().describe("Should delete bypassing the trash-bin.").optional()
|
|
1839
|
+
postIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).min(1).max(100),
|
|
1840
|
+
options: /* @__PURE__ */ z.object({
|
|
1841
|
+
permanent: /* @__PURE__ */ z.boolean().describe("Should delete bypassing the trash-bin.").optional()
|
|
1836
1842
|
}).describe("Options for deleting multiple draft posts.").optional()
|
|
1837
1843
|
});
|
|
1838
1844
|
var BulkDeleteDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
1839
|
-
results: z.array(
|
|
1840
|
-
z.object({
|
|
1841
|
-
itemMetadata: z.object({
|
|
1842
|
-
_id: z.string().describe(
|
|
1845
|
+
results: /* @__PURE__ */ z.array(
|
|
1846
|
+
/* @__PURE__ */ z.object({
|
|
1847
|
+
itemMetadata: /* @__PURE__ */ z.object({
|
|
1848
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
1843
1849
|
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
1844
1850
|
).optional().nullable(),
|
|
1845
|
-
originalIndex: z.number().int().describe(
|
|
1851
|
+
originalIndex: /* @__PURE__ */ z.number().int().describe(
|
|
1846
1852
|
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
1847
1853
|
).optional(),
|
|
1848
|
-
success: z.boolean().describe(
|
|
1854
|
+
success: /* @__PURE__ */ z.boolean().describe(
|
|
1849
1855
|
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
1850
1856
|
).optional(),
|
|
1851
|
-
error: z.object({
|
|
1852
|
-
code: z.string().describe("Error code.").optional(),
|
|
1853
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
1854
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
1857
|
+
error: /* @__PURE__ */ z.object({
|
|
1858
|
+
code: /* @__PURE__ */ z.string().describe("Error code.").optional(),
|
|
1859
|
+
description: /* @__PURE__ */ z.string().describe("Description of the error.").optional(),
|
|
1860
|
+
data: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe("Data related to the error.").optional().nullable()
|
|
1855
1861
|
}).describe("Details about the error in case of failure.").optional()
|
|
1856
1862
|
}).describe("Bulk actions metadata for draft post.").optional(),
|
|
1857
|
-
item: z.object({
|
|
1858
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
1859
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
1860
|
-
excerpt: z.string().describe(
|
|
1863
|
+
item: /* @__PURE__ */ z.object({
|
|
1864
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
1865
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
1866
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
1861
1867
|
"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."
|
|
1862
1868
|
).max(500).optional().nullable(),
|
|
1863
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1864
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
1865
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
1869
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
1870
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
1871
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
1866
1872
|
/^[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}$/,
|
|
1867
1873
|
"Must be a valid GUID"
|
|
1868
1874
|
).optional().nullable(),
|
|
1869
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
1870
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1871
|
-
minutesToRead: z.number().int().describe(
|
|
1875
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1876
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
1877
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
1872
1878
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
1873
1879
|
).optional(),
|
|
1874
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1875
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
1876
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
1877
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
1878
|
-
translationId: z.string().describe(
|
|
1880
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
1881
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
1882
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
1883
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
1884
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
1879
1885
|
"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."
|
|
1880
1886
|
).regex(
|
|
1881
1887
|
/^[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}$/,
|
|
1882
1888
|
"Must be a valid GUID"
|
|
1883
1889
|
).optional().nullable(),
|
|
1884
|
-
language: z.string().describe(
|
|
1890
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
1885
1891
|
"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."
|
|
1886
1892
|
).optional().nullable(),
|
|
1887
|
-
richContent: z.any().describe(
|
|
1893
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
1888
1894
|
'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>'
|
|
1889
1895
|
).optional(),
|
|
1890
|
-
status: z.enum([
|
|
1896
|
+
status: /* @__PURE__ */ z.enum([
|
|
1891
1897
|
"UNKNOWN",
|
|
1892
1898
|
"PUBLISHED",
|
|
1893
1899
|
"UNPUBLISHED",
|
|
@@ -1895,132 +1901,132 @@ var BulkDeleteDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
1895
1901
|
"DELETED",
|
|
1896
1902
|
"IN_REVIEW"
|
|
1897
1903
|
]).describe("Status of the draft post.").optional(),
|
|
1898
|
-
moderationDetails: z.object({
|
|
1899
|
-
submittedBy: z.string().describe(
|
|
1904
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
1905
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
1900
1906
|
"Member ID of the person submitting the draft post for review."
|
|
1901
1907
|
).regex(
|
|
1902
1908
|
/^[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}$/,
|
|
1903
1909
|
"Must be a valid GUID"
|
|
1904
1910
|
).optional(),
|
|
1905
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1906
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1911
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
1912
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
1907
1913
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
1908
1914
|
).optional(),
|
|
1909
|
-
moderatedBy: z.string().describe(
|
|
1915
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
1910
1916
|
"Member ID of the person who approved or rejected the post."
|
|
1911
1917
|
).regex(
|
|
1912
1918
|
/^[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}$/,
|
|
1913
1919
|
"Must be a valid GUID"
|
|
1914
1920
|
).optional().nullable(),
|
|
1915
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1921
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
1916
1922
|
}).describe(
|
|
1917
1923
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
1918
1924
|
).optional(),
|
|
1919
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
1925
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
1920
1926
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
1921
1927
|
).optional(),
|
|
1922
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1923
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1924
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1925
|
-
seoData: z.object({
|
|
1926
|
-
tags: z.array(
|
|
1927
|
-
z.object({
|
|
1928
|
-
type: z.string().describe(
|
|
1928
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
1929
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
1930
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
1931
|
+
seoData: /* @__PURE__ */ z.object({
|
|
1932
|
+
tags: /* @__PURE__ */ z.array(
|
|
1933
|
+
/* @__PURE__ */ z.object({
|
|
1934
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
1929
1935
|
"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`)."
|
|
1930
1936
|
).optional(),
|
|
1931
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1937
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1932
1938
|
'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"}`.'
|
|
1933
1939
|
).optional().nullable(),
|
|
1934
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1940
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1935
1941
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1936
1942
|
).optional().nullable(),
|
|
1937
|
-
children: z.string().describe(
|
|
1943
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
1938
1944
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1939
1945
|
).optional(),
|
|
1940
|
-
custom: z.boolean().describe(
|
|
1946
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1941
1947
|
"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."
|
|
1942
1948
|
).optional(),
|
|
1943
|
-
disabled: z.boolean().describe(
|
|
1949
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
1944
1950
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1945
1951
|
).optional()
|
|
1946
1952
|
})
|
|
1947
1953
|
).optional(),
|
|
1948
|
-
settings: z.object({
|
|
1949
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1954
|
+
settings: /* @__PURE__ */ z.object({
|
|
1955
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
1950
1956
|
"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)."
|
|
1951
1957
|
).optional(),
|
|
1952
|
-
keywords: z.array(
|
|
1953
|
-
z.object({
|
|
1954
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1955
|
-
isMain: z.boolean().describe(
|
|
1958
|
+
keywords: /* @__PURE__ */ z.array(
|
|
1959
|
+
/* @__PURE__ */ z.object({
|
|
1960
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
1961
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
1956
1962
|
"Whether the keyword is the main focus keyword."
|
|
1957
1963
|
).optional(),
|
|
1958
|
-
origin: z.string().describe(
|
|
1964
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
1959
1965
|
"The source that added the keyword terms to the SEO settings."
|
|
1960
1966
|
).max(1e3).optional().nullable()
|
|
1961
1967
|
})
|
|
1962
1968
|
).max(5).optional()
|
|
1963
1969
|
}).describe("SEO general settings.").optional()
|
|
1964
1970
|
}).describe("SEO data.").optional(),
|
|
1965
|
-
url: z.string().describe(
|
|
1971
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1966
1972
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
1967
1973
|
).optional(),
|
|
1968
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1969
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1970
|
-
media: z.intersection(
|
|
1971
|
-
z.object({
|
|
1972
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1973
|
-
custom: z.boolean().describe(
|
|
1974
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
1975
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
1976
|
+
media: /* @__PURE__ */ z.intersection(
|
|
1977
|
+
/* @__PURE__ */ z.object({
|
|
1978
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
1979
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
1974
1980
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
1975
1981
|
).optional(),
|
|
1976
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1982
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
1977
1983
|
}),
|
|
1978
|
-
z.xor([
|
|
1979
|
-
z.object({
|
|
1980
|
-
wixMedia: z.never().optional(),
|
|
1981
|
-
embedMedia: z.never().optional()
|
|
1984
|
+
/* @__PURE__ */ z.xor([
|
|
1985
|
+
/* @__PURE__ */ z.object({
|
|
1986
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1987
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
1982
1988
|
}),
|
|
1983
|
-
z.object({
|
|
1984
|
-
embedMedia: z.never().optional(),
|
|
1985
|
-
wixMedia: z.object({
|
|
1986
|
-
image: z.string().describe("Image details.").optional(),
|
|
1987
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
1989
|
+
/* @__PURE__ */ z.object({
|
|
1990
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
1991
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
1992
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
1993
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
1988
1994
|
}).describe("Wix Media details.")
|
|
1989
1995
|
}),
|
|
1990
|
-
z.object({
|
|
1991
|
-
wixMedia: z.never().optional(),
|
|
1992
|
-
embedMedia: z.object({
|
|
1993
|
-
thumbnail: z.object({
|
|
1994
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
1995
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
1996
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1996
|
+
/* @__PURE__ */ z.object({
|
|
1997
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
1998
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
1999
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2000
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2001
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2002
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
1997
2003
|
}).describe("Thumbnail details.").optional(),
|
|
1998
|
-
video: z.object({
|
|
1999
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2000
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2001
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2004
|
+
video: /* @__PURE__ */ z.object({
|
|
2005
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2006
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2007
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2002
2008
|
}).describe("Video details.").optional()
|
|
2003
2009
|
}).describe("Embed media details.")
|
|
2004
2010
|
})
|
|
2005
2011
|
])
|
|
2006
2012
|
).describe("Post cover media.").optional(),
|
|
2007
|
-
previewTextParagraph: z.number().int().describe(
|
|
2013
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2008
2014
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2009
2015
|
).min(0).optional().nullable()
|
|
2010
2016
|
}).describe("Optional full draft post.").optional()
|
|
2011
2017
|
})
|
|
2012
2018
|
).optional(),
|
|
2013
|
-
bulkActionMetadata: z.object({
|
|
2014
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
2015
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
2016
|
-
undetailedFailures: z.number().int().describe(
|
|
2019
|
+
bulkActionMetadata: /* @__PURE__ */ z.object({
|
|
2020
|
+
totalSuccesses: /* @__PURE__ */ z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
2021
|
+
totalFailures: /* @__PURE__ */ z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
2022
|
+
undetailedFailures: /* @__PURE__ */ z.number().int().describe(
|
|
2017
2023
|
"Number of failures without details because detailed failure threshold was exceeded."
|
|
2018
2024
|
).optional()
|
|
2019
2025
|
}).describe("Bulk action metadata.").optional()
|
|
2020
2026
|
});
|
|
2021
2027
|
var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
2022
|
-
options: z.object({
|
|
2023
|
-
status: z.enum([
|
|
2028
|
+
options: /* @__PURE__ */ z.object({
|
|
2029
|
+
status: /* @__PURE__ */ z.enum([
|
|
2024
2030
|
"UNKNOWN",
|
|
2025
2031
|
"PUBLISHED",
|
|
2026
2032
|
"UNPUBLISHED",
|
|
@@ -2028,21 +2034,21 @@ var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2028
2034
|
"DELETED",
|
|
2029
2035
|
"IN_REVIEW"
|
|
2030
2036
|
]).optional(),
|
|
2031
|
-
language: z.string().describe(
|
|
2037
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2032
2038
|
"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."
|
|
2033
2039
|
).optional().nullable(),
|
|
2034
|
-
sort: z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
2035
|
-
paging: z.object({
|
|
2036
|
-
offset: z.number().int().describe(
|
|
2040
|
+
sort: /* @__PURE__ */ z.enum(["EDITING_DATE_DESC", "EDITING_DATE_ASC"]).optional(),
|
|
2041
|
+
paging: /* @__PURE__ */ z.object({
|
|
2042
|
+
offset: /* @__PURE__ */ z.number().int().describe(
|
|
2037
2043
|
"Number of items to skip in the current sort order.\n\n\nDefault: `0`"
|
|
2038
2044
|
).min(0).optional(),
|
|
2039
|
-
limit: z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
2040
|
-
cursor: z.string().describe(
|
|
2045
|
+
limit: /* @__PURE__ */ z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
2046
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
2041
2047
|
"Pointer to the next or previous page in the list of results."
|
|
2042
2048
|
).max(2e3).optional().nullable()
|
|
2043
2049
|
}).describe("Pagination options.").optional(),
|
|
2044
|
-
fieldsets: z.array(
|
|
2045
|
-
z.enum([
|
|
2050
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
2051
|
+
/* @__PURE__ */ z.enum([
|
|
2046
2052
|
"UNKNOWN",
|
|
2047
2053
|
"URL",
|
|
2048
2054
|
"CONTENT",
|
|
@@ -2053,41 +2059,41 @@ var ListDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2053
2059
|
}).describe("Options for listing multiple draft posts.").optional()
|
|
2054
2060
|
});
|
|
2055
2061
|
var ListDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
2056
|
-
draftPosts: z.array(
|
|
2057
|
-
z.object({
|
|
2058
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2059
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2060
|
-
excerpt: z.string().describe(
|
|
2062
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
2063
|
+
/* @__PURE__ */ z.object({
|
|
2064
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2065
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2066
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2061
2067
|
"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."
|
|
2062
2068
|
).max(500).optional().nullable(),
|
|
2063
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2064
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2065
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2069
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2070
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2071
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2066
2072
|
/^[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}$/,
|
|
2067
2073
|
"Must be a valid GUID"
|
|
2068
2074
|
).optional().nullable(),
|
|
2069
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2070
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2071
|
-
minutesToRead: z.number().int().describe(
|
|
2075
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2076
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2077
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2072
2078
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2073
2079
|
).optional(),
|
|
2074
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2075
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2076
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2077
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2078
|
-
translationId: z.string().describe(
|
|
2080
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2081
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2082
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2083
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2084
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2079
2085
|
"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."
|
|
2080
2086
|
).regex(
|
|
2081
2087
|
/^[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}$/,
|
|
2082
2088
|
"Must be a valid GUID"
|
|
2083
2089
|
).optional().nullable(),
|
|
2084
|
-
language: z.string().describe(
|
|
2090
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2085
2091
|
"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."
|
|
2086
2092
|
).optional().nullable(),
|
|
2087
|
-
richContent: z.any().describe(
|
|
2093
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2088
2094
|
'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>'
|
|
2089
2095
|
).optional(),
|
|
2090
|
-
status: z.enum([
|
|
2096
|
+
status: /* @__PURE__ */ z.enum([
|
|
2091
2097
|
"UNKNOWN",
|
|
2092
2098
|
"PUBLISHED",
|
|
2093
2099
|
"UNPUBLISHED",
|
|
@@ -2095,167 +2101,167 @@ var ListDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2095
2101
|
"DELETED",
|
|
2096
2102
|
"IN_REVIEW"
|
|
2097
2103
|
]).describe("Status of the draft post.").optional(),
|
|
2098
|
-
moderationDetails: z.object({
|
|
2099
|
-
submittedBy: z.string().describe(
|
|
2104
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2105
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2100
2106
|
"Member ID of the person submitting the draft post for review."
|
|
2101
2107
|
).regex(
|
|
2102
2108
|
/^[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}$/,
|
|
2103
2109
|
"Must be a valid GUID"
|
|
2104
2110
|
).optional(),
|
|
2105
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2106
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2111
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2112
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2107
2113
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2108
2114
|
).optional(),
|
|
2109
|
-
moderatedBy: z.string().describe(
|
|
2115
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2110
2116
|
"Member ID of the person who approved or rejected the post."
|
|
2111
2117
|
).regex(
|
|
2112
2118
|
/^[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}$/,
|
|
2113
2119
|
"Must be a valid GUID"
|
|
2114
2120
|
).optional().nullable(),
|
|
2115
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2121
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2116
2122
|
}).describe(
|
|
2117
2123
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2118
2124
|
).optional(),
|
|
2119
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2125
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2120
2126
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2121
2127
|
).optional(),
|
|
2122
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2123
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2124
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2125
|
-
seoData: z.object({
|
|
2126
|
-
tags: z.array(
|
|
2127
|
-
z.object({
|
|
2128
|
-
type: z.string().describe(
|
|
2128
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2129
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2130
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2131
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2132
|
+
tags: /* @__PURE__ */ z.array(
|
|
2133
|
+
/* @__PURE__ */ z.object({
|
|
2134
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2129
2135
|
"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`)."
|
|
2130
2136
|
).optional(),
|
|
2131
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2137
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2132
2138
|
'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"}`.'
|
|
2133
2139
|
).optional().nullable(),
|
|
2134
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2140
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2135
2141
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2136
2142
|
).optional().nullable(),
|
|
2137
|
-
children: z.string().describe(
|
|
2143
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2138
2144
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2139
2145
|
).optional(),
|
|
2140
|
-
custom: z.boolean().describe(
|
|
2146
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2141
2147
|
"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."
|
|
2142
2148
|
).optional(),
|
|
2143
|
-
disabled: z.boolean().describe(
|
|
2149
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2144
2150
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2145
2151
|
).optional()
|
|
2146
2152
|
})
|
|
2147
2153
|
).optional(),
|
|
2148
|
-
settings: z.object({
|
|
2149
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2154
|
+
settings: /* @__PURE__ */ z.object({
|
|
2155
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2150
2156
|
"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)."
|
|
2151
2157
|
).optional(),
|
|
2152
|
-
keywords: z.array(
|
|
2153
|
-
z.object({
|
|
2154
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2155
|
-
isMain: z.boolean().describe(
|
|
2158
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2159
|
+
/* @__PURE__ */ z.object({
|
|
2160
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2161
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2156
2162
|
"Whether the keyword is the main focus keyword."
|
|
2157
2163
|
).optional(),
|
|
2158
|
-
origin: z.string().describe(
|
|
2164
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2159
2165
|
"The source that added the keyword terms to the SEO settings."
|
|
2160
2166
|
).max(1e3).optional().nullable()
|
|
2161
2167
|
})
|
|
2162
2168
|
).max(5).optional()
|
|
2163
2169
|
}).describe("SEO general settings.").optional()
|
|
2164
2170
|
}).describe("SEO data.").optional(),
|
|
2165
|
-
url: z.string().describe(
|
|
2171
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2166
2172
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2167
2173
|
).optional(),
|
|
2168
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2169
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2170
|
-
media: z.intersection(
|
|
2171
|
-
z.object({
|
|
2172
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2173
|
-
custom: z.boolean().describe(
|
|
2174
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2175
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2176
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2177
|
+
/* @__PURE__ */ z.object({
|
|
2178
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2179
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2174
2180
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2175
2181
|
).optional(),
|
|
2176
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2182
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2177
2183
|
}),
|
|
2178
|
-
z.xor([
|
|
2179
|
-
z.object({
|
|
2180
|
-
wixMedia: z.never().optional(),
|
|
2181
|
-
embedMedia: z.never().optional()
|
|
2184
|
+
/* @__PURE__ */ z.xor([
|
|
2185
|
+
/* @__PURE__ */ z.object({
|
|
2186
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2187
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2182
2188
|
}),
|
|
2183
|
-
z.object({
|
|
2184
|
-
embedMedia: z.never().optional(),
|
|
2185
|
-
wixMedia: z.object({
|
|
2186
|
-
image: z.string().describe("Image details.").optional(),
|
|
2187
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2189
|
+
/* @__PURE__ */ z.object({
|
|
2190
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2191
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2192
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2193
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2188
2194
|
}).describe("Wix Media details.")
|
|
2189
2195
|
}),
|
|
2190
|
-
z.object({
|
|
2191
|
-
wixMedia: z.never().optional(),
|
|
2192
|
-
embedMedia: z.object({
|
|
2193
|
-
thumbnail: z.object({
|
|
2194
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2195
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2196
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2196
|
+
/* @__PURE__ */ z.object({
|
|
2197
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2198
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2199
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2200
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2201
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2202
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2197
2203
|
}).describe("Thumbnail details.").optional(),
|
|
2198
|
-
video: z.object({
|
|
2199
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2200
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2201
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2204
|
+
video: /* @__PURE__ */ z.object({
|
|
2205
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2206
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2207
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2202
2208
|
}).describe("Video details.").optional()
|
|
2203
2209
|
}).describe("Embed media details.")
|
|
2204
2210
|
})
|
|
2205
2211
|
])
|
|
2206
2212
|
).describe("Post cover media.").optional(),
|
|
2207
|
-
previewTextParagraph: z.number().int().describe(
|
|
2213
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2208
2214
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2209
2215
|
).min(0).optional().nullable()
|
|
2210
2216
|
})
|
|
2211
2217
|
).optional(),
|
|
2212
|
-
metaData: z.object({
|
|
2213
|
-
count: z.number().int().describe("Number of items returned in this response.").optional(),
|
|
2214
|
-
offset: z.number().int().describe("Requested offset.").optional(),
|
|
2215
|
-
total: z.number().int().describe("Total number of items that match the query.").optional(),
|
|
2216
|
-
cursor: z.string().describe(
|
|
2218
|
+
metaData: /* @__PURE__ */ z.object({
|
|
2219
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in this response.").optional(),
|
|
2220
|
+
offset: /* @__PURE__ */ z.number().int().describe("Requested offset.").optional(),
|
|
2221
|
+
total: /* @__PURE__ */ z.number().int().describe("Total number of items that match the query.").optional(),
|
|
2222
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
2217
2223
|
"Pointer to the next or previous page in the list of results."
|
|
2218
2224
|
).max(2e3).optional().nullable()
|
|
2219
2225
|
}).describe("Details on the paged set of results returned.").optional()
|
|
2220
2226
|
});
|
|
2221
2227
|
var GetDeletedDraftPostRequest = /* @__PURE__ */ z.object({
|
|
2222
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2228
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2223
2229
|
});
|
|
2224
2230
|
var GetDeletedDraftPostResponse = /* @__PURE__ */ z.object({
|
|
2225
|
-
draftPost: z.object({
|
|
2226
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2227
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2228
|
-
excerpt: z.string().describe(
|
|
2231
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
2232
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2233
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2234
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2229
2235
|
"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."
|
|
2230
2236
|
).max(500).optional().nullable(),
|
|
2231
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2232
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2233
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2237
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2238
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2239
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2234
2240
|
/^[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}$/,
|
|
2235
2241
|
"Must be a valid GUID"
|
|
2236
2242
|
).optional().nullable(),
|
|
2237
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2238
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2239
|
-
minutesToRead: z.number().int().describe(
|
|
2243
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2244
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2245
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2240
2246
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2241
2247
|
).optional(),
|
|
2242
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2243
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2244
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2245
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2246
|
-
translationId: z.string().describe(
|
|
2248
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2249
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2250
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2251
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2252
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2247
2253
|
"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."
|
|
2248
2254
|
).regex(
|
|
2249
2255
|
/^[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}$/,
|
|
2250
2256
|
"Must be a valid GUID"
|
|
2251
2257
|
).optional().nullable(),
|
|
2252
|
-
language: z.string().describe(
|
|
2258
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2253
2259
|
"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."
|
|
2254
2260
|
).optional().nullable(),
|
|
2255
|
-
richContent: z.any().describe(
|
|
2261
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2256
2262
|
'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>'
|
|
2257
2263
|
).optional(),
|
|
2258
|
-
status: z.enum([
|
|
2264
|
+
status: /* @__PURE__ */ z.enum([
|
|
2259
2265
|
"UNKNOWN",
|
|
2260
2266
|
"PUBLISHED",
|
|
2261
2267
|
"UNPUBLISHED",
|
|
@@ -2263,158 +2269,158 @@ var GetDeletedDraftPostResponse = /* @__PURE__ */ z.object({
|
|
|
2263
2269
|
"DELETED",
|
|
2264
2270
|
"IN_REVIEW"
|
|
2265
2271
|
]).describe("Status of the draft post.").optional(),
|
|
2266
|
-
moderationDetails: z.object({
|
|
2267
|
-
submittedBy: z.string().describe(
|
|
2272
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2273
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2268
2274
|
"Member ID of the person submitting the draft post for review."
|
|
2269
2275
|
).regex(
|
|
2270
2276
|
/^[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}$/,
|
|
2271
2277
|
"Must be a valid GUID"
|
|
2272
2278
|
).optional(),
|
|
2273
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2274
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2279
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2280
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2275
2281
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2276
2282
|
).optional(),
|
|
2277
|
-
moderatedBy: z.string().describe(
|
|
2283
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2278
2284
|
"Member ID of the person who approved or rejected the post."
|
|
2279
2285
|
).regex(
|
|
2280
2286
|
/^[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}$/,
|
|
2281
2287
|
"Must be a valid GUID"
|
|
2282
2288
|
).optional().nullable(),
|
|
2283
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2289
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2284
2290
|
}).describe(
|
|
2285
2291
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2286
2292
|
).optional(),
|
|
2287
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2293
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2288
2294
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2289
2295
|
).optional(),
|
|
2290
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2291
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2292
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2293
|
-
seoData: z.object({
|
|
2294
|
-
tags: z.array(
|
|
2295
|
-
z.object({
|
|
2296
|
-
type: z.string().describe(
|
|
2296
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2297
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2298
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2299
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2300
|
+
tags: /* @__PURE__ */ z.array(
|
|
2301
|
+
/* @__PURE__ */ z.object({
|
|
2302
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2297
2303
|
"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`)."
|
|
2298
2304
|
).optional(),
|
|
2299
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2305
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2300
2306
|
'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"}`.'
|
|
2301
2307
|
).optional().nullable(),
|
|
2302
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2308
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2303
2309
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2304
2310
|
).optional().nullable(),
|
|
2305
|
-
children: z.string().describe(
|
|
2311
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2306
2312
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2307
2313
|
).optional(),
|
|
2308
|
-
custom: z.boolean().describe(
|
|
2314
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2309
2315
|
"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."
|
|
2310
2316
|
).optional(),
|
|
2311
|
-
disabled: z.boolean().describe(
|
|
2317
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2312
2318
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2313
2319
|
).optional()
|
|
2314
2320
|
})
|
|
2315
2321
|
).optional(),
|
|
2316
|
-
settings: z.object({
|
|
2317
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2322
|
+
settings: /* @__PURE__ */ z.object({
|
|
2323
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2318
2324
|
"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)."
|
|
2319
2325
|
).optional(),
|
|
2320
|
-
keywords: z.array(
|
|
2321
|
-
z.object({
|
|
2322
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2323
|
-
isMain: z.boolean().describe(
|
|
2326
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2327
|
+
/* @__PURE__ */ z.object({
|
|
2328
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2329
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2324
2330
|
"Whether the keyword is the main focus keyword."
|
|
2325
2331
|
).optional(),
|
|
2326
|
-
origin: z.string().describe(
|
|
2332
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2327
2333
|
"The source that added the keyword terms to the SEO settings."
|
|
2328
2334
|
).max(1e3).optional().nullable()
|
|
2329
2335
|
})
|
|
2330
2336
|
).max(5).optional()
|
|
2331
2337
|
}).describe("SEO general settings.").optional()
|
|
2332
2338
|
}).describe("SEO data.").optional(),
|
|
2333
|
-
url: z.string().describe(
|
|
2339
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2334
2340
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2335
2341
|
).optional(),
|
|
2336
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2337
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2338
|
-
media: z.intersection(
|
|
2339
|
-
z.object({
|
|
2340
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2341
|
-
custom: z.boolean().describe(
|
|
2342
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2343
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2344
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2345
|
+
/* @__PURE__ */ z.object({
|
|
2346
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2347
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2342
2348
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2343
2349
|
).optional(),
|
|
2344
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2350
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2345
2351
|
}),
|
|
2346
|
-
z.xor([
|
|
2347
|
-
z.object({
|
|
2348
|
-
wixMedia: z.never().optional(),
|
|
2349
|
-
embedMedia: z.never().optional()
|
|
2352
|
+
/* @__PURE__ */ z.xor([
|
|
2353
|
+
/* @__PURE__ */ z.object({
|
|
2354
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2355
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2350
2356
|
}),
|
|
2351
|
-
z.object({
|
|
2352
|
-
embedMedia: z.never().optional(),
|
|
2353
|
-
wixMedia: z.object({
|
|
2354
|
-
image: z.string().describe("Image details.").optional(),
|
|
2355
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2357
|
+
/* @__PURE__ */ z.object({
|
|
2358
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2359
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2360
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2361
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2356
2362
|
}).describe("Wix Media details.")
|
|
2357
2363
|
}),
|
|
2358
|
-
z.object({
|
|
2359
|
-
wixMedia: z.never().optional(),
|
|
2360
|
-
embedMedia: z.object({
|
|
2361
|
-
thumbnail: z.object({
|
|
2362
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2363
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2364
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2364
|
+
/* @__PURE__ */ z.object({
|
|
2365
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2366
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2367
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2368
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2369
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2370
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2365
2371
|
}).describe("Thumbnail details.").optional(),
|
|
2366
|
-
video: z.object({
|
|
2367
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2368
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2369
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2372
|
+
video: /* @__PURE__ */ z.object({
|
|
2373
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2374
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2375
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2370
2376
|
}).describe("Video details.").optional()
|
|
2371
2377
|
}).describe("Embed media details.")
|
|
2372
2378
|
})
|
|
2373
2379
|
])
|
|
2374
2380
|
).describe("Post cover media.").optional(),
|
|
2375
|
-
previewTextParagraph: z.number().int().describe(
|
|
2381
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2376
2382
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2377
2383
|
).min(0).optional().nullable()
|
|
2378
2384
|
}).describe("Draft post info.").optional()
|
|
2379
2385
|
});
|
|
2380
2386
|
var RestoreFromTrashBinRequest = /* @__PURE__ */ z.object({
|
|
2381
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2387
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2382
2388
|
});
|
|
2383
2389
|
var RestoreFromTrashBinResponse = /* @__PURE__ */ z.object({
|
|
2384
|
-
draftPost: z.object({
|
|
2385
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2386
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2387
|
-
excerpt: z.string().describe(
|
|
2390
|
+
draftPost: /* @__PURE__ */ z.object({
|
|
2391
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2392
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2393
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2388
2394
|
"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."
|
|
2389
2395
|
).max(500).optional().nullable(),
|
|
2390
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2391
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2392
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2396
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2397
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2398
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2393
2399
|
/^[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}$/,
|
|
2394
2400
|
"Must be a valid GUID"
|
|
2395
2401
|
).optional().nullable(),
|
|
2396
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2397
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2398
|
-
minutesToRead: z.number().int().describe(
|
|
2402
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2403
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2404
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2399
2405
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2400
2406
|
).optional(),
|
|
2401
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2402
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2403
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2404
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2405
|
-
translationId: z.string().describe(
|
|
2407
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2408
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2409
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2410
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2411
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2406
2412
|
"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."
|
|
2407
2413
|
).regex(
|
|
2408
2414
|
/^[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}$/,
|
|
2409
2415
|
"Must be a valid GUID"
|
|
2410
2416
|
).optional().nullable(),
|
|
2411
|
-
language: z.string().describe(
|
|
2417
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2412
2418
|
"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."
|
|
2413
2419
|
).optional().nullable(),
|
|
2414
|
-
richContent: z.any().describe(
|
|
2420
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2415
2421
|
'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>'
|
|
2416
2422
|
).optional(),
|
|
2417
|
-
status: z.enum([
|
|
2423
|
+
status: /* @__PURE__ */ z.enum([
|
|
2418
2424
|
"UNKNOWN",
|
|
2419
2425
|
"PUBLISHED",
|
|
2420
2426
|
"UNPUBLISHED",
|
|
@@ -2422,225 +2428,234 @@ var RestoreFromTrashBinResponse = /* @__PURE__ */ z.object({
|
|
|
2422
2428
|
"DELETED",
|
|
2423
2429
|
"IN_REVIEW"
|
|
2424
2430
|
]).describe("Status of the draft post.").optional(),
|
|
2425
|
-
moderationDetails: z.object({
|
|
2426
|
-
submittedBy: z.string().describe(
|
|
2431
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2432
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2427
2433
|
"Member ID of the person submitting the draft post for review."
|
|
2428
2434
|
).regex(
|
|
2429
2435
|
/^[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}$/,
|
|
2430
2436
|
"Must be a valid GUID"
|
|
2431
2437
|
).optional(),
|
|
2432
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2433
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2438
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2439
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2434
2440
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2435
2441
|
).optional(),
|
|
2436
|
-
moderatedBy: z.string().describe(
|
|
2442
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2437
2443
|
"Member ID of the person who approved or rejected the post."
|
|
2438
2444
|
).regex(
|
|
2439
2445
|
/^[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}$/,
|
|
2440
2446
|
"Must be a valid GUID"
|
|
2441
2447
|
).optional().nullable(),
|
|
2442
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2448
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2443
2449
|
}).describe(
|
|
2444
2450
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2445
2451
|
).optional(),
|
|
2446
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2452
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2447
2453
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2448
2454
|
).optional(),
|
|
2449
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2450
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2451
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2452
|
-
seoData: z.object({
|
|
2453
|
-
tags: z.array(
|
|
2454
|
-
z.object({
|
|
2455
|
-
type: z.string().describe(
|
|
2455
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2456
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2457
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2458
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2459
|
+
tags: /* @__PURE__ */ z.array(
|
|
2460
|
+
/* @__PURE__ */ z.object({
|
|
2461
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2456
2462
|
"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`)."
|
|
2457
2463
|
).optional(),
|
|
2458
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2464
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2459
2465
|
'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"}`.'
|
|
2460
2466
|
).optional().nullable(),
|
|
2461
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2467
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2462
2468
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2463
2469
|
).optional().nullable(),
|
|
2464
|
-
children: z.string().describe(
|
|
2470
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2465
2471
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2466
2472
|
).optional(),
|
|
2467
|
-
custom: z.boolean().describe(
|
|
2473
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2468
2474
|
"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."
|
|
2469
2475
|
).optional(),
|
|
2470
|
-
disabled: z.boolean().describe(
|
|
2476
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2471
2477
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2472
2478
|
).optional()
|
|
2473
2479
|
})
|
|
2474
2480
|
).optional(),
|
|
2475
|
-
settings: z.object({
|
|
2476
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2481
|
+
settings: /* @__PURE__ */ z.object({
|
|
2482
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2477
2483
|
"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)."
|
|
2478
2484
|
).optional(),
|
|
2479
|
-
keywords: z.array(
|
|
2480
|
-
z.object({
|
|
2481
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2482
|
-
isMain: z.boolean().describe(
|
|
2485
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2486
|
+
/* @__PURE__ */ z.object({
|
|
2487
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2488
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2483
2489
|
"Whether the keyword is the main focus keyword."
|
|
2484
2490
|
).optional(),
|
|
2485
|
-
origin: z.string().describe(
|
|
2491
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2486
2492
|
"The source that added the keyword terms to the SEO settings."
|
|
2487
2493
|
).max(1e3).optional().nullable()
|
|
2488
2494
|
})
|
|
2489
2495
|
).max(5).optional()
|
|
2490
2496
|
}).describe("SEO general settings.").optional()
|
|
2491
2497
|
}).describe("SEO data.").optional(),
|
|
2492
|
-
url: z.string().describe(
|
|
2498
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2493
2499
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2494
2500
|
).optional(),
|
|
2495
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2496
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2497
|
-
media: z.intersection(
|
|
2498
|
-
z.object({
|
|
2499
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2500
|
-
custom: z.boolean().describe(
|
|
2501
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2502
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2503
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2504
|
+
/* @__PURE__ */ z.object({
|
|
2505
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2506
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2501
2507
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2502
2508
|
).optional(),
|
|
2503
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2509
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2504
2510
|
}),
|
|
2505
|
-
z.xor([
|
|
2506
|
-
z.object({
|
|
2507
|
-
wixMedia: z.never().optional(),
|
|
2508
|
-
embedMedia: z.never().optional()
|
|
2511
|
+
/* @__PURE__ */ z.xor([
|
|
2512
|
+
/* @__PURE__ */ z.object({
|
|
2513
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2514
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2509
2515
|
}),
|
|
2510
|
-
z.object({
|
|
2511
|
-
embedMedia: z.never().optional(),
|
|
2512
|
-
wixMedia: z.object({
|
|
2513
|
-
image: z.string().describe("Image details.").optional(),
|
|
2514
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2516
|
+
/* @__PURE__ */ z.object({
|
|
2517
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2518
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2519
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2520
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2515
2521
|
}).describe("Wix Media details.")
|
|
2516
2522
|
}),
|
|
2517
|
-
z.object({
|
|
2518
|
-
wixMedia: z.never().optional(),
|
|
2519
|
-
embedMedia: z.object({
|
|
2520
|
-
thumbnail: z.object({
|
|
2521
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2522
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2523
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2523
|
+
/* @__PURE__ */ z.object({
|
|
2524
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2525
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2526
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2527
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2528
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2529
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2524
2530
|
}).describe("Thumbnail details.").optional(),
|
|
2525
|
-
video: z.object({
|
|
2526
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2527
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2528
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2531
|
+
video: /* @__PURE__ */ z.object({
|
|
2532
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2533
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2534
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2529
2535
|
}).describe("Video details.").optional()
|
|
2530
2536
|
}).describe("Embed media details.")
|
|
2531
2537
|
})
|
|
2532
2538
|
])
|
|
2533
2539
|
).describe("Post cover media.").optional(),
|
|
2534
|
-
previewTextParagraph: z.number().int().describe(
|
|
2540
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2535
2541
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2536
2542
|
).min(0).optional().nullable()
|
|
2537
2543
|
}).describe("Restored draft post info.").optional()
|
|
2538
2544
|
});
|
|
2539
2545
|
var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
2540
|
-
query: z.object({
|
|
2541
|
-
filter: z.object({
|
|
2542
|
-
_id: z.object({
|
|
2543
|
-
$eq: z.string(),
|
|
2544
|
-
$in: z.array(z.string()),
|
|
2545
|
-
$ne: z.string(),
|
|
2546
|
-
$nin: z.array(z.string())
|
|
2546
|
+
query: /* @__PURE__ */ z.object({
|
|
2547
|
+
filter: /* @__PURE__ */ z.object({
|
|
2548
|
+
_id: /* @__PURE__ */ z.object({
|
|
2549
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2550
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2551
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2552
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2547
2553
|
}).partial().strict().optional(),
|
|
2548
|
-
title: z.object({
|
|
2549
|
-
$eq: z.string(),
|
|
2550
|
-
$exists: z.boolean(),
|
|
2551
|
-
$gt: z.string(),
|
|
2552
|
-
$gte: z.string(),
|
|
2553
|
-
$in: z.array(z.string()),
|
|
2554
|
-
$lt: z.string(),
|
|
2555
|
-
$lte: z.string(),
|
|
2556
|
-
$ne: z.string(),
|
|
2557
|
-
$startsWith: z.string()
|
|
2554
|
+
title: /* @__PURE__ */ z.object({
|
|
2555
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2556
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2557
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2558
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2559
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2560
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2561
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2562
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2563
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2558
2564
|
}).partial().strict().optional(),
|
|
2559
|
-
excerpt: z.object({
|
|
2560
|
-
$eq: z.string(),
|
|
2561
|
-
$exists: z.boolean(),
|
|
2562
|
-
$gt: z.string(),
|
|
2563
|
-
$gte: z.string(),
|
|
2564
|
-
$in: z.array(z.string()),
|
|
2565
|
-
$lt: z.string(),
|
|
2566
|
-
$lte: z.string(),
|
|
2567
|
-
$ne: z.string(),
|
|
2568
|
-
$startsWith: z.string()
|
|
2565
|
+
excerpt: /* @__PURE__ */ z.object({
|
|
2566
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2567
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2568
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2569
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2570
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2571
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2572
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2573
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2574
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2569
2575
|
}).partial().strict().optional(),
|
|
2570
|
-
status: z.object({
|
|
2571
|
-
$eq: z.string(),
|
|
2572
|
-
$in: z.array(z.string()),
|
|
2573
|
-
$ne: z.string(),
|
|
2574
|
-
$nin: z.array(z.string())
|
|
2576
|
+
status: /* @__PURE__ */ z.object({
|
|
2577
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2578
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2579
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2580
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2575
2581
|
}).partial().strict().optional(),
|
|
2576
|
-
scheduledPublishDate: z.object({
|
|
2577
|
-
$eq: z.string(),
|
|
2578
|
-
$gt: z.string(),
|
|
2579
|
-
$gte: z.string(),
|
|
2580
|
-
$in: z.array(z.string()),
|
|
2581
|
-
$lt: z.string(),
|
|
2582
|
-
$lte: z.string(),
|
|
2583
|
-
$ne: z.string()
|
|
2582
|
+
scheduledPublishDate: /* @__PURE__ */ z.object({
|
|
2583
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2584
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2585
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2586
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2587
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2588
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2589
|
+
$ne: /* @__PURE__ */ z.string()
|
|
2584
2590
|
}).partial().strict().optional(),
|
|
2585
|
-
editedDate: z.object({
|
|
2586
|
-
$eq: z.string(),
|
|
2587
|
-
$gt: z.string(),
|
|
2588
|
-
$gte: z.string(),
|
|
2589
|
-
$in: z.array(z.string()),
|
|
2590
|
-
$lt: z.string(),
|
|
2591
|
-
$lte: z.string(),
|
|
2592
|
-
$ne: z.string()
|
|
2591
|
+
editedDate: /* @__PURE__ */ z.object({
|
|
2592
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2593
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2594
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2595
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2596
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2597
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2598
|
+
$ne: /* @__PURE__ */ z.string()
|
|
2593
2599
|
}).partial().strict().optional(),
|
|
2594
|
-
categoryIds: z.object({
|
|
2595
|
-
$hasAll: z.array(z.string()),
|
|
2596
|
-
$hasSome: z.array(z.string())
|
|
2600
|
+
categoryIds: /* @__PURE__ */ z.object({
|
|
2601
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2602
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2597
2603
|
}).partial().strict().optional(),
|
|
2598
|
-
hashtags: z.object({
|
|
2599
|
-
$hasAll: z.array(z.string()),
|
|
2600
|
-
$hasSome: z.array(z.string())
|
|
2604
|
+
hashtags: /* @__PURE__ */ z.object({
|
|
2605
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2606
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2601
2607
|
}).partial().strict().optional(),
|
|
2602
|
-
tagIds: z.object({
|
|
2603
|
-
$hasAll: z.array(z.string()),
|
|
2604
|
-
$hasSome: z.array(z.string())
|
|
2608
|
+
tagIds: /* @__PURE__ */ z.object({
|
|
2609
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2610
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2605
2611
|
}).partial().strict().optional(),
|
|
2606
|
-
pricingPlanIds: z.object({
|
|
2607
|
-
$hasAll: z.array(z.string()),
|
|
2608
|
-
$hasSome: z.array(z.string())
|
|
2612
|
+
pricingPlanIds: /* @__PURE__ */ z.object({
|
|
2613
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2614
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2609
2615
|
}).partial().strict().optional(),
|
|
2610
|
-
memberId: z.object({}).partial().strict().optional(),
|
|
2611
|
-
featured:
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
minutesToRead: z.object({
|
|
2615
|
-
$eq: z.number(),
|
|
2616
|
-
$gt: z.number(),
|
|
2617
|
-
$gte: z.number(),
|
|
2618
|
-
$in: z.array(z.number()),
|
|
2619
|
-
$lt: z.number(),
|
|
2620
|
-
$lte: z.number(),
|
|
2621
|
-
$ne: z.number()
|
|
2616
|
+
memberId: /* @__PURE__ */ z.object({}).partial().strict().optional(),
|
|
2617
|
+
featured: /* @__PURE__ */ z.object({
|
|
2618
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2619
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2622
2620
|
}).partial().strict().optional(),
|
|
2623
|
-
|
|
2624
|
-
$eq: z.
|
|
2625
|
-
$
|
|
2626
|
-
$in: z.array(z.string()),
|
|
2627
|
-
$ne: z.string(),
|
|
2628
|
-
$nin: z.array(z.string())
|
|
2621
|
+
commentingEnabled: /* @__PURE__ */ z.object({
|
|
2622
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2623
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2629
2624
|
}).partial().strict().optional(),
|
|
2630
|
-
|
|
2631
|
-
$eq: z.
|
|
2632
|
-
$
|
|
2633
|
-
$in: z.array(z.string()),
|
|
2634
|
-
$ne: z.string(),
|
|
2635
|
-
$nin: z.array(z.string())
|
|
2625
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.object({
|
|
2626
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
2627
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
2636
2628
|
}).partial().strict().optional(),
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2629
|
+
minutesToRead: /* @__PURE__ */ z.object({
|
|
2630
|
+
$eq: /* @__PURE__ */ z.number(),
|
|
2631
|
+
$gt: /* @__PURE__ */ z.number(),
|
|
2632
|
+
$gte: /* @__PURE__ */ z.number(),
|
|
2633
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.number()),
|
|
2634
|
+
$lt: /* @__PURE__ */ z.number(),
|
|
2635
|
+
$lte: /* @__PURE__ */ z.number(),
|
|
2636
|
+
$ne: /* @__PURE__ */ z.number()
|
|
2637
|
+
}).partial().strict().optional(),
|
|
2638
|
+
language: /* @__PURE__ */ z.object({
|
|
2639
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2640
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2641
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2642
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2643
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2644
|
+
}).partial().strict().optional(),
|
|
2645
|
+
translationId: /* @__PURE__ */ z.object({
|
|
2646
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2647
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2648
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2649
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2650
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
2651
|
+
}).partial().strict().optional(),
|
|
2652
|
+
$and: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2653
|
+
$or: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2654
|
+
$not: /* @__PURE__ */ z.any().optional()
|
|
2640
2655
|
}).strict().optional(),
|
|
2641
|
-
sort: z.array(
|
|
2642
|
-
z.object({
|
|
2643
|
-
fieldName: z.enum([
|
|
2656
|
+
sort: /* @__PURE__ */ z.array(
|
|
2657
|
+
/* @__PURE__ */ z.object({
|
|
2658
|
+
fieldName: /* @__PURE__ */ z.enum([
|
|
2644
2659
|
"_id",
|
|
2645
2660
|
"title",
|
|
2646
2661
|
"excerpt",
|
|
@@ -2651,13 +2666,13 @@ var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2651
2666
|
"commentingEnabled",
|
|
2652
2667
|
"hasUnpublishedChanges"
|
|
2653
2668
|
]).optional(),
|
|
2654
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
2669
|
+
order: /* @__PURE__ */ z.enum(["ASC", "DESC"]).optional()
|
|
2655
2670
|
})
|
|
2656
2671
|
).optional()
|
|
2657
|
-
}).catchall(z.any()).describe("Query options."),
|
|
2658
|
-
options: z.object({
|
|
2659
|
-
fieldsets: z.array(
|
|
2660
|
-
z.enum([
|
|
2672
|
+
}).catchall(/* @__PURE__ */ z.any()).describe("Query options."),
|
|
2673
|
+
options: /* @__PURE__ */ z.object({
|
|
2674
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
2675
|
+
/* @__PURE__ */ z.enum([
|
|
2661
2676
|
"UNKNOWN",
|
|
2662
2677
|
"URL",
|
|
2663
2678
|
"CONTENT",
|
|
@@ -2668,41 +2683,41 @@ var QueryDraftPostsRequest = /* @__PURE__ */ z.object({
|
|
|
2668
2683
|
}).describe("Options for querying draft posts.").optional()
|
|
2669
2684
|
});
|
|
2670
2685
|
var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
2671
|
-
draftPosts: z.array(
|
|
2672
|
-
z.object({
|
|
2673
|
-
_id: z.string().describe("Draft post ID.").max(38).optional(),
|
|
2674
|
-
title: z.string().describe("Draft post title.").max(200).optional(),
|
|
2675
|
-
excerpt: z.string().describe(
|
|
2686
|
+
draftPosts: /* @__PURE__ */ z.array(
|
|
2687
|
+
/* @__PURE__ */ z.object({
|
|
2688
|
+
_id: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38).optional(),
|
|
2689
|
+
title: /* @__PURE__ */ z.string().describe("Draft post title.").max(200).optional(),
|
|
2690
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
2676
2691
|
"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."
|
|
2677
2692
|
).max(500).optional().nullable(),
|
|
2678
|
-
featured: z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2679
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
2680
|
-
memberId: z.string().describe("Draft post owner's member ID.").regex(
|
|
2693
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the draft post is marked as featured.").optional().nullable(),
|
|
2694
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
2695
|
+
memberId: /* @__PURE__ */ z.string().describe("Draft post owner's member ID.").regex(
|
|
2681
2696
|
/^[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}$/,
|
|
2682
2697
|
"Must be a valid GUID"
|
|
2683
2698
|
).optional().nullable(),
|
|
2684
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
2685
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2686
|
-
minutesToRead: z.number().int().describe(
|
|
2699
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2700
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the draft post is enabled.").optional().nullable(),
|
|
2701
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe(
|
|
2687
2702
|
"Estimated reading time of the draft post (calculated automatically)."
|
|
2688
2703
|
).optional(),
|
|
2689
|
-
heroImage: z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2690
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
2691
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
2692
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
2693
|
-
translationId: z.string().describe(
|
|
2704
|
+
heroImage: /* @__PURE__ */ z.string().describe("Image placed at the top of the blog page.").optional(),
|
|
2705
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
2706
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
2707
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
2708
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
2694
2709
|
"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."
|
|
2695
2710
|
).regex(
|
|
2696
2711
|
/^[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}$/,
|
|
2697
2712
|
"Must be a valid GUID"
|
|
2698
2713
|
).optional().nullable(),
|
|
2699
|
-
language: z.string().describe(
|
|
2714
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
2700
2715
|
"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."
|
|
2701
2716
|
).optional().nullable(),
|
|
2702
|
-
richContent: z.any().describe(
|
|
2717
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
2703
2718
|
'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>'
|
|
2704
2719
|
).optional(),
|
|
2705
|
-
status: z.enum([
|
|
2720
|
+
status: /* @__PURE__ */ z.enum([
|
|
2706
2721
|
"UNKNOWN",
|
|
2707
2722
|
"PUBLISHED",
|
|
2708
2723
|
"UNPUBLISHED",
|
|
@@ -2710,132 +2725,132 @@ var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2710
2725
|
"DELETED",
|
|
2711
2726
|
"IN_REVIEW"
|
|
2712
2727
|
]).describe("Status of the draft post.").optional(),
|
|
2713
|
-
moderationDetails: z.object({
|
|
2714
|
-
submittedBy: z.string().describe(
|
|
2728
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
2729
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
2715
2730
|
"Member ID of the person submitting the draft post for review."
|
|
2716
2731
|
).regex(
|
|
2717
2732
|
/^[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}$/,
|
|
2718
2733
|
"Must be a valid GUID"
|
|
2719
2734
|
).optional(),
|
|
2720
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2721
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2735
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
2736
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
2722
2737
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
2723
2738
|
).optional(),
|
|
2724
|
-
moderatedBy: z.string().describe(
|
|
2739
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
2725
2740
|
"Member ID of the person who approved or rejected the post."
|
|
2726
2741
|
).regex(
|
|
2727
2742
|
/^[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}$/,
|
|
2728
2743
|
"Must be a valid GUID"
|
|
2729
2744
|
).optional().nullable(),
|
|
2730
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2745
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
2731
2746
|
}).describe(
|
|
2732
2747
|
"Details of the draft post in review. Only relevant to posts submitted by guest writers."
|
|
2733
2748
|
).optional(),
|
|
2734
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
2749
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
2735
2750
|
"Indicates if there are changes made to the draft post that have not yet been published."
|
|
2736
2751
|
).optional(),
|
|
2737
|
-
editedDate: z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2738
|
-
scheduledPublishDate: z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2739
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2740
|
-
seoData: z.object({
|
|
2741
|
-
tags: z.array(
|
|
2742
|
-
z.object({
|
|
2743
|
-
type: z.string().describe(
|
|
2752
|
+
editedDate: /* @__PURE__ */ z.date().describe("Date the draft post was last edited.").optional().nullable(),
|
|
2753
|
+
scheduledPublishDate: /* @__PURE__ */ z.date().describe("Date the draft post is scheduled to be published.").optional().nullable(),
|
|
2754
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
2755
|
+
seoData: /* @__PURE__ */ z.object({
|
|
2756
|
+
tags: /* @__PURE__ */ z.array(
|
|
2757
|
+
/* @__PURE__ */ z.object({
|
|
2758
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
2744
2759
|
"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`)."
|
|
2745
2760
|
).optional(),
|
|
2746
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2761
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2747
2762
|
'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"}`.'
|
|
2748
2763
|
).optional().nullable(),
|
|
2749
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2764
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2750
2765
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2751
2766
|
).optional().nullable(),
|
|
2752
|
-
children: z.string().describe(
|
|
2767
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
2753
2768
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2754
2769
|
).optional(),
|
|
2755
|
-
custom: z.boolean().describe(
|
|
2770
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2756
2771
|
"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."
|
|
2757
2772
|
).optional(),
|
|
2758
|
-
disabled: z.boolean().describe(
|
|
2773
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
2759
2774
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2760
2775
|
).optional()
|
|
2761
2776
|
})
|
|
2762
2777
|
).optional(),
|
|
2763
|
-
settings: z.object({
|
|
2764
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2778
|
+
settings: /* @__PURE__ */ z.object({
|
|
2779
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
2765
2780
|
"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)."
|
|
2766
2781
|
).optional(),
|
|
2767
|
-
keywords: z.array(
|
|
2768
|
-
z.object({
|
|
2769
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2770
|
-
isMain: z.boolean().describe(
|
|
2782
|
+
keywords: /* @__PURE__ */ z.array(
|
|
2783
|
+
/* @__PURE__ */ z.object({
|
|
2784
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
2785
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
2771
2786
|
"Whether the keyword is the main focus keyword."
|
|
2772
2787
|
).optional(),
|
|
2773
|
-
origin: z.string().describe(
|
|
2788
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
2774
2789
|
"The source that added the keyword terms to the SEO settings."
|
|
2775
2790
|
).max(1e3).optional().nullable()
|
|
2776
2791
|
})
|
|
2777
2792
|
).max(5).optional()
|
|
2778
2793
|
}).describe("SEO general settings.").optional()
|
|
2779
2794
|
}).describe("SEO data.").optional(),
|
|
2780
|
-
url: z.string().describe(
|
|
2795
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2781
2796
|
"Draft post URL preview. What the URL will look like once the post is published."
|
|
2782
2797
|
).optional(),
|
|
2783
|
-
_createdDate: z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2784
|
-
seoSlug: z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2785
|
-
media: z.intersection(
|
|
2786
|
-
z.object({
|
|
2787
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2788
|
-
custom: z.boolean().describe(
|
|
2798
|
+
_createdDate: /* @__PURE__ */ z.date().describe("Date the draft post was first created.").optional().nullable(),
|
|
2799
|
+
seoSlug: /* @__PURE__ */ z.string().describe("SEO slug.").max(100).optional().nullable(),
|
|
2800
|
+
media: /* @__PURE__ */ z.intersection(
|
|
2801
|
+
/* @__PURE__ */ z.object({
|
|
2802
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
2803
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
2789
2804
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
2790
2805
|
).optional(),
|
|
2791
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2806
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
2792
2807
|
}),
|
|
2793
|
-
z.xor([
|
|
2794
|
-
z.object({
|
|
2795
|
-
wixMedia: z.never().optional(),
|
|
2796
|
-
embedMedia: z.never().optional()
|
|
2808
|
+
/* @__PURE__ */ z.xor([
|
|
2809
|
+
/* @__PURE__ */ z.object({
|
|
2810
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2811
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
2797
2812
|
}),
|
|
2798
|
-
z.object({
|
|
2799
|
-
embedMedia: z.never().optional(),
|
|
2800
|
-
wixMedia: z.object({
|
|
2801
|
-
image: z.string().describe("Image details.").optional(),
|
|
2802
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
2813
|
+
/* @__PURE__ */ z.object({
|
|
2814
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
2815
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
2816
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
2817
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
2803
2818
|
}).describe("Wix Media details.")
|
|
2804
2819
|
}),
|
|
2805
|
-
z.object({
|
|
2806
|
-
wixMedia: z.never().optional(),
|
|
2807
|
-
embedMedia: z.object({
|
|
2808
|
-
thumbnail: z.object({
|
|
2809
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2810
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2811
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2820
|
+
/* @__PURE__ */ z.object({
|
|
2821
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
2822
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
2823
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
2824
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
2825
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
2826
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
2812
2827
|
}).describe("Thumbnail details.").optional(),
|
|
2813
|
-
video: z.object({
|
|
2814
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
2815
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
2816
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
2828
|
+
video: /* @__PURE__ */ z.object({
|
|
2829
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
2830
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
2831
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
2817
2832
|
}).describe("Video details.").optional()
|
|
2818
2833
|
}).describe("Embed media details.")
|
|
2819
2834
|
})
|
|
2820
2835
|
])
|
|
2821
2836
|
).describe("Post cover media.").optional(),
|
|
2822
|
-
previewTextParagraph: z.number().int().describe(
|
|
2837
|
+
previewTextParagraph: /* @__PURE__ */ z.number().int().describe(
|
|
2823
2838
|
"Number of paragraphs to display in a paid content preview for non-paying users."
|
|
2824
2839
|
).min(0).optional().nullable()
|
|
2825
2840
|
})
|
|
2826
2841
|
).optional(),
|
|
2827
|
-
pagingMetadata: z.object({
|
|
2828
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2829
|
-
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
2830
|
-
total: z.number().int().describe(
|
|
2842
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
2843
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2844
|
+
offset: /* @__PURE__ */ z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
2845
|
+
total: /* @__PURE__ */ z.number().int().describe(
|
|
2831
2846
|
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
2832
2847
|
).optional().nullable(),
|
|
2833
|
-
tooManyToCount: z.boolean().describe(
|
|
2848
|
+
tooManyToCount: /* @__PURE__ */ z.boolean().describe(
|
|
2834
2849
|
"Flag that indicates the server failed to calculate the `total` field."
|
|
2835
2850
|
).optional().nullable(),
|
|
2836
|
-
cursors: z.object({
|
|
2837
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
2838
|
-
prev: z.string().describe(
|
|
2851
|
+
cursors: /* @__PURE__ */ z.object({
|
|
2852
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
2853
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
2839
2854
|
"Cursor pointing to previous page in the list of results."
|
|
2840
2855
|
).max(2e3).optional().nullable()
|
|
2841
2856
|
}).describe(
|
|
@@ -2844,10 +2859,10 @@ var QueryDraftPostsResponse = /* @__PURE__ */ z.object({
|
|
|
2844
2859
|
}).describe("Details on the paged set of results returned.").optional()
|
|
2845
2860
|
});
|
|
2846
2861
|
var PublishDraftPostRequest = /* @__PURE__ */ z.object({
|
|
2847
|
-
draftPostId: z.string().describe("Draft post ID.").max(38)
|
|
2862
|
+
draftPostId: /* @__PURE__ */ z.string().describe("Draft post ID.").max(38)
|
|
2848
2863
|
});
|
|
2849
2864
|
var PublishDraftPostResponse = /* @__PURE__ */ z.object({
|
|
2850
|
-
postId: z.string().describe("Published post ID.").regex(
|
|
2865
|
+
postId: /* @__PURE__ */ z.string().describe("Published post ID.").regex(
|
|
2851
2866
|
/^[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}$/,
|
|
2852
2867
|
"Must be a valid GUID"
|
|
2853
2868
|
).optional()
|