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