@wix/auto_sdk_blog_posts 1.0.171 → 1.0.172
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +11 -15
- package/build/cjs/index.js +11 -16
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +27 -32
- package/build/cjs/index.typings.js +6 -6
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +10 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +82 -84
- package/build/cjs/schemas.js +150 -156
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -15
- package/build/es/index.mjs +11 -16
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +27 -32
- package/build/es/index.typings.mjs +6 -6
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +10 -3
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +82 -84
- package/build/es/schemas.mjs +150 -156
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -15
- package/build/internal/cjs/index.js +11 -16
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +27 -32
- package/build/internal/cjs/index.typings.js +6 -6
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +10 -3
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +82 -84
- package/build/internal/cjs/schemas.js +150 -156
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -15
- package/build/internal/es/index.mjs +11 -16
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +27 -32
- package/build/internal/es/index.typings.mjs +6 -6
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +10 -3
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +82 -84
- package/build/internal/es/schemas.mjs +150 -156
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/schemas.d.ts
CHANGED
|
@@ -43,91 +43,89 @@ declare const GetPostRequest: z.ZodObject<{
|
|
|
43
43
|
}, z.core.$strip>>;
|
|
44
44
|
}, z.core.$strip>;
|
|
45
45
|
declare const GetPostResponse: z.ZodObject<{
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
46
|
+
_id: z.ZodOptional<z.ZodString>;
|
|
47
|
+
title: z.ZodOptional<z.ZodString>;
|
|
48
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
49
|
+
contentText: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
50
|
+
firstPublishedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
51
|
+
lastPublishedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
52
|
+
url: z.ZodOptional<z.ZodString>;
|
|
53
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
54
|
+
featured: z.ZodOptional<z.ZodBoolean>;
|
|
55
|
+
pinned: z.ZodOptional<z.ZodBoolean>;
|
|
56
|
+
categoryIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
57
|
+
memberId: z.ZodOptional<z.ZodString>;
|
|
58
|
+
hashtags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
59
|
+
commentingEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
60
|
+
minutesToRead: z.ZodOptional<z.ZodNumber>;
|
|
61
|
+
heroImage: z.ZodOptional<z.ZodString>;
|
|
62
|
+
tagIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
63
|
+
relatedPostIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
64
|
+
pricingPlanIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
65
|
+
translationId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
66
|
+
language: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
67
|
+
seoData: z.ZodOptional<z.ZodObject<{
|
|
68
|
+
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
69
|
+
type: z.ZodOptional<z.ZodString>;
|
|
70
|
+
props: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
71
|
+
meta: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
72
|
+
children: z.ZodOptional<z.ZodString>;
|
|
73
|
+
custom: z.ZodOptional<z.ZodBoolean>;
|
|
74
|
+
disabled: z.ZodOptional<z.ZodBoolean>;
|
|
75
|
+
}, z.core.$strip>>>;
|
|
76
|
+
settings: z.ZodOptional<z.ZodObject<{
|
|
77
|
+
preventAutoRedirect: z.ZodOptional<z.ZodBoolean>;
|
|
78
|
+
keywords: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
79
|
+
term: z.ZodOptional<z.ZodString>;
|
|
80
|
+
isMain: z.ZodOptional<z.ZodBoolean>;
|
|
81
|
+
origin: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
76
82
|
}, z.core.$strip>>>;
|
|
77
|
-
settings: z.ZodOptional<z.ZodObject<{
|
|
78
|
-
preventAutoRedirect: z.ZodOptional<z.ZodBoolean>;
|
|
79
|
-
keywords: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
80
|
-
term: z.ZodOptional<z.ZodString>;
|
|
81
|
-
isMain: z.ZodOptional<z.ZodBoolean>;
|
|
82
|
-
origin: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
83
|
-
}, z.core.$strip>>>;
|
|
84
|
-
}, z.core.$strip>>;
|
|
85
83
|
}, z.core.$strip>>;
|
|
86
|
-
contactId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
87
|
-
richContent: z.ZodOptional<z.ZodAny>;
|
|
88
|
-
preview: z.ZodOptional<z.ZodBoolean>;
|
|
89
|
-
moderationDetails: z.ZodOptional<z.ZodObject<{
|
|
90
|
-
submittedBy: z.ZodOptional<z.ZodString>;
|
|
91
|
-
submittedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
92
|
-
status: z.ZodOptional<z.ZodEnum<{
|
|
93
|
-
UNKNOWN: "UNKNOWN";
|
|
94
|
-
APPROVED: "APPROVED";
|
|
95
|
-
REJECTED: "REJECTED";
|
|
96
|
-
}>>;
|
|
97
|
-
moderatedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
98
|
-
moderationDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
99
|
-
}, z.core.$strip>>;
|
|
100
|
-
media: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
|
|
101
|
-
displayed: z.ZodOptional<z.ZodBoolean>;
|
|
102
|
-
custom: z.ZodOptional<z.ZodBoolean>;
|
|
103
|
-
altText: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
104
|
-
}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
|
|
105
|
-
wixMedia: z.ZodOptional<z.ZodNever>;
|
|
106
|
-
embedMedia: z.ZodOptional<z.ZodNever>;
|
|
107
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
108
|
-
embedMedia: z.ZodOptional<z.ZodNever>;
|
|
109
|
-
wixMedia: z.ZodObject<{
|
|
110
|
-
image: z.ZodOptional<z.ZodString>;
|
|
111
|
-
videoV2: z.ZodOptional<z.ZodString>;
|
|
112
|
-
}, z.core.$strip>;
|
|
113
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
114
|
-
wixMedia: z.ZodOptional<z.ZodNever>;
|
|
115
|
-
embedMedia: z.ZodObject<{
|
|
116
|
-
thumbnail: z.ZodOptional<z.ZodObject<{
|
|
117
|
-
url: z.ZodOptional<z.ZodString>;
|
|
118
|
-
width: z.ZodOptional<z.ZodNumber>;
|
|
119
|
-
height: z.ZodOptional<z.ZodNumber>;
|
|
120
|
-
}, z.core.$strip>>;
|
|
121
|
-
video: z.ZodOptional<z.ZodObject<{
|
|
122
|
-
url: z.ZodOptional<z.ZodString>;
|
|
123
|
-
width: z.ZodOptional<z.ZodNumber>;
|
|
124
|
-
height: z.ZodOptional<z.ZodNumber>;
|
|
125
|
-
}, z.core.$strip>>;
|
|
126
|
-
}, z.core.$strip>;
|
|
127
|
-
}, z.core.$strip>]>>>;
|
|
128
|
-
hasUnpublishedChanges: z.ZodOptional<z.ZodBoolean>;
|
|
129
|
-
referenceId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
130
84
|
}, z.core.$strip>>;
|
|
85
|
+
contactId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
86
|
+
richContent: z.ZodOptional<z.ZodAny>;
|
|
87
|
+
preview: z.ZodOptional<z.ZodBoolean>;
|
|
88
|
+
moderationDetails: z.ZodOptional<z.ZodObject<{
|
|
89
|
+
submittedBy: z.ZodOptional<z.ZodString>;
|
|
90
|
+
submittedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
91
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
92
|
+
UNKNOWN: "UNKNOWN";
|
|
93
|
+
APPROVED: "APPROVED";
|
|
94
|
+
REJECTED: "REJECTED";
|
|
95
|
+
}>>;
|
|
96
|
+
moderatedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
97
|
+
moderationDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
98
|
+
}, z.core.$strip>>;
|
|
99
|
+
media: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
|
|
100
|
+
displayed: z.ZodOptional<z.ZodBoolean>;
|
|
101
|
+
custom: z.ZodOptional<z.ZodBoolean>;
|
|
102
|
+
altText: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
103
|
+
}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
|
|
104
|
+
wixMedia: z.ZodOptional<z.ZodNever>;
|
|
105
|
+
embedMedia: z.ZodOptional<z.ZodNever>;
|
|
106
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
107
|
+
embedMedia: z.ZodOptional<z.ZodNever>;
|
|
108
|
+
wixMedia: z.ZodObject<{
|
|
109
|
+
image: z.ZodOptional<z.ZodString>;
|
|
110
|
+
videoV2: z.ZodOptional<z.ZodString>;
|
|
111
|
+
}, z.core.$strip>;
|
|
112
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
113
|
+
wixMedia: z.ZodOptional<z.ZodNever>;
|
|
114
|
+
embedMedia: z.ZodObject<{
|
|
115
|
+
thumbnail: z.ZodOptional<z.ZodObject<{
|
|
116
|
+
url: z.ZodOptional<z.ZodString>;
|
|
117
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
118
|
+
height: z.ZodOptional<z.ZodNumber>;
|
|
119
|
+
}, z.core.$strip>>;
|
|
120
|
+
video: z.ZodOptional<z.ZodObject<{
|
|
121
|
+
url: z.ZodOptional<z.ZodString>;
|
|
122
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
123
|
+
height: z.ZodOptional<z.ZodNumber>;
|
|
124
|
+
}, z.core.$strip>>;
|
|
125
|
+
}, z.core.$strip>;
|
|
126
|
+
}, z.core.$strip>]>>>;
|
|
127
|
+
hasUnpublishedChanges: z.ZodOptional<z.ZodBoolean>;
|
|
128
|
+
referenceId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
131
129
|
}, z.core.$strip>;
|
|
132
130
|
declare const GetPostBySlugRequest: z.ZodObject<{
|
|
133
131
|
slug: z.ZodString;
|
|
@@ -466,11 +464,11 @@ declare const QueryPostsRequest: z.ZodObject<{
|
|
|
466
464
|
fieldName: z.ZodOptional<z.ZodEnum<{
|
|
467
465
|
slug: "slug";
|
|
468
466
|
title: "title";
|
|
469
|
-
firstPublishedDate: "firstPublishedDate";
|
|
470
|
-
lastPublishedDate: "lastPublishedDate";
|
|
471
467
|
featured: "featured";
|
|
472
468
|
pinned: "pinned";
|
|
473
469
|
commentingEnabled: "commentingEnabled";
|
|
470
|
+
firstPublishedDate: "firstPublishedDate";
|
|
471
|
+
lastPublishedDate: "lastPublishedDate";
|
|
474
472
|
}>>;
|
|
475
473
|
order: z.ZodOptional<z.ZodEnum<{
|
|
476
474
|
ASC: "ASC";
|
package/build/cjs/schemas.js
CHANGED
|
@@ -62,7 +62,7 @@ var QueryPostCountStatsRequest = z.object({
|
|
|
62
62
|
timeZone: z.string().describe(
|
|
63
63
|
"Time zone to use when calculating the start of the month.\n\n[UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`."
|
|
64
64
|
).min(3).max(100).optional().nullable()
|
|
65
|
-
}).
|
|
65
|
+
}).optional()
|
|
66
66
|
});
|
|
67
67
|
var QueryPostCountStatsResponse = z.object({
|
|
68
68
|
stats: z.array(
|
|
@@ -79,7 +79,7 @@ var GetTotalPostsRequest = z.object({
|
|
|
79
79
|
language: z.string().describe(
|
|
80
80
|
"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to receive the total amount of posts in that specified language."
|
|
81
81
|
).optional().nullable()
|
|
82
|
-
}).
|
|
82
|
+
}).optional()
|
|
83
83
|
});
|
|
84
84
|
var GetTotalPostsResponse = z.object({
|
|
85
85
|
total: z.number().int().describe("Total amount of published posts.").min(0).optional()
|
|
@@ -99,167 +99,161 @@ var GetPostRequest = z.object({
|
|
|
99
99
|
"REFERENCE_ID"
|
|
100
100
|
])
|
|
101
101
|
).max(20).optional()
|
|
102
|
-
}).
|
|
102
|
+
}).optional()
|
|
103
103
|
});
|
|
104
104
|
var GetPostResponse = z.object({
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
excerpt:
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
pinned
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
105
|
+
_id: z.string().describe("Post ID.").regex(
|
|
106
|
+
/^[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}$/,
|
|
107
|
+
"Must be a valid GUID"
|
|
108
|
+
).optional(),
|
|
109
|
+
title: z.string().describe("Post title.").max(200).optional(),
|
|
110
|
+
excerpt: z.string().describe(
|
|
111
|
+
"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"
|
|
112
|
+
).max(500).optional(),
|
|
113
|
+
contentText: z.string().describe("The post's content in plain text.").max(4e5).optional().nullable(),
|
|
114
|
+
firstPublishedDate: z.date().describe("Date the post was first published.").optional().nullable(),
|
|
115
|
+
lastPublishedDate: z.date().describe("Date the post was last published.").optional().nullable(),
|
|
116
|
+
url: z.string().describe("Post URL.").optional(),
|
|
117
|
+
slug: z.string().describe("Post slug. For example, `'post-slug'`.").max(100).optional(),
|
|
118
|
+
featured: z.boolean().describe("Whether the post is marked as featured.").optional(),
|
|
119
|
+
pinned: z.boolean().describe(
|
|
120
|
+
"Whether the post is pinned. If `true`, the post is placed at the top of the post list."
|
|
121
|
+
).optional(),
|
|
122
|
+
categoryIds: z.array(z.string()).max(10).optional(),
|
|
123
|
+
memberId: z.string().describe("Member ID of the post's owner.").regex(
|
|
124
|
+
/^[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}$/,
|
|
125
|
+
"Must be a valid GUID"
|
|
126
|
+
).optional(),
|
|
127
|
+
hashtags: z.array(z.string()).max(100).optional(),
|
|
128
|
+
commentingEnabled: z.boolean().describe("Whether commenting on the post is enabled.").optional(),
|
|
129
|
+
minutesToRead: z.number().int().describe("Estimated reading time (calculated automatically).").optional(),
|
|
130
|
+
heroImage: z.string().describe(
|
|
131
|
+
"Image placed at the top of the blog page. Only displays on mobile devices."
|
|
132
|
+
).optional(),
|
|
133
|
+
tagIds: z.array(z.string()).max(30).optional(),
|
|
134
|
+
relatedPostIds: z.array(z.string()).max(3).optional(),
|
|
135
|
+
pricingPlanIds: z.array(z.string()).max(100).optional(),
|
|
136
|
+
translationId: z.string().describe(
|
|
137
|
+
"ID of the translations of this post. All translations of a single post share the same `translationId`."
|
|
138
|
+
).regex(
|
|
139
|
+
/^[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}$/,
|
|
140
|
+
"Must be a valid GUID"
|
|
141
|
+
).optional().nullable(),
|
|
142
|
+
language: z.string().describe(
|
|
143
|
+
"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."
|
|
144
|
+
).optional().nullable(),
|
|
145
|
+
seoData: z.object({
|
|
146
|
+
tags: z.array(
|
|
147
|
+
z.object({
|
|
148
|
+
type: z.string().describe(
|
|
149
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
150
|
+
).optional(),
|
|
151
|
+
props: z.record(z.string(), z.any()).describe(
|
|
152
|
+
'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"}`.'
|
|
153
|
+
).optional().nullable(),
|
|
154
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
155
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
156
|
+
).optional().nullable(),
|
|
157
|
+
children: z.string().describe(
|
|
158
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
159
|
+
).optional(),
|
|
160
|
+
custom: z.boolean().describe(
|
|
161
|
+
"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\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."
|
|
162
|
+
).optional(),
|
|
163
|
+
disabled: z.boolean().describe(
|
|
164
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
165
|
+
).optional()
|
|
166
|
+
})
|
|
133
167
|
).optional(),
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
).regex(
|
|
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
|
-
"Must be a valid GUID"
|
|
142
|
-
).optional().nullable(),
|
|
143
|
-
language: z.string().describe(
|
|
144
|
-
"Language the post is written in.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format."
|
|
145
|
-
).optional().nullable(),
|
|
146
|
-
seoData: z.object({
|
|
147
|
-
tags: z.array(
|
|
168
|
+
settings: z.object({
|
|
169
|
+
preventAutoRedirect: z.boolean().describe(
|
|
170
|
+
"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)."
|
|
171
|
+
).optional(),
|
|
172
|
+
keywords: z.array(
|
|
148
173
|
z.object({
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
).
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
).optional().nullable(),
|
|
155
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
156
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
157
|
-
).optional().nullable(),
|
|
158
|
-
children: z.string().describe(
|
|
159
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
160
|
-
).optional(),
|
|
161
|
-
custom: z.boolean().describe(
|
|
162
|
-
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
163
|
-
).optional(),
|
|
164
|
-
disabled: z.boolean().describe(
|
|
165
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
166
|
-
).optional()
|
|
174
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
175
|
+
isMain: z.boolean().describe("Whether the keyword is the main focus keyword.").optional(),
|
|
176
|
+
origin: z.string().describe(
|
|
177
|
+
"The source that added the keyword terms to the SEO settings."
|
|
178
|
+
).max(1e3).optional().nullable()
|
|
167
179
|
})
|
|
168
|
-
).optional()
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
contactId: z.string().describe(
|
|
187
|
-
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
180
|
+
).max(5).optional()
|
|
181
|
+
}).describe("SEO general settings.").optional()
|
|
182
|
+
}).describe("SEO data.").optional(),
|
|
183
|
+
contactId: z.string().describe(
|
|
184
|
+
"Contact ID of the post's owner. See the Contacts API for more info."
|
|
185
|
+
).regex(
|
|
186
|
+
/^[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}$/,
|
|
187
|
+
"Must be a valid GUID"
|
|
188
|
+
).optional().nullable(),
|
|
189
|
+
richContent: z.any().describe(
|
|
190
|
+
'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>'
|
|
191
|
+
).optional(),
|
|
192
|
+
preview: z.boolean().describe(
|
|
193
|
+
"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."
|
|
194
|
+
).optional(),
|
|
195
|
+
moderationDetails: z.object({
|
|
196
|
+
submittedBy: z.string().describe(
|
|
197
|
+
"Member ID of the person submitting the draft post for review."
|
|
188
198
|
).regex(
|
|
189
199
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
190
200
|
"Must be a valid GUID"
|
|
191
|
-
).optional().nullable(),
|
|
192
|
-
richContent: z.any().describe(
|
|
193
|
-
'Post rich content\n\n<widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">\n<a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>\n</widget>'
|
|
194
201
|
).optional(),
|
|
195
|
-
|
|
196
|
-
|
|
202
|
+
submittedDate: z.date().describe("Date the post was submitted for review.").optional().nullable(),
|
|
203
|
+
status: z.enum(["UNKNOWN", "APPROVED", "REJECTED"]).describe(
|
|
204
|
+
"Status indicating whether the submission was approved or rejected by the moderator."
|
|
197
205
|
).optional(),
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
206
|
+
moderatedBy: z.string().describe("Member ID of the person who approved or rejected the post.").regex(
|
|
207
|
+
/^[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}$/,
|
|
208
|
+
"Must be a valid GUID"
|
|
209
|
+
).optional().nullable(),
|
|
210
|
+
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
211
|
+
}).describe(
|
|
212
|
+
"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."
|
|
213
|
+
).optional(),
|
|
214
|
+
media: z.intersection(
|
|
215
|
+
z.object({
|
|
216
|
+
displayed: z.boolean().describe("Whether cover media is displayed.").optional(),
|
|
217
|
+
custom: z.boolean().describe(
|
|
218
|
+
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
208
219
|
).optional(),
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
213
|
-
"Must be a valid GUID"
|
|
214
|
-
).optional().nullable(),
|
|
215
|
-
moderationDate: z.date().describe("Date the post was approved or rejected.").optional().nullable()
|
|
216
|
-
}).describe(
|
|
217
|
-
"Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).\n\nGuest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user."
|
|
218
|
-
).optional(),
|
|
219
|
-
media: z.intersection(
|
|
220
|
+
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
221
|
+
}),
|
|
222
|
+
z.xor([
|
|
220
223
|
z.object({
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
"Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media."
|
|
224
|
-
).optional(),
|
|
225
|
-
altText: z.string().describe("Media alternative text.").min(1).max(1e3).optional().nullable()
|
|
224
|
+
wixMedia: z.never().optional(),
|
|
225
|
+
embedMedia: z.never().optional()
|
|
226
226
|
}),
|
|
227
|
-
z.
|
|
228
|
-
z.
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
"Indicates if there is a draft post with changes that have not yet been published."
|
|
258
|
-
).optional(),
|
|
259
|
-
referenceId: z.string().describe(
|
|
260
|
-
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
261
|
-
).max(24).optional().nullable()
|
|
262
|
-
}).describe("Retrieved post info.").optional()
|
|
227
|
+
z.object({
|
|
228
|
+
embedMedia: z.never().optional(),
|
|
229
|
+
wixMedia: z.object({
|
|
230
|
+
image: z.string().describe("Image details.").optional(),
|
|
231
|
+
videoV2: z.string().describe("Video details.").optional()
|
|
232
|
+
}).describe("Wix Media details.")
|
|
233
|
+
}),
|
|
234
|
+
z.object({
|
|
235
|
+
wixMedia: z.never().optional(),
|
|
236
|
+
embedMedia: z.object({
|
|
237
|
+
thumbnail: z.object({
|
|
238
|
+
url: z.string().describe("Thumbnail url.").max(2e3).optional(),
|
|
239
|
+
width: z.number().int().describe("Thumbnail width.").min(0).optional(),
|
|
240
|
+
height: z.number().int().describe("Thumbnail height.").min(0).optional()
|
|
241
|
+
}).describe("Thumbnail details.").optional(),
|
|
242
|
+
video: z.object({
|
|
243
|
+
url: z.string().describe("Video url.").max(2e3).optional(),
|
|
244
|
+
width: z.number().int().describe("Video width.").min(0).optional(),
|
|
245
|
+
height: z.number().int().describe("Video height.").min(0).optional()
|
|
246
|
+
}).describe("Video details.").optional()
|
|
247
|
+
}).describe("Embed media details.")
|
|
248
|
+
})
|
|
249
|
+
])
|
|
250
|
+
).describe("Post cover media.").optional(),
|
|
251
|
+
hasUnpublishedChanges: z.boolean().describe(
|
|
252
|
+
"Indicates if there is a draft post with changes that have not yet been published."
|
|
253
|
+
).optional(),
|
|
254
|
+
referenceId: z.string().describe(
|
|
255
|
+
"Post reference ID. You can reference the post from other entities, for example, comments."
|
|
256
|
+
).max(24).optional().nullable()
|
|
263
257
|
});
|
|
264
258
|
var GetPostBySlugRequest = z.object({
|
|
265
259
|
slug: z.string().describe("Slug of the post to retrieve.").min(1).max(200),
|
|
@@ -277,7 +271,7 @@ var GetPostBySlugRequest = z.object({
|
|
|
277
271
|
])
|
|
278
272
|
).max(20).optional(),
|
|
279
273
|
language: z.string().describe("Language of the post.").optional().nullable()
|
|
280
|
-
}).
|
|
274
|
+
}).optional()
|
|
281
275
|
});
|
|
282
276
|
var GetPostBySlugResponse = z.object({
|
|
283
277
|
post: z.object({
|
|
@@ -337,7 +331,7 @@ var GetPostBySlugResponse = z.object({
|
|
|
337
331
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
338
332
|
).optional(),
|
|
339
333
|
custom: z.boolean().describe(
|
|
340
|
-
|
|
334
|
+
"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\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
341
335
|
).optional(),
|
|
342
336
|
disabled: z.boolean().describe(
|
|
343
337
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -482,7 +476,7 @@ var ListPostsRequest = z.object({
|
|
|
482
476
|
"REFERENCE_ID"
|
|
483
477
|
])
|
|
484
478
|
).max(20).optional()
|
|
485
|
-
}).
|
|
479
|
+
}).optional()
|
|
486
480
|
});
|
|
487
481
|
var ListPostsResponse = z.object({
|
|
488
482
|
posts: z.array(
|
|
@@ -543,7 +537,7 @@ var ListPostsResponse = z.object({
|
|
|
543
537
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
544
538
|
).optional(),
|
|
545
539
|
custom: z.boolean().describe(
|
|
546
|
-
|
|
540
|
+
"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\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
547
541
|
).optional(),
|
|
548
542
|
disabled: z.boolean().describe(
|
|
549
543
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -773,7 +767,7 @@ var QueryPostsRequest = z.object({
|
|
|
773
767
|
"REFERENCE_ID"
|
|
774
768
|
])
|
|
775
769
|
).max(20).optional()
|
|
776
|
-
}).
|
|
770
|
+
}).optional()
|
|
777
771
|
});
|
|
778
772
|
var QueryPostsResponse = z.object({
|
|
779
773
|
posts: z.array(
|
|
@@ -834,7 +828,7 @@ var QueryPostsResponse = z.object({
|
|
|
834
828
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
835
829
|
).optional(),
|
|
836
830
|
custom: z.boolean().describe(
|
|
837
|
-
|
|
831
|
+
"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\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."
|
|
838
832
|
).optional(),
|
|
839
833
|
disabled: z.boolean().describe(
|
|
840
834
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|