@wix/auto_sdk_blog_posts 1.0.178 → 1.0.179
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 +450 -438
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/schemas.mjs +450 -438
- package/build/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
- package/build/internal/cjs/index.js +0 -2841
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -2221
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -1975
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/schemas.js +0 -988
- package/build/internal/cjs/schemas.js.map +0 -1
- package/build/internal/es/index.mjs +0 -2734
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -2118
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -1871
- package/build/internal/es/meta.mjs.map +0 -1
- package/build/internal/es/schemas.mjs +0 -938
- package/build/internal/es/schemas.mjs.map +0 -1
package/build/cjs/schemas.js
CHANGED
|
@@ -50,45 +50,45 @@ module.exports = __toCommonJS(schemas_exports);
|
|
|
50
50
|
// src/blog-v3-post-posts.schemas.ts
|
|
51
51
|
var z = __toESM(require("zod"));
|
|
52
52
|
var QueryPostCountStatsRequest = /* @__PURE__ */ z.object({
|
|
53
|
-
options: z.object({
|
|
54
|
-
rangeStart: z.date().describe(
|
|
53
|
+
options: /* @__PURE__ */ z.object({
|
|
54
|
+
rangeStart: /* @__PURE__ */ z.date().describe(
|
|
55
55
|
"Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format."
|
|
56
56
|
).optional().nullable(),
|
|
57
|
-
order: z.enum(["UNKNOWN", "OLDEST", "NEWEST"]).optional(),
|
|
58
|
-
months: z.number().int().describe("Number of months to include in response.").min(0).optional(),
|
|
59
|
-
language: z.string().describe(
|
|
57
|
+
order: /* @__PURE__ */ z.enum(["UNKNOWN", "OLDEST", "NEWEST"]).optional(),
|
|
58
|
+
months: /* @__PURE__ */ z.number().int().describe("Number of months to include in response.").min(0).optional(),
|
|
59
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
60
60
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to only receive the period post count for that specified language."
|
|
61
61
|
).optional().nullable(),
|
|
62
|
-
timeZone: z.string().describe(
|
|
62
|
+
timeZone: /* @__PURE__ */ z.string().describe(
|
|
63
63
|
"Time zone to use when calculating the start of the month.\n\n[UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`."
|
|
64
64
|
).min(3).max(100).optional().nullable()
|
|
65
65
|
}).describe("Options specifying time frame, sort, and filter. ").optional()
|
|
66
66
|
});
|
|
67
67
|
var QueryPostCountStatsResponse = /* @__PURE__ */ z.object({
|
|
68
|
-
stats: z.array(
|
|
69
|
-
z.object({
|
|
70
|
-
periodStart: z.date().describe(
|
|
68
|
+
stats: /* @__PURE__ */ z.array(
|
|
69
|
+
/* @__PURE__ */ z.object({
|
|
70
|
+
periodStart: /* @__PURE__ */ z.date().describe(
|
|
71
71
|
"Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format."
|
|
72
72
|
).optional().nullable(),
|
|
73
|
-
postCount: z.number().int().describe("Number of posts published during this month.").min(0).optional()
|
|
73
|
+
postCount: /* @__PURE__ */ z.number().int().describe("Number of posts published during this month.").min(0).optional()
|
|
74
74
|
})
|
|
75
75
|
).optional()
|
|
76
76
|
});
|
|
77
77
|
var GetTotalPostsRequest = /* @__PURE__ */ z.object({
|
|
78
|
-
options: z.object({
|
|
79
|
-
language: z.string().describe(
|
|
78
|
+
options: /* @__PURE__ */ z.object({
|
|
79
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
80
80
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to receive the total amount of posts in that specified language."
|
|
81
81
|
).optional().nullable()
|
|
82
82
|
}).describe("Language Options.").optional()
|
|
83
83
|
});
|
|
84
84
|
var GetTotalPostsResponse = /* @__PURE__ */ z.object({
|
|
85
|
-
total: z.number().int().describe("Total amount of published posts.").min(0).optional()
|
|
85
|
+
total: /* @__PURE__ */ z.number().int().describe("Total amount of published posts.").min(0).optional()
|
|
86
86
|
});
|
|
87
87
|
var GetPostRequest = /* @__PURE__ */ z.object({
|
|
88
|
-
postId: z.string().describe("Post ID.").min(1).max(38),
|
|
89
|
-
options: z.object({
|
|
90
|
-
fieldsets: z.array(
|
|
91
|
-
z.enum([
|
|
88
|
+
postId: /* @__PURE__ */ z.string().describe("Post ID.").min(1).max(38),
|
|
89
|
+
options: /* @__PURE__ */ z.object({
|
|
90
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
91
|
+
/* @__PURE__ */ z.enum([
|
|
92
92
|
"UNKNOWN",
|
|
93
93
|
"URL",
|
|
94
94
|
"CONTENT_TEXT",
|
|
@@ -102,170 +102,170 @@ var GetPostRequest = /* @__PURE__ */ z.object({
|
|
|
102
102
|
}).describe("Options specifying which fields to return.").optional()
|
|
103
103
|
});
|
|
104
104
|
var GetPostResponse = /* @__PURE__ */ z.object({
|
|
105
|
-
post: z.object({
|
|
106
|
-
_id: z.string().describe("Post ID.").regex(
|
|
105
|
+
post: /* @__PURE__ */ z.object({
|
|
106
|
+
_id: /* @__PURE__ */ z.string().describe("Post ID.").regex(
|
|
107
107
|
/^[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}$/,
|
|
108
108
|
"Must be a valid GUID"
|
|
109
109
|
).optional(),
|
|
110
|
-
title: z.string().describe("Post title.").max(200).optional(),
|
|
111
|
-
excerpt: z.string().describe(
|
|
110
|
+
title: /* @__PURE__ */ z.string().describe("Post title.").max(200).optional(),
|
|
111
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
112
112
|
"Post excerpt.\nCan be selected by a site contributor. By default, it is extracted from the content text's first characters.\n\nMax: 500 characters"
|
|
113
113
|
).max(500).optional(),
|
|
114
|
-
contentText: z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
115
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
116
|
-
lastPublishedDate: z.date().describe("Date the post was last published.").optional().nullable(),
|
|
117
|
-
url: z.string().describe("Post URL.").optional(),
|
|
118
|
-
slug: z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
119
|
-
featured: z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
120
|
-
pinned: z.boolean().describe(
|
|
114
|
+
contentText: /* @__PURE__ */ z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
115
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
116
|
+
lastPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was last published.").optional().nullable(),
|
|
117
|
+
url: /* @__PURE__ */ z.string().describe("Post URL.").optional(),
|
|
118
|
+
slug: /* @__PURE__ */ z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
119
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
120
|
+
pinned: /* @__PURE__ */ z.boolean().describe(
|
|
121
121
|
"Whether the post is pinned. If `true`, the post is placed at the top of the post list."
|
|
122
122
|
).optional(),
|
|
123
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
124
|
-
memberId: z.string().describe("Member ID of the post's owner.").regex(
|
|
123
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
124
|
+
memberId: /* @__PURE__ */ z.string().describe("Member ID of the post's owner.").regex(
|
|
125
125
|
/^[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}$/,
|
|
126
126
|
"Must be a valid GUID"
|
|
127
127
|
).optional(),
|
|
128
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
129
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
130
|
-
minutesToRead: z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
131
|
-
heroImage: z.string().describe(
|
|
128
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
129
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
130
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
131
|
+
heroImage: /* @__PURE__ */ z.string().describe(
|
|
132
132
|
"Image placed at the top of the blog page. Only displays on mobile devices."
|
|
133
133
|
).optional(),
|
|
134
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
135
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
136
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
137
|
-
translationId: z.string().describe(
|
|
134
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
135
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
136
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
137
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
138
138
|
"ID of the translations of this post. All translations of a single post share the same `translationId`."
|
|
139
139
|
).regex(
|
|
140
140
|
/^[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}$/,
|
|
141
141
|
"Must be a valid GUID"
|
|
142
142
|
).optional().nullable(),
|
|
143
|
-
language: z.string().describe(
|
|
143
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
144
144
|
"Language the 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."
|
|
145
145
|
).optional().nullable(),
|
|
146
|
-
seoData: z.object({
|
|
147
|
-
tags: z.array(
|
|
148
|
-
z.object({
|
|
149
|
-
type: z.string().describe(
|
|
146
|
+
seoData: /* @__PURE__ */ z.object({
|
|
147
|
+
tags: /* @__PURE__ */ z.array(
|
|
148
|
+
/* @__PURE__ */ z.object({
|
|
149
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
150
150
|
"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`)."
|
|
151
151
|
).optional(),
|
|
152
|
-
props: z.record(z.string(), z.any()).describe(
|
|
152
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
153
153
|
'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"}`.'
|
|
154
154
|
).optional().nullable(),
|
|
155
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
155
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
156
156
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
157
157
|
).optional().nullable(),
|
|
158
|
-
children: z.string().describe(
|
|
158
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
159
159
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
160
160
|
).optional(),
|
|
161
|
-
custom: z.boolean().describe(
|
|
161
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
162
162
|
"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."
|
|
163
163
|
).optional(),
|
|
164
|
-
disabled: z.boolean().describe(
|
|
164
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
165
165
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
166
166
|
).optional()
|
|
167
167
|
})
|
|
168
168
|
).optional(),
|
|
169
|
-
settings: z.object({
|
|
170
|
-
preventAutoRedirect: z.boolean().describe(
|
|
169
|
+
settings: /* @__PURE__ */ z.object({
|
|
170
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
171
171
|
"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)."
|
|
172
172
|
).optional(),
|
|
173
|
-
keywords: z.array(
|
|
174
|
-
z.object({
|
|
175
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
176
|
-
isMain: z.boolean().describe(
|
|
173
|
+
keywords: /* @__PURE__ */ z.array(
|
|
174
|
+
/* @__PURE__ */ z.object({
|
|
175
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
176
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
177
177
|
"Whether the keyword is the main focus keyword."
|
|
178
178
|
).optional(),
|
|
179
|
-
origin: z.string().describe(
|
|
179
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
180
180
|
"The source that added the keyword terms to the SEO settings."
|
|
181
181
|
).max(1e3).optional().nullable()
|
|
182
182
|
})
|
|
183
183
|
).max(5).optional()
|
|
184
184
|
}).describe("SEO general settings.").optional()
|
|
185
185
|
}).describe("SEO data.").optional(),
|
|
186
|
-
contactId: z.string().describe(
|
|
186
|
+
contactId: /* @__PURE__ */ z.string().describe(
|
|
187
187
|
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
188
188
|
).regex(
|
|
189
189
|
/^[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}$/,
|
|
190
190
|
"Must be a valid GUID"
|
|
191
191
|
).optional().nullable(),
|
|
192
|
-
richContent: z.any().describe(
|
|
192
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
193
193
|
'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>'
|
|
194
194
|
).optional(),
|
|
195
|
-
preview: z.boolean().describe(
|
|
195
|
+
preview: /* @__PURE__ */ z.boolean().describe(
|
|
196
196
|
"Whether the returned content is a preview of premium content. Defaults to `false`.\nA preview displays a limited number of paragraphs of paid content to non-subscribed users."
|
|
197
197
|
).optional(),
|
|
198
|
-
moderationDetails: z.object({
|
|
199
|
-
submittedBy: z.string().describe(
|
|
198
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
199
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
200
200
|
"Member ID of the person submitting the draft post for review."
|
|
201
201
|
).regex(
|
|
202
202
|
/^[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}$/,
|
|
203
203
|
"Must be a valid GUID"
|
|
204
204
|
).optional(),
|
|
205
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
206
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
205
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
206
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
207
207
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
208
208
|
).optional(),
|
|
209
|
-
moderatedBy: z.string().describe(
|
|
209
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
210
210
|
"Member ID of the person who approved or rejected the post."
|
|
211
211
|
).regex(
|
|
212
212
|
/^[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}$/,
|
|
213
213
|
"Must be a valid GUID"
|
|
214
214
|
).optional().nullable(),
|
|
215
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
215
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
216
216
|
}).describe(
|
|
217
217
|
"Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).\n\nGuest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user."
|
|
218
218
|
).optional(),
|
|
219
|
-
media: z.intersection(
|
|
220
|
-
z.object({
|
|
221
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
222
|
-
custom: z.boolean().describe(
|
|
219
|
+
media: /* @__PURE__ */ z.intersection(
|
|
220
|
+
/* @__PURE__ */ z.object({
|
|
221
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
222
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
223
223
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
224
224
|
).optional(),
|
|
225
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
225
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
226
226
|
}),
|
|
227
|
-
z.xor([
|
|
228
|
-
z.object({
|
|
229
|
-
wixMedia: z.never().optional(),
|
|
230
|
-
embedMedia: z.never().optional()
|
|
227
|
+
/* @__PURE__ */ z.xor([
|
|
228
|
+
/* @__PURE__ */ z.object({
|
|
229
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
230
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
231
231
|
}),
|
|
232
|
-
z.object({
|
|
233
|
-
embedMedia: z.never().optional(),
|
|
234
|
-
wixMedia: z.object({
|
|
235
|
-
image: z.string().describe("Image details.").optional(),
|
|
236
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
232
|
+
/* @__PURE__ */ z.object({
|
|
233
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
234
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
235
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
236
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
237
237
|
}).describe("Wix Media details.")
|
|
238
238
|
}),
|
|
239
|
-
z.object({
|
|
240
|
-
wixMedia: z.never().optional(),
|
|
241
|
-
embedMedia: z.object({
|
|
242
|
-
thumbnail: z.object({
|
|
243
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
244
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
245
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
239
|
+
/* @__PURE__ */ z.object({
|
|
240
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
241
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
242
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
243
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
244
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
245
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
246
246
|
}).describe("Thumbnail details.").optional(),
|
|
247
|
-
video: z.object({
|
|
248
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
249
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
250
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
247
|
+
video: /* @__PURE__ */ z.object({
|
|
248
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
249
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
250
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
251
251
|
}).describe("Video details.").optional()
|
|
252
252
|
}).describe("Embed media details.")
|
|
253
253
|
})
|
|
254
254
|
])
|
|
255
255
|
).describe("Post cover media.").optional(),
|
|
256
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
256
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
257
257
|
"Indicates if there is a draft post with changes that have not yet been published."
|
|
258
258
|
).optional(),
|
|
259
|
-
referenceId: z.string().describe(
|
|
259
|
+
referenceId: /* @__PURE__ */ z.string().describe(
|
|
260
260
|
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
261
261
|
).max(24).optional().nullable()
|
|
262
262
|
}).describe("Retrieved post info.").optional()
|
|
263
263
|
});
|
|
264
264
|
var GetPostBySlugRequest = /* @__PURE__ */ z.object({
|
|
265
|
-
slug: z.string().describe("Slug of the post to retrieve.").min(1).max(200),
|
|
266
|
-
options: z.object({
|
|
267
|
-
fieldsets: z.array(
|
|
268
|
-
z.enum([
|
|
265
|
+
slug: /* @__PURE__ */ z.string().describe("Slug of the post to retrieve.").min(1).max(200),
|
|
266
|
+
options: /* @__PURE__ */ z.object({
|
|
267
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
268
|
+
/* @__PURE__ */ z.enum([
|
|
269
269
|
"UNKNOWN",
|
|
270
270
|
"URL",
|
|
271
271
|
"CONTENT_TEXT",
|
|
@@ -276,176 +276,176 @@ var GetPostBySlugRequest = /* @__PURE__ */ z.object({
|
|
|
276
276
|
"REFERENCE_ID"
|
|
277
277
|
])
|
|
278
278
|
).max(20).optional(),
|
|
279
|
-
language: z.string().describe("Language of the post.").optional().nullable()
|
|
279
|
+
language: /* @__PURE__ */ z.string().describe("Language of the post.").optional().nullable()
|
|
280
280
|
}).describe("Options specifying which fields to return.").optional()
|
|
281
281
|
});
|
|
282
282
|
var GetPostBySlugResponse = /* @__PURE__ */ z.object({
|
|
283
|
-
post: z.object({
|
|
284
|
-
_id: z.string().describe("Post ID.").regex(
|
|
283
|
+
post: /* @__PURE__ */ z.object({
|
|
284
|
+
_id: /* @__PURE__ */ z.string().describe("Post ID.").regex(
|
|
285
285
|
/^[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}$/,
|
|
286
286
|
"Must be a valid GUID"
|
|
287
287
|
).optional(),
|
|
288
|
-
title: z.string().describe("Post title.").max(200).optional(),
|
|
289
|
-
excerpt: z.string().describe(
|
|
288
|
+
title: /* @__PURE__ */ z.string().describe("Post title.").max(200).optional(),
|
|
289
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
290
290
|
"Post excerpt.\nCan be selected by a site contributor. By default, it is extracted from the content text's first characters.\n\nMax: 500 characters"
|
|
291
291
|
).max(500).optional(),
|
|
292
|
-
contentText: z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
293
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
294
|
-
lastPublishedDate: z.date().describe("Date the post was last published.").optional().nullable(),
|
|
295
|
-
url: z.string().describe("Post URL.").optional(),
|
|
296
|
-
slug: z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
297
|
-
featured: z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
298
|
-
pinned: z.boolean().describe(
|
|
292
|
+
contentText: /* @__PURE__ */ z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
293
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
294
|
+
lastPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was last published.").optional().nullable(),
|
|
295
|
+
url: /* @__PURE__ */ z.string().describe("Post URL.").optional(),
|
|
296
|
+
slug: /* @__PURE__ */ z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
297
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
298
|
+
pinned: /* @__PURE__ */ z.boolean().describe(
|
|
299
299
|
"Whether the post is pinned. If `true`, the post is placed at the top of the post list."
|
|
300
300
|
).optional(),
|
|
301
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
302
|
-
memberId: z.string().describe("Member ID of the post's owner.").regex(
|
|
301
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
302
|
+
memberId: /* @__PURE__ */ z.string().describe("Member ID of the post's owner.").regex(
|
|
303
303
|
/^[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}$/,
|
|
304
304
|
"Must be a valid GUID"
|
|
305
305
|
).optional(),
|
|
306
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
307
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
308
|
-
minutesToRead: z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
309
|
-
heroImage: z.string().describe(
|
|
306
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
307
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
308
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
309
|
+
heroImage: /* @__PURE__ */ z.string().describe(
|
|
310
310
|
"Image placed at the top of the blog page. Only displays on mobile devices."
|
|
311
311
|
).optional(),
|
|
312
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
313
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
314
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
315
|
-
translationId: z.string().describe(
|
|
312
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
313
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
314
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
315
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
316
316
|
"ID of the translations of this post. All translations of a single post share the same `translationId`."
|
|
317
317
|
).regex(
|
|
318
318
|
/^[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}$/,
|
|
319
319
|
"Must be a valid GUID"
|
|
320
320
|
).optional().nullable(),
|
|
321
|
-
language: z.string().describe(
|
|
321
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
322
322
|
"Language the 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."
|
|
323
323
|
).optional().nullable(),
|
|
324
|
-
seoData: z.object({
|
|
325
|
-
tags: z.array(
|
|
326
|
-
z.object({
|
|
327
|
-
type: z.string().describe(
|
|
324
|
+
seoData: /* @__PURE__ */ z.object({
|
|
325
|
+
tags: /* @__PURE__ */ z.array(
|
|
326
|
+
/* @__PURE__ */ z.object({
|
|
327
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
328
328
|
"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`)."
|
|
329
329
|
).optional(),
|
|
330
|
-
props: z.record(z.string(), z.any()).describe(
|
|
330
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
331
331
|
'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"}`.'
|
|
332
332
|
).optional().nullable(),
|
|
333
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
333
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
334
334
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
335
335
|
).optional().nullable(),
|
|
336
|
-
children: z.string().describe(
|
|
336
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
337
337
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
338
338
|
).optional(),
|
|
339
|
-
custom: z.boolean().describe(
|
|
339
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
340
340
|
"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."
|
|
341
341
|
).optional(),
|
|
342
|
-
disabled: z.boolean().describe(
|
|
342
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
343
343
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
344
344
|
).optional()
|
|
345
345
|
})
|
|
346
346
|
).optional(),
|
|
347
|
-
settings: z.object({
|
|
348
|
-
preventAutoRedirect: z.boolean().describe(
|
|
347
|
+
settings: /* @__PURE__ */ z.object({
|
|
348
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
349
349
|
"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)."
|
|
350
350
|
).optional(),
|
|
351
|
-
keywords: z.array(
|
|
352
|
-
z.object({
|
|
353
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
354
|
-
isMain: z.boolean().describe(
|
|
351
|
+
keywords: /* @__PURE__ */ z.array(
|
|
352
|
+
/* @__PURE__ */ z.object({
|
|
353
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
354
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
355
355
|
"Whether the keyword is the main focus keyword."
|
|
356
356
|
).optional(),
|
|
357
|
-
origin: z.string().describe(
|
|
357
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
358
358
|
"The source that added the keyword terms to the SEO settings."
|
|
359
359
|
).max(1e3).optional().nullable()
|
|
360
360
|
})
|
|
361
361
|
).max(5).optional()
|
|
362
362
|
}).describe("SEO general settings.").optional()
|
|
363
363
|
}).describe("SEO data.").optional(),
|
|
364
|
-
contactId: z.string().describe(
|
|
364
|
+
contactId: /* @__PURE__ */ z.string().describe(
|
|
365
365
|
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
366
366
|
).regex(
|
|
367
367
|
/^[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}$/,
|
|
368
368
|
"Must be a valid GUID"
|
|
369
369
|
).optional().nullable(),
|
|
370
|
-
richContent: z.any().describe(
|
|
370
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
371
371
|
'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>'
|
|
372
372
|
).optional(),
|
|
373
|
-
preview: z.boolean().describe(
|
|
373
|
+
preview: /* @__PURE__ */ z.boolean().describe(
|
|
374
374
|
"Whether the returned content is a preview of premium content. Defaults to `false`.\nA preview displays a limited number of paragraphs of paid content to non-subscribed users."
|
|
375
375
|
).optional(),
|
|
376
|
-
moderationDetails: z.object({
|
|
377
|
-
submittedBy: z.string().describe(
|
|
376
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
377
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
378
378
|
"Member ID of the person submitting the draft post for review."
|
|
379
379
|
).regex(
|
|
380
380
|
/^[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}$/,
|
|
381
381
|
"Must be a valid GUID"
|
|
382
382
|
).optional(),
|
|
383
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
384
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
383
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
384
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
385
385
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
386
386
|
).optional(),
|
|
387
|
-
moderatedBy: z.string().describe(
|
|
387
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
388
388
|
"Member ID of the person who approved or rejected the post."
|
|
389
389
|
).regex(
|
|
390
390
|
/^[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}$/,
|
|
391
391
|
"Must be a valid GUID"
|
|
392
392
|
).optional().nullable(),
|
|
393
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
393
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
394
394
|
}).describe(
|
|
395
395
|
"Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).\n\nGuest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user."
|
|
396
396
|
).optional(),
|
|
397
|
-
media: z.intersection(
|
|
398
|
-
z.object({
|
|
399
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
400
|
-
custom: z.boolean().describe(
|
|
397
|
+
media: /* @__PURE__ */ z.intersection(
|
|
398
|
+
/* @__PURE__ */ z.object({
|
|
399
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
400
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
401
401
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
402
402
|
).optional(),
|
|
403
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
403
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
404
404
|
}),
|
|
405
|
-
z.xor([
|
|
406
|
-
z.object({
|
|
407
|
-
wixMedia: z.never().optional(),
|
|
408
|
-
embedMedia: z.never().optional()
|
|
405
|
+
/* @__PURE__ */ z.xor([
|
|
406
|
+
/* @__PURE__ */ z.object({
|
|
407
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
408
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
409
409
|
}),
|
|
410
|
-
z.object({
|
|
411
|
-
embedMedia: z.never().optional(),
|
|
412
|
-
wixMedia: z.object({
|
|
413
|
-
image: z.string().describe("Image details.").optional(),
|
|
414
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
410
|
+
/* @__PURE__ */ z.object({
|
|
411
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
412
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
413
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
414
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
415
415
|
}).describe("Wix Media details.")
|
|
416
416
|
}),
|
|
417
|
-
z.object({
|
|
418
|
-
wixMedia: z.never().optional(),
|
|
419
|
-
embedMedia: z.object({
|
|
420
|
-
thumbnail: z.object({
|
|
421
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
422
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
423
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
417
|
+
/* @__PURE__ */ z.object({
|
|
418
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
419
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
420
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
421
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
422
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
423
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
424
424
|
}).describe("Thumbnail details.").optional(),
|
|
425
|
-
video: z.object({
|
|
426
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
427
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
428
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
425
|
+
video: /* @__PURE__ */ z.object({
|
|
426
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
427
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
428
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
429
429
|
}).describe("Video details.").optional()
|
|
430
430
|
}).describe("Embed media details.")
|
|
431
431
|
})
|
|
432
432
|
])
|
|
433
433
|
).describe("Post cover media.").optional(),
|
|
434
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
434
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
435
435
|
"Indicates if there is a draft post with changes that have not yet been published."
|
|
436
436
|
).optional(),
|
|
437
|
-
referenceId: z.string().describe(
|
|
437
|
+
referenceId: /* @__PURE__ */ z.string().describe(
|
|
438
438
|
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
439
439
|
).max(24).optional().nullable()
|
|
440
440
|
}).describe("Retrieved post info.").optional()
|
|
441
441
|
});
|
|
442
442
|
var ListPostsRequest = /* @__PURE__ */ z.object({
|
|
443
|
-
options: z.object({
|
|
444
|
-
featured: z.boolean().describe("Whether to return only featured posts.\n\nDefault: `false`").optional(),
|
|
445
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
446
|
-
categoryIds: z.array(z.string()).max(50).optional(),
|
|
447
|
-
tagIds: z.array(z.string()).max(50).optional(),
|
|
448
|
-
sort: z.enum([
|
|
443
|
+
options: /* @__PURE__ */ z.object({
|
|
444
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether to return only featured posts.\n\nDefault: `false`").optional(),
|
|
445
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
446
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(50).optional(),
|
|
447
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(50).optional(),
|
|
448
|
+
sort: /* @__PURE__ */ z.enum([
|
|
449
449
|
"FEED",
|
|
450
450
|
"PUBLISHED_DATE_ASC",
|
|
451
451
|
"PUBLISHED_DATE_DESC",
|
|
@@ -454,24 +454,24 @@ var ListPostsRequest = /* @__PURE__ */ z.object({
|
|
|
454
454
|
"TITLE_ASC",
|
|
455
455
|
"TITLE_DESC"
|
|
456
456
|
]).optional(),
|
|
457
|
-
paging: z.object({
|
|
458
|
-
offset: z.number().int().describe(
|
|
457
|
+
paging: /* @__PURE__ */ z.object({
|
|
458
|
+
offset: /* @__PURE__ */ z.number().int().describe(
|
|
459
459
|
"Number of items to skip in the current sort order.\n\n\nDefault: `0`"
|
|
460
460
|
).min(0).optional(),
|
|
461
|
-
limit: z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
462
|
-
cursor: z.string().describe(
|
|
461
|
+
limit: /* @__PURE__ */ z.number().int().describe("Number of items to return.\n\n\nDefault:`50`").min(1).max(100).optional(),
|
|
462
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
463
463
|
"Pointer to the next or previous page in the list of results."
|
|
464
464
|
).max(2e3).optional().nullable()
|
|
465
465
|
}).describe("Pagination options.").optional(),
|
|
466
|
-
language: z.string().describe(
|
|
466
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
467
467
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to only receive posts that are in that language.\nIf omitted, posts in all languages are returned."
|
|
468
468
|
).optional().nullable(),
|
|
469
|
-
memberId: z.string().describe("Post owner's member ID.").regex(
|
|
469
|
+
memberId: /* @__PURE__ */ z.string().describe("Post owner's member ID.").regex(
|
|
470
470
|
/^[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}$/,
|
|
471
471
|
"Must be a valid GUID"
|
|
472
472
|
).optional().nullable(),
|
|
473
|
-
fieldsets: z.array(
|
|
474
|
-
z.enum([
|
|
473
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
474
|
+
/* @__PURE__ */ z.enum([
|
|
475
475
|
"UNKNOWN",
|
|
476
476
|
"URL",
|
|
477
477
|
"CONTENT_TEXT",
|
|
@@ -485,269 +485,281 @@ var ListPostsRequest = /* @__PURE__ */ z.object({
|
|
|
485
485
|
}).describe("Sort, filter, and paging options.").optional()
|
|
486
486
|
});
|
|
487
487
|
var ListPostsResponse = /* @__PURE__ */ z.object({
|
|
488
|
-
posts: z.array(
|
|
489
|
-
z.object({
|
|
490
|
-
_id: z.string().describe("Post ID.").regex(
|
|
488
|
+
posts: /* @__PURE__ */ z.array(
|
|
489
|
+
/* @__PURE__ */ z.object({
|
|
490
|
+
_id: /* @__PURE__ */ z.string().describe("Post ID.").regex(
|
|
491
491
|
/^[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}$/,
|
|
492
492
|
"Must be a valid GUID"
|
|
493
493
|
).optional(),
|
|
494
|
-
title: z.string().describe("Post title.").max(200).optional(),
|
|
495
|
-
excerpt: z.string().describe(
|
|
494
|
+
title: /* @__PURE__ */ z.string().describe("Post title.").max(200).optional(),
|
|
495
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
496
496
|
"Post excerpt.\nCan be selected by a site contributor. By default, it is extracted from the content text's first characters.\n\nMax: 500 characters"
|
|
497
497
|
).max(500).optional(),
|
|
498
|
-
contentText: z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
499
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
500
|
-
lastPublishedDate: z.date().describe("Date the post was last published.").optional().nullable(),
|
|
501
|
-
url: z.string().describe("Post URL.").optional(),
|
|
502
|
-
slug: z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
503
|
-
featured: z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
504
|
-
pinned: z.boolean().describe(
|
|
498
|
+
contentText: /* @__PURE__ */ z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
499
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
500
|
+
lastPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was last published.").optional().nullable(),
|
|
501
|
+
url: /* @__PURE__ */ z.string().describe("Post URL.").optional(),
|
|
502
|
+
slug: /* @__PURE__ */ z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
503
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
504
|
+
pinned: /* @__PURE__ */ z.boolean().describe(
|
|
505
505
|
"Whether the post is pinned. If `true`, the post is placed at the top of the post list."
|
|
506
506
|
).optional(),
|
|
507
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
508
|
-
memberId: z.string().describe("Member ID of the post's owner.").regex(
|
|
507
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
508
|
+
memberId: /* @__PURE__ */ z.string().describe("Member ID of the post's owner.").regex(
|
|
509
509
|
/^[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}$/,
|
|
510
510
|
"Must be a valid GUID"
|
|
511
511
|
).optional(),
|
|
512
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
513
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
514
|
-
minutesToRead: z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
515
|
-
heroImage: z.string().describe(
|
|
512
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
513
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
514
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
515
|
+
heroImage: /* @__PURE__ */ z.string().describe(
|
|
516
516
|
"Image placed at the top of the blog page. Only displays on mobile devices."
|
|
517
517
|
).optional(),
|
|
518
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
519
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
520
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
521
|
-
translationId: z.string().describe(
|
|
518
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
519
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
520
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
521
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
522
522
|
"ID of the translations of this post. All translations of a single post share the same `translationId`."
|
|
523
523
|
).regex(
|
|
524
524
|
/^[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}$/,
|
|
525
525
|
"Must be a valid GUID"
|
|
526
526
|
).optional().nullable(),
|
|
527
|
-
language: z.string().describe(
|
|
527
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
528
528
|
"Language the 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."
|
|
529
529
|
).optional().nullable(),
|
|
530
|
-
seoData: z.object({
|
|
531
|
-
tags: z.array(
|
|
532
|
-
z.object({
|
|
533
|
-
type: z.string().describe(
|
|
530
|
+
seoData: /* @__PURE__ */ z.object({
|
|
531
|
+
tags: /* @__PURE__ */ z.array(
|
|
532
|
+
/* @__PURE__ */ z.object({
|
|
533
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
534
534
|
"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`)."
|
|
535
535
|
).optional(),
|
|
536
|
-
props: z.record(z.string(), z.any()).describe(
|
|
536
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
537
537
|
'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"}`.'
|
|
538
538
|
).optional().nullable(),
|
|
539
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
539
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
540
540
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
541
541
|
).optional().nullable(),
|
|
542
|
-
children: z.string().describe(
|
|
542
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
543
543
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
544
544
|
).optional(),
|
|
545
|
-
custom: z.boolean().describe(
|
|
545
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
546
546
|
"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."
|
|
547
547
|
).optional(),
|
|
548
|
-
disabled: z.boolean().describe(
|
|
548
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
549
549
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
550
550
|
).optional()
|
|
551
551
|
})
|
|
552
552
|
).optional(),
|
|
553
|
-
settings: z.object({
|
|
554
|
-
preventAutoRedirect: z.boolean().describe(
|
|
553
|
+
settings: /* @__PURE__ */ z.object({
|
|
554
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
555
555
|
"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)."
|
|
556
556
|
).optional(),
|
|
557
|
-
keywords: z.array(
|
|
558
|
-
z.object({
|
|
559
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
560
|
-
isMain: z.boolean().describe(
|
|
557
|
+
keywords: /* @__PURE__ */ z.array(
|
|
558
|
+
/* @__PURE__ */ z.object({
|
|
559
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
560
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
561
561
|
"Whether the keyword is the main focus keyword."
|
|
562
562
|
).optional(),
|
|
563
|
-
origin: z.string().describe(
|
|
563
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
564
564
|
"The source that added the keyword terms to the SEO settings."
|
|
565
565
|
).max(1e3).optional().nullable()
|
|
566
566
|
})
|
|
567
567
|
).max(5).optional()
|
|
568
568
|
}).describe("SEO general settings.").optional()
|
|
569
569
|
}).describe("SEO data.").optional(),
|
|
570
|
-
contactId: z.string().describe(
|
|
570
|
+
contactId: /* @__PURE__ */ z.string().describe(
|
|
571
571
|
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
572
572
|
).regex(
|
|
573
573
|
/^[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}$/,
|
|
574
574
|
"Must be a valid GUID"
|
|
575
575
|
).optional().nullable(),
|
|
576
|
-
richContent: z.any().describe(
|
|
576
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
577
577
|
'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>'
|
|
578
578
|
).optional(),
|
|
579
|
-
preview: z.boolean().describe(
|
|
579
|
+
preview: /* @__PURE__ */ z.boolean().describe(
|
|
580
580
|
"Whether the returned content is a preview of premium content. Defaults to `false`.\nA preview displays a limited number of paragraphs of paid content to non-subscribed users."
|
|
581
581
|
).optional(),
|
|
582
|
-
moderationDetails: z.object({
|
|
583
|
-
submittedBy: z.string().describe(
|
|
582
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
583
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
584
584
|
"Member ID of the person submitting the draft post for review."
|
|
585
585
|
).regex(
|
|
586
586
|
/^[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}$/,
|
|
587
587
|
"Must be a valid GUID"
|
|
588
588
|
).optional(),
|
|
589
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
590
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
589
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
590
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
591
591
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
592
592
|
).optional(),
|
|
593
|
-
moderatedBy: z.string().describe(
|
|
593
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
594
594
|
"Member ID of the person who approved or rejected the post."
|
|
595
595
|
).regex(
|
|
596
596
|
/^[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}$/,
|
|
597
597
|
"Must be a valid GUID"
|
|
598
598
|
).optional().nullable(),
|
|
599
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
599
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
600
600
|
}).describe(
|
|
601
601
|
"Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).\n\nGuest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user."
|
|
602
602
|
).optional(),
|
|
603
|
-
media: z.intersection(
|
|
604
|
-
z.object({
|
|
605
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
606
|
-
custom: z.boolean().describe(
|
|
603
|
+
media: /* @__PURE__ */ z.intersection(
|
|
604
|
+
/* @__PURE__ */ z.object({
|
|
605
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
606
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
607
607
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
608
608
|
).optional(),
|
|
609
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
609
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
610
610
|
}),
|
|
611
|
-
z.xor([
|
|
612
|
-
z.object({
|
|
613
|
-
wixMedia: z.never().optional(),
|
|
614
|
-
embedMedia: z.never().optional()
|
|
611
|
+
/* @__PURE__ */ z.xor([
|
|
612
|
+
/* @__PURE__ */ z.object({
|
|
613
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
614
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
615
615
|
}),
|
|
616
|
-
z.object({
|
|
617
|
-
embedMedia: z.never().optional(),
|
|
618
|
-
wixMedia: z.object({
|
|
619
|
-
image: z.string().describe("Image details.").optional(),
|
|
620
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
616
|
+
/* @__PURE__ */ z.object({
|
|
617
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
618
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
619
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
620
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
621
621
|
}).describe("Wix Media details.")
|
|
622
622
|
}),
|
|
623
|
-
z.object({
|
|
624
|
-
wixMedia: z.never().optional(),
|
|
625
|
-
embedMedia: z.object({
|
|
626
|
-
thumbnail: z.object({
|
|
627
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
628
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
629
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
623
|
+
/* @__PURE__ */ z.object({
|
|
624
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
625
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
626
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
627
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
628
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
629
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
630
630
|
}).describe("Thumbnail details.").optional(),
|
|
631
|
-
video: z.object({
|
|
632
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
633
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
634
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
631
|
+
video: /* @__PURE__ */ z.object({
|
|
632
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
633
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
634
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
635
635
|
}).describe("Video details.").optional()
|
|
636
636
|
}).describe("Embed media details.")
|
|
637
637
|
})
|
|
638
638
|
])
|
|
639
639
|
).describe("Post cover media.").optional(),
|
|
640
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
640
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
641
641
|
"Indicates if there is a draft post with changes that have not yet been published."
|
|
642
642
|
).optional(),
|
|
643
|
-
referenceId: z.string().describe(
|
|
643
|
+
referenceId: /* @__PURE__ */ z.string().describe(
|
|
644
644
|
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
645
645
|
).max(24).optional().nullable()
|
|
646
646
|
})
|
|
647
647
|
).optional(),
|
|
648
|
-
metaData: z.object({
|
|
649
|
-
count: z.number().int().describe("Number of items returned in this response.").optional(),
|
|
650
|
-
offset: z.number().int().describe("Requested offset.").optional(),
|
|
651
|
-
total: z.number().int().describe("Total number of items that match the query.").optional(),
|
|
652
|
-
cursor: z.string().describe(
|
|
648
|
+
metaData: /* @__PURE__ */ z.object({
|
|
649
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in this response.").optional(),
|
|
650
|
+
offset: /* @__PURE__ */ z.number().int().describe("Requested offset.").optional(),
|
|
651
|
+
total: /* @__PURE__ */ z.number().int().describe("Total number of items that match the query.").optional(),
|
|
652
|
+
cursor: /* @__PURE__ */ z.string().describe(
|
|
653
653
|
"Pointer to the next or previous page in the list of results."
|
|
654
654
|
).max(2e3).optional().nullable()
|
|
655
655
|
}).describe("Details on the paged set of results returned.").optional()
|
|
656
656
|
});
|
|
657
657
|
var QueryPostsRequest = /* @__PURE__ */ z.object({
|
|
658
|
-
query: z.object({
|
|
659
|
-
filter: z.object({
|
|
660
|
-
title: z.object({
|
|
661
|
-
$eq: z.string(),
|
|
662
|
-
$exists: z.boolean(),
|
|
663
|
-
$gt: z.string(),
|
|
664
|
-
$gte: z.string(),
|
|
665
|
-
$hasSome: z.array(z.string()),
|
|
666
|
-
$in: z.array(z.string()),
|
|
667
|
-
$lt: z.string(),
|
|
668
|
-
$lte: z.string(),
|
|
669
|
-
$ne: z.string(),
|
|
670
|
-
$startsWith: z.string()
|
|
658
|
+
query: /* @__PURE__ */ z.object({
|
|
659
|
+
filter: /* @__PURE__ */ z.object({
|
|
660
|
+
title: /* @__PURE__ */ z.object({
|
|
661
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
662
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
663
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
664
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
665
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
666
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
667
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
668
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
669
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
670
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
671
671
|
}).partial().strict().optional(),
|
|
672
|
-
firstPublishedDate: z.object({
|
|
673
|
-
$eq: z.string(),
|
|
674
|
-
$gt: z.string(),
|
|
675
|
-
$gte: z.string(),
|
|
676
|
-
$in: z.array(z.string()),
|
|
677
|
-
$lt: z.string(),
|
|
678
|
-
$lte: z.string(),
|
|
679
|
-
$ne: z.string()
|
|
672
|
+
firstPublishedDate: /* @__PURE__ */ z.object({
|
|
673
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
674
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
675
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
676
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
677
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
678
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
679
|
+
$ne: /* @__PURE__ */ z.string()
|
|
680
680
|
}).partial().strict().optional(),
|
|
681
|
-
lastPublishedDate: z.object({
|
|
682
|
-
$eq: z.string(),
|
|
683
|
-
$gt: z.string(),
|
|
684
|
-
$gte: z.string(),
|
|
685
|
-
$in: z.array(z.string()),
|
|
686
|
-
$lt: z.string(),
|
|
687
|
-
$lte: z.string(),
|
|
688
|
-
$ne: z.string()
|
|
681
|
+
lastPublishedDate: /* @__PURE__ */ z.object({
|
|
682
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
683
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
684
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
685
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
686
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
687
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
688
|
+
$ne: /* @__PURE__ */ z.string()
|
|
689
689
|
}).partial().strict().optional(),
|
|
690
|
-
slug: z.object({
|
|
691
|
-
$eq: z.string(),
|
|
692
|
-
$hasAll: z.array(z.string()),
|
|
693
|
-
$hasSome: z.array(z.string()),
|
|
694
|
-
$ne: z.string(),
|
|
695
|
-
$startsWith: z.string()
|
|
690
|
+
slug: /* @__PURE__ */ z.object({
|
|
691
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
692
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
693
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
694
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
695
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
696
696
|
}).partial().strict().optional(),
|
|
697
|
-
featured:
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
$hasAll: z.array(z.string()),
|
|
701
|
-
$hasSome: z.array(z.string())
|
|
697
|
+
featured: /* @__PURE__ */ z.object({
|
|
698
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
699
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
702
700
|
}).partial().strict().optional(),
|
|
703
|
-
|
|
704
|
-
$eq: z.
|
|
705
|
-
$
|
|
706
|
-
$ne: z.string()
|
|
701
|
+
pinned: /* @__PURE__ */ z.object({
|
|
702
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
703
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
707
704
|
}).partial().strict().optional(),
|
|
708
|
-
|
|
709
|
-
$hasAll: z.array(z.string()),
|
|
710
|
-
$hasSome: z.array(z.string())
|
|
705
|
+
categoryIds: /* @__PURE__ */ z.object({
|
|
706
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
707
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
711
708
|
}).partial().strict().optional(),
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
$
|
|
715
|
-
$
|
|
716
|
-
$gte: z.number(),
|
|
717
|
-
$in: z.array(z.number()),
|
|
718
|
-
$lt: z.number(),
|
|
719
|
-
$lte: z.number(),
|
|
720
|
-
$ne: z.number()
|
|
709
|
+
memberId: /* @__PURE__ */ z.object({
|
|
710
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
711
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
712
|
+
$ne: /* @__PURE__ */ z.string()
|
|
721
713
|
}).partial().strict().optional(),
|
|
722
|
-
|
|
723
|
-
$hasAll: z.array(z.string()),
|
|
724
|
-
$hasSome: z.array(z.string())
|
|
714
|
+
hashtags: /* @__PURE__ */ z.object({
|
|
715
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
716
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
725
717
|
}).partial().strict().optional(),
|
|
726
|
-
|
|
727
|
-
$
|
|
728
|
-
$
|
|
718
|
+
commentingEnabled: /* @__PURE__ */ z.object({
|
|
719
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
720
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
729
721
|
}).partial().strict().optional(),
|
|
730
|
-
|
|
731
|
-
$eq: z.
|
|
732
|
-
$
|
|
733
|
-
$
|
|
734
|
-
$in: z.array(z.
|
|
735
|
-
$
|
|
722
|
+
minutesToRead: /* @__PURE__ */ z.object({
|
|
723
|
+
$eq: /* @__PURE__ */ z.number(),
|
|
724
|
+
$gt: /* @__PURE__ */ z.number(),
|
|
725
|
+
$gte: /* @__PURE__ */ z.number(),
|
|
726
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.number()),
|
|
727
|
+
$lt: /* @__PURE__ */ z.number(),
|
|
728
|
+
$lte: /* @__PURE__ */ z.number(),
|
|
729
|
+
$ne: /* @__PURE__ */ z.number()
|
|
736
730
|
}).partial().strict().optional(),
|
|
737
|
-
|
|
738
|
-
$
|
|
739
|
-
$
|
|
740
|
-
$in: z.array(z.string()),
|
|
741
|
-
$ne: z.string()
|
|
731
|
+
tagIds: /* @__PURE__ */ z.object({
|
|
732
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
733
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
742
734
|
}).partial().strict().optional(),
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
735
|
+
pricingPlanIds: /* @__PURE__ */ z.object({
|
|
736
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
737
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string())
|
|
738
|
+
}).partial().strict().optional(),
|
|
739
|
+
language: /* @__PURE__ */ z.object({
|
|
740
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
741
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
742
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
743
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
744
|
+
$ne: /* @__PURE__ */ z.string()
|
|
745
|
+
}).partial().strict().optional(),
|
|
746
|
+
translationId: /* @__PURE__ */ z.object({
|
|
747
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
748
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
749
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
750
|
+
$ne: /* @__PURE__ */ z.string()
|
|
751
|
+
}).partial().strict().optional(),
|
|
752
|
+
"media.displayed": /* @__PURE__ */ z.object({
|
|
753
|
+
$eq: /* @__PURE__ */ z.boolean(),
|
|
754
|
+
$ne: /* @__PURE__ */ z.boolean()
|
|
755
|
+
}).partial().strict().optional(),
|
|
756
|
+
$and: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
757
|
+
$or: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
758
|
+
$not: /* @__PURE__ */ z.any().optional()
|
|
747
759
|
}).strict().optional(),
|
|
748
|
-
sort: z.array(
|
|
749
|
-
z.object({
|
|
750
|
-
fieldName: z.enum([
|
|
760
|
+
sort: /* @__PURE__ */ z.array(
|
|
761
|
+
/* @__PURE__ */ z.object({
|
|
762
|
+
fieldName: /* @__PURE__ */ z.enum([
|
|
751
763
|
"title",
|
|
752
764
|
"firstPublishedDate",
|
|
753
765
|
"lastPublishedDate",
|
|
@@ -756,13 +768,13 @@ var QueryPostsRequest = /* @__PURE__ */ z.object({
|
|
|
756
768
|
"pinned",
|
|
757
769
|
"commentingEnabled"
|
|
758
770
|
]).optional(),
|
|
759
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
771
|
+
order: /* @__PURE__ */ z.enum(["ASC", "DESC"]).optional()
|
|
760
772
|
})
|
|
761
773
|
).optional()
|
|
762
|
-
}).catchall(z.any()).describe("Query options."),
|
|
763
|
-
options: z.object({
|
|
764
|
-
fieldsets: z.array(
|
|
765
|
-
z.enum([
|
|
774
|
+
}).catchall(/* @__PURE__ */ z.any()).describe("Query options."),
|
|
775
|
+
options: /* @__PURE__ */ z.object({
|
|
776
|
+
fieldsets: /* @__PURE__ */ z.array(
|
|
777
|
+
/* @__PURE__ */ z.enum([
|
|
766
778
|
"UNKNOWN",
|
|
767
779
|
"URL",
|
|
768
780
|
"CONTENT_TEXT",
|
|
@@ -773,184 +785,184 @@ var QueryPostsRequest = /* @__PURE__ */ z.object({
|
|
|
773
785
|
"REFERENCE_ID"
|
|
774
786
|
])
|
|
775
787
|
).max(20).optional(),
|
|
776
|
-
skipCount: z.boolean().describe(
|
|
788
|
+
skipCount: /* @__PURE__ */ z.boolean().describe(
|
|
777
789
|
"When true, omit `pagingMetadata.total`. `hasNext` and next cursor still come from the extra fetched row."
|
|
778
790
|
).optional().nullable()
|
|
779
791
|
}).describe("Options specifying which fields to return.").optional()
|
|
780
792
|
});
|
|
781
793
|
var QueryPostsResponse = /* @__PURE__ */ z.object({
|
|
782
|
-
posts: z.array(
|
|
783
|
-
z.object({
|
|
784
|
-
_id: z.string().describe("Post ID.").regex(
|
|
794
|
+
posts: /* @__PURE__ */ z.array(
|
|
795
|
+
/* @__PURE__ */ z.object({
|
|
796
|
+
_id: /* @__PURE__ */ z.string().describe("Post ID.").regex(
|
|
785
797
|
/^[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}$/,
|
|
786
798
|
"Must be a valid GUID"
|
|
787
799
|
).optional(),
|
|
788
|
-
title: z.string().describe("Post title.").max(200).optional(),
|
|
789
|
-
excerpt: z.string().describe(
|
|
800
|
+
title: /* @__PURE__ */ z.string().describe("Post title.").max(200).optional(),
|
|
801
|
+
excerpt: /* @__PURE__ */ z.string().describe(
|
|
790
802
|
"Post excerpt.\nCan be selected by a site contributor. By default, it is extracted from the content text's first characters.\n\nMax: 500 characters"
|
|
791
803
|
).max(500).optional(),
|
|
792
|
-
contentText: z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
793
|
-
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
794
|
-
lastPublishedDate: z.date().describe("Date the post was last published.").optional().nullable(),
|
|
795
|
-
url: z.string().describe("Post URL.").optional(),
|
|
796
|
-
slug: z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
797
|
-
featured: z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
798
|
-
pinned: z.boolean().describe(
|
|
804
|
+
contentText: /* @__PURE__ */ z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
805
|
+
firstPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was first published.").optional().nullable(),
|
|
806
|
+
lastPublishedDate: /* @__PURE__ */ z.date().describe("Date the post was last published.").optional().nullable(),
|
|
807
|
+
url: /* @__PURE__ */ z.string().describe("Post URL.").optional(),
|
|
808
|
+
slug: /* @__PURE__ */ z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
809
|
+
featured: /* @__PURE__ */ z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
810
|
+
pinned: /* @__PURE__ */ z.boolean().describe(
|
|
799
811
|
"Whether the post is pinned. If `true`, the post is placed at the top of the post list."
|
|
800
812
|
).optional(),
|
|
801
|
-
categoryIds: z.array(z.string()).max(10).optional(),
|
|
802
|
-
memberId: z.string().describe("Member ID of the post's owner.").regex(
|
|
813
|
+
categoryIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(10).optional(),
|
|
814
|
+
memberId: /* @__PURE__ */ z.string().describe("Member ID of the post's owner.").regex(
|
|
803
815
|
/^[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}$/,
|
|
804
816
|
"Must be a valid GUID"
|
|
805
817
|
).optional(),
|
|
806
|
-
hashtags: z.array(z.string()).max(100).optional(),
|
|
807
|
-
commentingEnabled: z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
808
|
-
minutesToRead: z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
809
|
-
heroImage: z.string().describe(
|
|
818
|
+
hashtags: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
819
|
+
commentingEnabled: /* @__PURE__ */ z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
820
|
+
minutesToRead: /* @__PURE__ */ z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
821
|
+
heroImage: /* @__PURE__ */ z.string().describe(
|
|
810
822
|
"Image placed at the top of the blog page. Only displays on mobile devices."
|
|
811
823
|
).optional(),
|
|
812
|
-
tagIds: z.array(z.string()).max(30).optional(),
|
|
813
|
-
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
814
|
-
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
815
|
-
translationId: z.string().describe(
|
|
824
|
+
tagIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(30).optional(),
|
|
825
|
+
relatedPostIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(3).optional(),
|
|
826
|
+
pricingPlanIds: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()).max(100).optional(),
|
|
827
|
+
translationId: /* @__PURE__ */ z.string().describe(
|
|
816
828
|
"ID of the translations of this post. All translations of a single post share the same `translationId`."
|
|
817
829
|
).regex(
|
|
818
830
|
/^[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}$/,
|
|
819
831
|
"Must be a valid GUID"
|
|
820
832
|
).optional().nullable(),
|
|
821
|
-
language: z.string().describe(
|
|
833
|
+
language: /* @__PURE__ */ z.string().describe(
|
|
822
834
|
"Language the 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."
|
|
823
835
|
).optional().nullable(),
|
|
824
|
-
seoData: z.object({
|
|
825
|
-
tags: z.array(
|
|
826
|
-
z.object({
|
|
827
|
-
type: z.string().describe(
|
|
836
|
+
seoData: /* @__PURE__ */ z.object({
|
|
837
|
+
tags: /* @__PURE__ */ z.array(
|
|
838
|
+
/* @__PURE__ */ z.object({
|
|
839
|
+
type: /* @__PURE__ */ z.string().describe(
|
|
828
840
|
"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`)."
|
|
829
841
|
).optional(),
|
|
830
|
-
props: z.record(z.string(), z.any()).describe(
|
|
842
|
+
props: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
831
843
|
'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"}`.'
|
|
832
844
|
).optional().nullable(),
|
|
833
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
845
|
+
meta: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
834
846
|
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
835
847
|
).optional().nullable(),
|
|
836
|
-
children: z.string().describe(
|
|
848
|
+
children: /* @__PURE__ */ z.string().describe(
|
|
837
849
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
838
850
|
).optional(),
|
|
839
|
-
custom: z.boolean().describe(
|
|
851
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
840
852
|
"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."
|
|
841
853
|
).optional(),
|
|
842
|
-
disabled: z.boolean().describe(
|
|
854
|
+
disabled: /* @__PURE__ */ z.boolean().describe(
|
|
843
855
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
844
856
|
).optional()
|
|
845
857
|
})
|
|
846
858
|
).optional(),
|
|
847
|
-
settings: z.object({
|
|
848
|
-
preventAutoRedirect: z.boolean().describe(
|
|
859
|
+
settings: /* @__PURE__ */ z.object({
|
|
860
|
+
preventAutoRedirect: /* @__PURE__ */ z.boolean().describe(
|
|
849
861
|
"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)."
|
|
850
862
|
).optional(),
|
|
851
|
-
keywords: z.array(
|
|
852
|
-
z.object({
|
|
853
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
854
|
-
isMain: z.boolean().describe(
|
|
863
|
+
keywords: /* @__PURE__ */ z.array(
|
|
864
|
+
/* @__PURE__ */ z.object({
|
|
865
|
+
term: /* @__PURE__ */ z.string().describe("Keyword value.").optional(),
|
|
866
|
+
isMain: /* @__PURE__ */ z.boolean().describe(
|
|
855
867
|
"Whether the keyword is the main focus keyword."
|
|
856
868
|
).optional(),
|
|
857
|
-
origin: z.string().describe(
|
|
869
|
+
origin: /* @__PURE__ */ z.string().describe(
|
|
858
870
|
"The source that added the keyword terms to the SEO settings."
|
|
859
871
|
).max(1e3).optional().nullable()
|
|
860
872
|
})
|
|
861
873
|
).max(5).optional()
|
|
862
874
|
}).describe("SEO general settings.").optional()
|
|
863
875
|
}).describe("SEO data.").optional(),
|
|
864
|
-
contactId: z.string().describe(
|
|
876
|
+
contactId: /* @__PURE__ */ z.string().describe(
|
|
865
877
|
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
866
878
|
).regex(
|
|
867
879
|
/^[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}$/,
|
|
868
880
|
"Must be a valid GUID"
|
|
869
881
|
).optional().nullable(),
|
|
870
|
-
richContent: z.any().describe(
|
|
882
|
+
richContent: /* @__PURE__ */ z.any().describe(
|
|
871
883
|
'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>'
|
|
872
884
|
).optional(),
|
|
873
|
-
preview: z.boolean().describe(
|
|
885
|
+
preview: /* @__PURE__ */ z.boolean().describe(
|
|
874
886
|
"Whether the returned content is a preview of premium content. Defaults to `false`.\nA preview displays a limited number of paragraphs of paid content to non-subscribed users."
|
|
875
887
|
).optional(),
|
|
876
|
-
moderationDetails: z.object({
|
|
877
|
-
submittedBy: z.string().describe(
|
|
888
|
+
moderationDetails: /* @__PURE__ */ z.object({
|
|
889
|
+
submittedBy: /* @__PURE__ */ z.string().describe(
|
|
878
890
|
"Member ID of the person submitting the draft post for review."
|
|
879
891
|
).regex(
|
|
880
892
|
/^[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}$/,
|
|
881
893
|
"Must be a valid GUID"
|
|
882
894
|
).optional(),
|
|
883
|
-
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
884
|
-
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
895
|
+
submittedDate: /* @__PURE__ */ z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
896
|
+
status: /* @__PURE__ */ z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
885
897
|
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
886
898
|
).optional(),
|
|
887
|
-
moderatedBy: z.string().describe(
|
|
899
|
+
moderatedBy: /* @__PURE__ */ z.string().describe(
|
|
888
900
|
"Member ID of the person who approved or rejected the post."
|
|
889
901
|
).regex(
|
|
890
902
|
/^[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}$/,
|
|
891
903
|
"Must be a valid GUID"
|
|
892
904
|
).optional().nullable(),
|
|
893
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
905
|
+
moderationDate: /* @__PURE__ */ z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
894
906
|
}).describe(
|
|
895
907
|
"Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).\n\nGuest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user."
|
|
896
908
|
).optional(),
|
|
897
|
-
media: z.intersection(
|
|
898
|
-
z.object({
|
|
899
|
-
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
900
|
-
custom: z.boolean().describe(
|
|
909
|
+
media: /* @__PURE__ */ z.intersection(
|
|
910
|
+
/* @__PURE__ */ z.object({
|
|
911
|
+
displayed: /* @__PURE__ */ z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
912
|
+
custom: /* @__PURE__ */ z.boolean().describe(
|
|
901
913
|
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
902
914
|
).optional(),
|
|
903
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
915
|
+
altText: /* @__PURE__ */ z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
904
916
|
}),
|
|
905
|
-
z.xor([
|
|
906
|
-
z.object({
|
|
907
|
-
wixMedia: z.never().optional(),
|
|
908
|
-
embedMedia: z.never().optional()
|
|
917
|
+
/* @__PURE__ */ z.xor([
|
|
918
|
+
/* @__PURE__ */ z.object({
|
|
919
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
920
|
+
embedMedia: /* @__PURE__ */ z.never().optional()
|
|
909
921
|
}),
|
|
910
|
-
z.object({
|
|
911
|
-
embedMedia: z.never().optional(),
|
|
912
|
-
wixMedia: z.object({
|
|
913
|
-
image: z.string().describe("Image details.").optional(),
|
|
914
|
-
videoV2: z.string().describe("Video details.").optional()
|
|
922
|
+
/* @__PURE__ */ z.object({
|
|
923
|
+
embedMedia: /* @__PURE__ */ z.never().optional(),
|
|
924
|
+
wixMedia: /* @__PURE__ */ z.object({
|
|
925
|
+
image: /* @__PURE__ */ z.string().describe("Image details.").optional(),
|
|
926
|
+
videoV2: /* @__PURE__ */ z.string().describe("Video details.").optional()
|
|
915
927
|
}).describe("Wix Media details.")
|
|
916
928
|
}),
|
|
917
|
-
z.object({
|
|
918
|
-
wixMedia: z.never().optional(),
|
|
919
|
-
embedMedia: z.object({
|
|
920
|
-
thumbnail: z.object({
|
|
921
|
-
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
922
|
-
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
923
|
-
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
929
|
+
/* @__PURE__ */ z.object({
|
|
930
|
+
wixMedia: /* @__PURE__ */ z.never().optional(),
|
|
931
|
+
embedMedia: /* @__PURE__ */ z.object({
|
|
932
|
+
thumbnail: /* @__PURE__ */ z.object({
|
|
933
|
+
url: /* @__PURE__ */ z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
934
|
+
width: /* @__PURE__ */ z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
935
|
+
height: /* @__PURE__ */ z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
924
936
|
}).describe("Thumbnail details.").optional(),
|
|
925
|
-
video: z.object({
|
|
926
|
-
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
927
|
-
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
928
|
-
height: z.number().int().describe("Video height.").min(0).optional()
|
|
937
|
+
video: /* @__PURE__ */ z.object({
|
|
938
|
+
url: /* @__PURE__ */ z.string().describe("Video url.").max(2e3).optional(),
|
|
939
|
+
width: /* @__PURE__ */ z.number().int().describe("Video width.").min(0).optional(),
|
|
940
|
+
height: /* @__PURE__ */ z.number().int().describe("Video height.").min(0).optional()
|
|
929
941
|
}).describe("Video details.").optional()
|
|
930
942
|
}).describe("Embed media details.")
|
|
931
943
|
})
|
|
932
944
|
])
|
|
933
945
|
).describe("Post cover media.").optional(),
|
|
934
|
-
hasUnpublishedChanges: z.boolean().describe(
|
|
946
|
+
hasUnpublishedChanges: /* @__PURE__ */ z.boolean().describe(
|
|
935
947
|
"Indicates if there is a draft post with changes that have not yet been published."
|
|
936
948
|
).optional(),
|
|
937
|
-
referenceId: z.string().describe(
|
|
949
|
+
referenceId: /* @__PURE__ */ z.string().describe(
|
|
938
950
|
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
939
951
|
).max(24).optional().nullable()
|
|
940
952
|
})
|
|
941
953
|
).optional(),
|
|
942
|
-
pagingMetadata: z.object({
|
|
943
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
944
|
-
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
945
|
-
total: z.number().int().describe(
|
|
954
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
955
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
956
|
+
offset: /* @__PURE__ */ z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
957
|
+
total: /* @__PURE__ */ z.number().int().describe(
|
|
946
958
|
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
947
959
|
).optional().nullable(),
|
|
948
|
-
tooManyToCount: z.boolean().describe(
|
|
960
|
+
tooManyToCount: /* @__PURE__ */ z.boolean().describe(
|
|
949
961
|
"Flag that indicates the server failed to calculate the `total` field."
|
|
950
962
|
).optional().nullable(),
|
|
951
|
-
cursors: z.object({
|
|
952
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
953
|
-
prev: z.string().describe(
|
|
963
|
+
cursors: /* @__PURE__ */ z.object({
|
|
964
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").max(2e3).optional().nullable(),
|
|
965
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
954
966
|
"Cursor pointing to previous page in the list of results."
|
|
955
967
|
).max(2e3).optional().nullable()
|
|
956
968
|
}).describe(
|
|
@@ -959,13 +971,13 @@ var QueryPostsResponse = /* @__PURE__ */ z.object({
|
|
|
959
971
|
}).describe("Details on the paged set of results returned.").optional()
|
|
960
972
|
});
|
|
961
973
|
var GetPostMetricsRequest = /* @__PURE__ */ z.object({
|
|
962
|
-
postId: z.string().describe("Post ID to retrieve metrics for.").min(1).max(38)
|
|
974
|
+
postId: /* @__PURE__ */ z.string().describe("Post ID to retrieve metrics for.").min(1).max(38)
|
|
963
975
|
});
|
|
964
976
|
var GetPostMetricsResponse = /* @__PURE__ */ z.object({
|
|
965
|
-
metrics: z.object({
|
|
966
|
-
comments: z.number().int().describe("Total number of post comments.").optional(),
|
|
967
|
-
likes: z.number().int().describe("Total number of post likes.").optional(),
|
|
968
|
-
views: z.number().int().describe("Total number of post views.").optional()
|
|
977
|
+
metrics: /* @__PURE__ */ z.object({
|
|
978
|
+
comments: /* @__PURE__ */ z.number().int().describe("Total number of post comments.").optional(),
|
|
979
|
+
likes: /* @__PURE__ */ z.number().int().describe("Total number of post likes.").optional(),
|
|
980
|
+
views: /* @__PURE__ */ z.number().int().describe("Total number of post views.").optional()
|
|
969
981
|
}).describe("Retrieved post metrics.").optional()
|
|
970
982
|
});
|
|
971
983
|
// Annotate the CommonJS export names for ESM import in node:
|