@wix/auto_sdk_seo_seo-patterns 1.0.0
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 +141 -0
- package/build/cjs/index.js +455 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +777 -0
- package/build/cjs/index.typings.js +398 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +592 -0
- package/build/cjs/meta.js +335 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/schemas.d.ts +312 -0
- package/build/cjs/schemas.js +717 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.d.mts +141 -0
- package/build/es/index.mjs +423 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/index.typings.d.mts +777 -0
- package/build/es/index.typings.mjs +366 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +592 -0
- package/build/es/meta.mjs +300 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/schemas.d.mts +312 -0
- package/build/es/schemas.mjs +669 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +141 -0
- package/build/internal/cjs/index.js +455 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +777 -0
- package/build/internal/cjs/index.typings.js +398 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +634 -0
- package/build/internal/cjs/meta.js +335 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/schemas.d.ts +312 -0
- package/build/internal/cjs/schemas.js +717 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.d.mts +141 -0
- package/build/internal/es/index.mjs +423 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/index.typings.d.mts +777 -0
- package/build/internal/es/index.typings.mjs +366 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +634 -0
- package/build/internal/es/meta.mjs +300 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/build/internal/es/schemas.d.mts +312 -0
- package/build/internal/es/schemas.mjs +669 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +61 -0
- package/schemas/package.json +3 -0
|
@@ -0,0 +1,717 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
|
|
30
|
+
// schemas.ts
|
|
31
|
+
var schemas_exports = {};
|
|
32
|
+
__export(schemas_exports, {
|
|
33
|
+
CreateSeoPatternRequest: () => CreateSeoPatternRequest,
|
|
34
|
+
CreateSeoPatternResponse: () => CreateSeoPatternResponse,
|
|
35
|
+
GetSeoPatternRequest: () => GetSeoPatternRequest,
|
|
36
|
+
GetSeoPatternResponse: () => GetSeoPatternResponse,
|
|
37
|
+
ListSeoPatternVariablesRequest: () => ListSeoPatternVariablesRequest,
|
|
38
|
+
ListSeoPatternVariablesResponse: () => ListSeoPatternVariablesResponse,
|
|
39
|
+
ListSeoPatternsRequest: () => ListSeoPatternsRequest,
|
|
40
|
+
ListSeoPatternsResponse: () => ListSeoPatternsResponse,
|
|
41
|
+
ResetSeoPatternToDefaultRequest: () => ResetSeoPatternToDefaultRequest,
|
|
42
|
+
ResetSeoPatternToDefaultResponse: () => ResetSeoPatternToDefaultResponse,
|
|
43
|
+
SetSeoPatternRequest: () => SetSeoPatternRequest,
|
|
44
|
+
SetSeoPatternResponse: () => SetSeoPatternResponse
|
|
45
|
+
});
|
|
46
|
+
module.exports = __toCommonJS(schemas_exports);
|
|
47
|
+
|
|
48
|
+
// src/promote-seo-v1-seo-pattern-seo-patterns.schemas.ts
|
|
49
|
+
var z = __toESM(require("zod"));
|
|
50
|
+
var GetSeoPatternRequest = z.object({
|
|
51
|
+
pageType: z.string().describe(
|
|
52
|
+
"Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
53
|
+
).max(100),
|
|
54
|
+
options: z.object({
|
|
55
|
+
pageId: z.string().describe(
|
|
56
|
+
"ID of a single page built from a Wix Data collection, to retrieve the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
57
|
+
).max(200).optional().nullable(),
|
|
58
|
+
collectionName: z.string().describe(
|
|
59
|
+
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
60
|
+
).max(200).optional().nullable()
|
|
61
|
+
}).optional()
|
|
62
|
+
});
|
|
63
|
+
var GetSeoPatternResponse = z.object({
|
|
64
|
+
seoPattern: z.object({
|
|
65
|
+
_id: z.string().describe(
|
|
66
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
67
|
+
).max(400).optional().nullable(),
|
|
68
|
+
pageType: z.string().describe(
|
|
69
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
70
|
+
).max(100).optional(),
|
|
71
|
+
pageId: z.string().describe(
|
|
72
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
73
|
+
).max(200).optional().nullable(),
|
|
74
|
+
pattern: z.object({
|
|
75
|
+
tags: z.array(
|
|
76
|
+
z.object({
|
|
77
|
+
type: z.string().describe(
|
|
78
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
79
|
+
).optional(),
|
|
80
|
+
props: z.record(z.string(), z.any()).describe(
|
|
81
|
+
'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"}`.'
|
|
82
|
+
).optional().nullable(),
|
|
83
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
84
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
85
|
+
).optional().nullable(),
|
|
86
|
+
children: z.string().describe(
|
|
87
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
88
|
+
).optional(),
|
|
89
|
+
custom: z.boolean().describe(
|
|
90
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
91
|
+
).optional(),
|
|
92
|
+
disabled: z.boolean().describe(
|
|
93
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
94
|
+
).optional()
|
|
95
|
+
})
|
|
96
|
+
).max(100).optional()
|
|
97
|
+
}).describe(
|
|
98
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
99
|
+
).optional(),
|
|
100
|
+
defaultPattern: z.object({
|
|
101
|
+
tags: z.array(
|
|
102
|
+
z.object({
|
|
103
|
+
type: z.string().describe(
|
|
104
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
105
|
+
).optional(),
|
|
106
|
+
props: z.record(z.string(), z.any()).describe(
|
|
107
|
+
'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"}`.'
|
|
108
|
+
).optional().nullable(),
|
|
109
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
110
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
111
|
+
).optional().nullable(),
|
|
112
|
+
children: z.string().describe(
|
|
113
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
114
|
+
).optional(),
|
|
115
|
+
custom: z.boolean().describe(
|
|
116
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
117
|
+
).optional(),
|
|
118
|
+
disabled: z.boolean().describe(
|
|
119
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
120
|
+
).optional()
|
|
121
|
+
})
|
|
122
|
+
).max(100).optional()
|
|
123
|
+
}).describe(
|
|
124
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
125
|
+
).optional(),
|
|
126
|
+
source: z.enum([
|
|
127
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
128
|
+
"PATTERN_SOURCE_USER",
|
|
129
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
130
|
+
]).describe(
|
|
131
|
+
"Which pattern is in effect for the page type: the site's own, or the Wix default."
|
|
132
|
+
).optional(),
|
|
133
|
+
language: z.string().describe(
|
|
134
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
135
|
+
).max(100).optional().nullable(),
|
|
136
|
+
origin: z.enum([
|
|
137
|
+
"ORIGIN_UNSPECIFIED",
|
|
138
|
+
"ORIGIN_USER",
|
|
139
|
+
"ORIGIN_MIGRATION",
|
|
140
|
+
"ORIGIN_AI"
|
|
141
|
+
]).describe(
|
|
142
|
+
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\n`ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.\nOrigin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns\nalways return `ORIGIN_UNSPECIFIED`."
|
|
143
|
+
).optional()
|
|
144
|
+
}).describe(
|
|
145
|
+
"The page type's pattern: the site's own pattern, the Wix default, and which of the\ntwo is in effect."
|
|
146
|
+
).optional()
|
|
147
|
+
});
|
|
148
|
+
var ListSeoPatternsRequest = z.object({});
|
|
149
|
+
var ListSeoPatternsResponse = z.object({
|
|
150
|
+
seoPatterns: z.array(
|
|
151
|
+
z.object({
|
|
152
|
+
_id: z.string().describe(
|
|
153
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
154
|
+
).max(400).optional().nullable(),
|
|
155
|
+
pageType: z.string().describe(
|
|
156
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
157
|
+
).max(100).optional(),
|
|
158
|
+
pageId: z.string().describe(
|
|
159
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
160
|
+
).max(200).optional().nullable(),
|
|
161
|
+
pattern: z.object({
|
|
162
|
+
tags: z.array(
|
|
163
|
+
z.object({
|
|
164
|
+
type: z.string().describe(
|
|
165
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
166
|
+
).optional(),
|
|
167
|
+
props: z.record(z.string(), z.any()).describe(
|
|
168
|
+
'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"}`.'
|
|
169
|
+
).optional().nullable(),
|
|
170
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
171
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
172
|
+
).optional().nullable(),
|
|
173
|
+
children: z.string().describe(
|
|
174
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
175
|
+
).optional(),
|
|
176
|
+
custom: z.boolean().describe(
|
|
177
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
178
|
+
).optional(),
|
|
179
|
+
disabled: z.boolean().describe(
|
|
180
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
181
|
+
).optional()
|
|
182
|
+
})
|
|
183
|
+
).max(100).optional()
|
|
184
|
+
}).describe(
|
|
185
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
186
|
+
).optional(),
|
|
187
|
+
defaultPattern: z.object({
|
|
188
|
+
tags: z.array(
|
|
189
|
+
z.object({
|
|
190
|
+
type: z.string().describe(
|
|
191
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
192
|
+
).optional(),
|
|
193
|
+
props: z.record(z.string(), z.any()).describe(
|
|
194
|
+
'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"}`.'
|
|
195
|
+
).optional().nullable(),
|
|
196
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
197
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
198
|
+
).optional().nullable(),
|
|
199
|
+
children: z.string().describe(
|
|
200
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
201
|
+
).optional(),
|
|
202
|
+
custom: z.boolean().describe(
|
|
203
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
204
|
+
).optional(),
|
|
205
|
+
disabled: z.boolean().describe(
|
|
206
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
207
|
+
).optional()
|
|
208
|
+
})
|
|
209
|
+
).max(100).optional()
|
|
210
|
+
}).describe(
|
|
211
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
212
|
+
).optional(),
|
|
213
|
+
source: z.enum([
|
|
214
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
215
|
+
"PATTERN_SOURCE_USER",
|
|
216
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
217
|
+
]).describe(
|
|
218
|
+
"Which pattern is in effect for the page type: the site's own, or the Wix default."
|
|
219
|
+
).optional(),
|
|
220
|
+
language: z.string().describe(
|
|
221
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
222
|
+
).max(100).optional().nullable(),
|
|
223
|
+
origin: z.enum([
|
|
224
|
+
"ORIGIN_UNSPECIFIED",
|
|
225
|
+
"ORIGIN_USER",
|
|
226
|
+
"ORIGIN_MIGRATION",
|
|
227
|
+
"ORIGIN_AI"
|
|
228
|
+
]).describe(
|
|
229
|
+
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\n`ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.\nOrigin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns\nalways return `ORIGIN_UNSPECIFIED`."
|
|
230
|
+
).optional()
|
|
231
|
+
})
|
|
232
|
+
).max(200).optional()
|
|
233
|
+
});
|
|
234
|
+
var ListSeoPatternVariablesRequest = z.object({
|
|
235
|
+
pageType: z.string().describe(
|
|
236
|
+
"Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
237
|
+
).max(100)
|
|
238
|
+
});
|
|
239
|
+
var ListSeoPatternVariablesResponse = z.object({
|
|
240
|
+
variables: z.array(
|
|
241
|
+
z.object({
|
|
242
|
+
key: z.string().describe(
|
|
243
|
+
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
244
|
+
).max(200).optional(),
|
|
245
|
+
userVisible: z.boolean().describe(
|
|
246
|
+
"Whether Wix offers this variable to site owners editing the pattern in the dashboard.\n\n`false` doesn't prevent a pattern from using the variable. It marks a variable Wix\nkeeps out of the dashboard's list, typically because it's only meaningful in specific\ncases."
|
|
247
|
+
).optional()
|
|
248
|
+
})
|
|
249
|
+
).max(500).optional(),
|
|
250
|
+
structuredDataVariables: z.array(
|
|
251
|
+
z.object({
|
|
252
|
+
key: z.string().describe(
|
|
253
|
+
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
254
|
+
).max(200).optional(),
|
|
255
|
+
userVisible: z.boolean().describe(
|
|
256
|
+
"Whether Wix offers this variable to site owners editing the pattern in the dashboard.\n\n`false` doesn't prevent a pattern from using the variable. It marks a variable Wix\nkeeps out of the dashboard's list, typically because it's only meaningful in specific\ncases."
|
|
257
|
+
).optional()
|
|
258
|
+
})
|
|
259
|
+
).max(500).optional()
|
|
260
|
+
});
|
|
261
|
+
var CreateSeoPatternRequest = z.object({
|
|
262
|
+
pageType: z.string().describe(
|
|
263
|
+
"Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
264
|
+
).max(100),
|
|
265
|
+
seoPattern: z.object({
|
|
266
|
+
_id: z.string().describe(
|
|
267
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
268
|
+
).max(400).optional().nullable(),
|
|
269
|
+
pageType: z.string().describe(
|
|
270
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
271
|
+
).max(100).optional(),
|
|
272
|
+
pageId: z.string().describe(
|
|
273
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
274
|
+
).max(200).optional().nullable(),
|
|
275
|
+
pattern: z.object({
|
|
276
|
+
tags: z.array(
|
|
277
|
+
z.object({
|
|
278
|
+
type: z.string().describe(
|
|
279
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
280
|
+
).optional(),
|
|
281
|
+
props: z.record(z.string(), z.any()).describe(
|
|
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
|
+
).optional().nullable(),
|
|
284
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
285
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
286
|
+
).optional().nullable(),
|
|
287
|
+
children: z.string().describe(
|
|
288
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
289
|
+
).optional(),
|
|
290
|
+
custom: z.boolean().describe(
|
|
291
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
292
|
+
).optional(),
|
|
293
|
+
disabled: z.boolean().describe(
|
|
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
|
+
).optional()
|
|
296
|
+
})
|
|
297
|
+
).max(100).optional()
|
|
298
|
+
}).describe(
|
|
299
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
300
|
+
).optional(),
|
|
301
|
+
defaultPattern: z.object({
|
|
302
|
+
tags: z.array(
|
|
303
|
+
z.object({
|
|
304
|
+
type: z.string().describe(
|
|
305
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
306
|
+
).optional(),
|
|
307
|
+
props: z.record(z.string(), z.any()).describe(
|
|
308
|
+
'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"}`.'
|
|
309
|
+
).optional().nullable(),
|
|
310
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
311
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
312
|
+
).optional().nullable(),
|
|
313
|
+
children: z.string().describe(
|
|
314
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
315
|
+
).optional(),
|
|
316
|
+
custom: z.boolean().describe(
|
|
317
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
318
|
+
).optional(),
|
|
319
|
+
disabled: z.boolean().describe(
|
|
320
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
321
|
+
).optional()
|
|
322
|
+
})
|
|
323
|
+
).max(100).optional()
|
|
324
|
+
}).describe(
|
|
325
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
326
|
+
).optional(),
|
|
327
|
+
source: z.enum([
|
|
328
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
329
|
+
"PATTERN_SOURCE_USER",
|
|
330
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
331
|
+
]).optional(),
|
|
332
|
+
language: z.string().describe(
|
|
333
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
334
|
+
).max(100).optional().nullable(),
|
|
335
|
+
origin: z.enum([
|
|
336
|
+
"ORIGIN_UNSPECIFIED",
|
|
337
|
+
"ORIGIN_USER",
|
|
338
|
+
"ORIGIN_MIGRATION",
|
|
339
|
+
"ORIGIN_AI"
|
|
340
|
+
]).optional()
|
|
341
|
+
}).describe(
|
|
342
|
+
"Pattern to create for the page type.\n\n`pattern` is the only field to send. The page type comes from the request path, and\nevery other field is read-only. To create a pattern for a single page built from a\nWix Data collection, set `pageId`."
|
|
343
|
+
)
|
|
344
|
+
});
|
|
345
|
+
var CreateSeoPatternResponse = z.object({
|
|
346
|
+
_id: z.string().describe(
|
|
347
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
348
|
+
).max(400).optional().nullable(),
|
|
349
|
+
pageType: z.string().describe(
|
|
350
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
351
|
+
).max(100).optional(),
|
|
352
|
+
pageId: z.string().describe(
|
|
353
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
354
|
+
).max(200).optional().nullable(),
|
|
355
|
+
pattern: z.object({
|
|
356
|
+
tags: z.array(
|
|
357
|
+
z.object({
|
|
358
|
+
type: z.string().describe(
|
|
359
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
360
|
+
).optional(),
|
|
361
|
+
props: z.record(z.string(), z.any()).describe(
|
|
362
|
+
'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"}`.'
|
|
363
|
+
).optional().nullable(),
|
|
364
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
365
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
366
|
+
).optional().nullable(),
|
|
367
|
+
children: z.string().describe(
|
|
368
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
369
|
+
).optional(),
|
|
370
|
+
custom: z.boolean().describe(
|
|
371
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
372
|
+
).optional(),
|
|
373
|
+
disabled: z.boolean().describe(
|
|
374
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
375
|
+
).optional()
|
|
376
|
+
})
|
|
377
|
+
).max(100).optional()
|
|
378
|
+
}).describe(
|
|
379
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
380
|
+
).optional(),
|
|
381
|
+
defaultPattern: z.object({
|
|
382
|
+
tags: z.array(
|
|
383
|
+
z.object({
|
|
384
|
+
type: z.string().describe(
|
|
385
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
386
|
+
).optional(),
|
|
387
|
+
props: z.record(z.string(), z.any()).describe(
|
|
388
|
+
'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"}`.'
|
|
389
|
+
).optional().nullable(),
|
|
390
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
391
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
392
|
+
).optional().nullable(),
|
|
393
|
+
children: z.string().describe(
|
|
394
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
395
|
+
).optional(),
|
|
396
|
+
custom: z.boolean().describe(
|
|
397
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
398
|
+
).optional(),
|
|
399
|
+
disabled: z.boolean().describe(
|
|
400
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
401
|
+
).optional()
|
|
402
|
+
})
|
|
403
|
+
).max(100).optional()
|
|
404
|
+
}).describe(
|
|
405
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
406
|
+
).optional(),
|
|
407
|
+
source: z.enum([
|
|
408
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
409
|
+
"PATTERN_SOURCE_USER",
|
|
410
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
411
|
+
]).describe(
|
|
412
|
+
"Which pattern is in effect for the page type: the site's own, or the Wix default."
|
|
413
|
+
).optional(),
|
|
414
|
+
language: z.string().describe(
|
|
415
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
416
|
+
).max(100).optional().nullable(),
|
|
417
|
+
origin: z.enum([
|
|
418
|
+
"ORIGIN_UNSPECIFIED",
|
|
419
|
+
"ORIGIN_USER",
|
|
420
|
+
"ORIGIN_MIGRATION",
|
|
421
|
+
"ORIGIN_AI"
|
|
422
|
+
]).describe(
|
|
423
|
+
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\n`ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.\nOrigin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns\nalways return `ORIGIN_UNSPECIFIED`."
|
|
424
|
+
).optional()
|
|
425
|
+
});
|
|
426
|
+
var SetSeoPatternRequest = z.object({
|
|
427
|
+
pageType: z.string().describe(
|
|
428
|
+
"Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
429
|
+
).max(100),
|
|
430
|
+
seoPattern: z.object({
|
|
431
|
+
_id: z.string().describe(
|
|
432
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
433
|
+
).max(400).optional().nullable(),
|
|
434
|
+
pageType: z.string().describe(
|
|
435
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
436
|
+
).max(100).optional(),
|
|
437
|
+
pageId: z.string().describe(
|
|
438
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
439
|
+
).max(200).optional().nullable(),
|
|
440
|
+
pattern: z.object({
|
|
441
|
+
tags: z.array(
|
|
442
|
+
z.object({
|
|
443
|
+
type: z.string().describe(
|
|
444
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
445
|
+
).optional(),
|
|
446
|
+
props: z.record(z.string(), z.any()).describe(
|
|
447
|
+
'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"}`.'
|
|
448
|
+
).optional().nullable(),
|
|
449
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
450
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
451
|
+
).optional().nullable(),
|
|
452
|
+
children: z.string().describe(
|
|
453
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
454
|
+
).optional(),
|
|
455
|
+
custom: z.boolean().describe(
|
|
456
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
457
|
+
).optional(),
|
|
458
|
+
disabled: z.boolean().describe(
|
|
459
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
460
|
+
).optional()
|
|
461
|
+
})
|
|
462
|
+
).max(100).optional()
|
|
463
|
+
}).describe(
|
|
464
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
465
|
+
).optional(),
|
|
466
|
+
defaultPattern: z.object({
|
|
467
|
+
tags: z.array(
|
|
468
|
+
z.object({
|
|
469
|
+
type: z.string().describe(
|
|
470
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
471
|
+
).optional(),
|
|
472
|
+
props: z.record(z.string(), z.any()).describe(
|
|
473
|
+
'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"}`.'
|
|
474
|
+
).optional().nullable(),
|
|
475
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
476
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
477
|
+
).optional().nullable(),
|
|
478
|
+
children: z.string().describe(
|
|
479
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
480
|
+
).optional(),
|
|
481
|
+
custom: z.boolean().describe(
|
|
482
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
483
|
+
).optional(),
|
|
484
|
+
disabled: z.boolean().describe(
|
|
485
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
486
|
+
).optional()
|
|
487
|
+
})
|
|
488
|
+
).max(100).optional()
|
|
489
|
+
}).describe(
|
|
490
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
491
|
+
).optional(),
|
|
492
|
+
source: z.enum([
|
|
493
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
494
|
+
"PATTERN_SOURCE_USER",
|
|
495
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
496
|
+
]).optional(),
|
|
497
|
+
language: z.string().describe(
|
|
498
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
499
|
+
).max(100).optional().nullable(),
|
|
500
|
+
origin: z.enum([
|
|
501
|
+
"ORIGIN_UNSPECIFIED",
|
|
502
|
+
"ORIGIN_USER",
|
|
503
|
+
"ORIGIN_MIGRATION",
|
|
504
|
+
"ORIGIN_AI"
|
|
505
|
+
]).optional()
|
|
506
|
+
}).describe(
|
|
507
|
+
"Pattern to set for the page type.\n\n`pattern` is the only writable field, and setting it replaces the page type's tag\ntemplates in full. Sending an empty pattern clears it, which returns the page type to\nits Wix default."
|
|
508
|
+
),
|
|
509
|
+
options: z.object({
|
|
510
|
+
fieldMask: z.object({ paths: z.array(z.string()) }).describe(
|
|
511
|
+
"Fields to update.\n\nRequired, and must name only writable fields. An empty field mask, an unknown field,\nor a read-only field fails with `INVALID_FIELD_MASK`."
|
|
512
|
+
),
|
|
513
|
+
collectionName: z.string().describe(
|
|
514
|
+
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
515
|
+
).max(200).optional().nullable(),
|
|
516
|
+
pageId: z.string().describe(
|
|
517
|
+
"ID of a single page built from a Wix Data collection, to change the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
518
|
+
).max(200).optional().nullable()
|
|
519
|
+
})
|
|
520
|
+
});
|
|
521
|
+
var SetSeoPatternResponse = z.object({
|
|
522
|
+
seoPattern: z.object({
|
|
523
|
+
_id: z.string().describe(
|
|
524
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
525
|
+
).max(400).optional().nullable(),
|
|
526
|
+
pageType: z.string().describe(
|
|
527
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
528
|
+
).max(100).optional(),
|
|
529
|
+
pageId: z.string().describe(
|
|
530
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
531
|
+
).max(200).optional().nullable(),
|
|
532
|
+
pattern: z.object({
|
|
533
|
+
tags: z.array(
|
|
534
|
+
z.object({
|
|
535
|
+
type: z.string().describe(
|
|
536
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
537
|
+
).optional(),
|
|
538
|
+
props: z.record(z.string(), z.any()).describe(
|
|
539
|
+
'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"}`.'
|
|
540
|
+
).optional().nullable(),
|
|
541
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
542
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
543
|
+
).optional().nullable(),
|
|
544
|
+
children: z.string().describe(
|
|
545
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
546
|
+
).optional(),
|
|
547
|
+
custom: z.boolean().describe(
|
|
548
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
549
|
+
).optional(),
|
|
550
|
+
disabled: z.boolean().describe(
|
|
551
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
552
|
+
).optional()
|
|
553
|
+
})
|
|
554
|
+
).max(100).optional()
|
|
555
|
+
}).describe(
|
|
556
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
557
|
+
).optional(),
|
|
558
|
+
defaultPattern: z.object({
|
|
559
|
+
tags: z.array(
|
|
560
|
+
z.object({
|
|
561
|
+
type: z.string().describe(
|
|
562
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
563
|
+
).optional(),
|
|
564
|
+
props: z.record(z.string(), z.any()).describe(
|
|
565
|
+
'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"}`.'
|
|
566
|
+
).optional().nullable(),
|
|
567
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
568
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
569
|
+
).optional().nullable(),
|
|
570
|
+
children: z.string().describe(
|
|
571
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
572
|
+
).optional(),
|
|
573
|
+
custom: z.boolean().describe(
|
|
574
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
575
|
+
).optional(),
|
|
576
|
+
disabled: z.boolean().describe(
|
|
577
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
578
|
+
).optional()
|
|
579
|
+
})
|
|
580
|
+
).max(100).optional()
|
|
581
|
+
}).describe(
|
|
582
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
583
|
+
).optional(),
|
|
584
|
+
source: z.enum([
|
|
585
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
586
|
+
"PATTERN_SOURCE_USER",
|
|
587
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
588
|
+
]).describe(
|
|
589
|
+
"Which pattern is in effect for the page type: the site's own, or the Wix default."
|
|
590
|
+
).optional(),
|
|
591
|
+
language: z.string().describe(
|
|
592
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
593
|
+
).max(100).optional().nullable(),
|
|
594
|
+
origin: z.enum([
|
|
595
|
+
"ORIGIN_UNSPECIFIED",
|
|
596
|
+
"ORIGIN_USER",
|
|
597
|
+
"ORIGIN_MIGRATION",
|
|
598
|
+
"ORIGIN_AI"
|
|
599
|
+
]).describe(
|
|
600
|
+
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\n`ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.\nOrigin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns\nalways return `ORIGIN_UNSPECIFIED`."
|
|
601
|
+
).optional()
|
|
602
|
+
}).describe("The updated pattern.").optional()
|
|
603
|
+
});
|
|
604
|
+
var ResetSeoPatternToDefaultRequest = z.object({
|
|
605
|
+
pageType: z.string().describe(
|
|
606
|
+
"Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
607
|
+
).max(100),
|
|
608
|
+
options: z.object({
|
|
609
|
+
collectionName: z.string().describe(
|
|
610
|
+
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
611
|
+
).max(200).optional().nullable(),
|
|
612
|
+
pageId: z.string().describe(
|
|
613
|
+
"ID of a single page built from a Wix Data collection, to reset the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
614
|
+
).max(200).optional().nullable()
|
|
615
|
+
}).optional()
|
|
616
|
+
});
|
|
617
|
+
var ResetSeoPatternToDefaultResponse = z.object({
|
|
618
|
+
seoPattern: z.object({
|
|
619
|
+
_id: z.string().describe(
|
|
620
|
+
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
621
|
+
).max(400).optional().nullable(),
|
|
622
|
+
pageType: z.string().describe(
|
|
623
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`.\n\nCalling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,\nand the error lists the page types that are supported. For a page type provided by a\nWix app, such as `BLOG_POST`, the app must be installed on the site.\n\nPage types aren't the same set as the item types of the Item SEO Tags API: a page\ntype can support a pattern without supporting tags set per item, and the other way\nround."
|
|
624
|
+
).max(100).optional(),
|
|
625
|
+
pageId: z.string().describe(
|
|
626
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one\npattern for the type, and passing a page ID for one of those fails with\n`PAGE_ID_NOT_SUPPORTED`."
|
|
627
|
+
).max(200).optional().nullable(),
|
|
628
|
+
pattern: z.object({
|
|
629
|
+
tags: z.array(
|
|
630
|
+
z.object({
|
|
631
|
+
type: z.string().describe(
|
|
632
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
633
|
+
).optional(),
|
|
634
|
+
props: z.record(z.string(), z.any()).describe(
|
|
635
|
+
'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"}`.'
|
|
636
|
+
).optional().nullable(),
|
|
637
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
638
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
639
|
+
).optional().nullable(),
|
|
640
|
+
children: z.string().describe(
|
|
641
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
642
|
+
).optional(),
|
|
643
|
+
custom: z.boolean().describe(
|
|
644
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
645
|
+
).optional(),
|
|
646
|
+
disabled: z.boolean().describe(
|
|
647
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
648
|
+
).optional()
|
|
649
|
+
})
|
|
650
|
+
).max(100).optional()
|
|
651
|
+
}).describe(
|
|
652
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies. Setting this field replaces the pattern in full, so send the complete set of\ntag templates you want the page type to have."
|
|
653
|
+
).optional(),
|
|
654
|
+
defaultPattern: z.object({
|
|
655
|
+
tags: z.array(
|
|
656
|
+
z.object({
|
|
657
|
+
type: z.string().describe(
|
|
658
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
659
|
+
).optional(),
|
|
660
|
+
props: z.record(z.string(), z.any()).describe(
|
|
661
|
+
'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"}`.'
|
|
662
|
+
).optional().nullable(),
|
|
663
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
664
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
665
|
+
).optional().nullable(),
|
|
666
|
+
children: z.string().describe(
|
|
667
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
668
|
+
).optional(),
|
|
669
|
+
custom: z.boolean().describe(
|
|
670
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
671
|
+
).optional(),
|
|
672
|
+
disabled: z.boolean().describe(
|
|
673
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
674
|
+
).optional()
|
|
675
|
+
})
|
|
676
|
+
).max(100).optional()
|
|
677
|
+
}).describe(
|
|
678
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can compare a customized pattern with the one it started\nfrom, and see what a reset would restore."
|
|
679
|
+
).optional(),
|
|
680
|
+
source: z.enum([
|
|
681
|
+
"PATTERN_SOURCE_UNSPECIFIED",
|
|
682
|
+
"PATTERN_SOURCE_USER",
|
|
683
|
+
"PATTERN_SOURCE_DEFAULT"
|
|
684
|
+
]).describe(
|
|
685
|
+
"Which pattern is in effect for the page type: the site's own, or the Wix default."
|
|
686
|
+
).optional(),
|
|
687
|
+
language: z.string().describe(
|
|
688
|
+
"Language the pattern applies to, as an IETF BCP 47 language tag. For example,\n`en-US` for U.S. English.\n\nA page type has a single pattern, so this reports the site's primary language."
|
|
689
|
+
).max(100).optional().nullable(),
|
|
690
|
+
origin: z.enum([
|
|
691
|
+
"ORIGIN_UNSPECIFIED",
|
|
692
|
+
"ORIGIN_USER",
|
|
693
|
+
"ORIGIN_MIGRATION",
|
|
694
|
+
"ORIGIN_AI"
|
|
695
|
+
]).describe(
|
|
696
|
+
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\n`ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.\nOrigin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns\nalways return `ORIGIN_UNSPECIFIED`."
|
|
697
|
+
).optional()
|
|
698
|
+
}).describe(
|
|
699
|
+
"The page type after the reset: an empty `pattern`, and `source` of\n`PATTERN_SOURCE_DEFAULT`."
|
|
700
|
+
).optional()
|
|
701
|
+
});
|
|
702
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
703
|
+
0 && (module.exports = {
|
|
704
|
+
CreateSeoPatternRequest,
|
|
705
|
+
CreateSeoPatternResponse,
|
|
706
|
+
GetSeoPatternRequest,
|
|
707
|
+
GetSeoPatternResponse,
|
|
708
|
+
ListSeoPatternVariablesRequest,
|
|
709
|
+
ListSeoPatternVariablesResponse,
|
|
710
|
+
ListSeoPatternsRequest,
|
|
711
|
+
ListSeoPatternsResponse,
|
|
712
|
+
ResetSeoPatternToDefaultRequest,
|
|
713
|
+
ResetSeoPatternToDefaultResponse,
|
|
714
|
+
SetSeoPatternRequest,
|
|
715
|
+
SetSeoPatternResponse
|
|
716
|
+
});
|
|
717
|
+
//# sourceMappingURL=schemas.js.map
|