@wix/auto_sdk_portfolio_projects 1.0.49 → 1.0.50
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.js +1 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4 -2
- package/build/cjs/index.typings.js +1 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +4 -2
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +1172 -0
- package/build/cjs/schemas.js +1951 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.mjs +1 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +4 -2
- package/build/es/index.typings.mjs +1 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +4 -2
- package/build/es/meta.mjs +1 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +1172 -0
- package/build/es/schemas.mjs +1897 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.js +1 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +4 -2
- package/build/internal/cjs/index.typings.js +1 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +4 -2
- package/build/internal/cjs/meta.js +1 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +1172 -0
- package/build/internal/cjs/schemas.js +1951 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.mjs +1 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +4 -2
- package/build/internal/es/index.typings.mjs +1 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +4 -2
- package/build/internal/es/meta.mjs +1 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +1172 -0
- package/build/internal/es/schemas.mjs +1897 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/package.json +12 -5
- package/schemas/package.json +3 -0
|
@@ -0,0 +1,1897 @@
|
|
|
1
|
+
// src/portfolio-projects-v1-project-projects.schemas.ts
|
|
2
|
+
import * as z from "zod";
|
|
3
|
+
var CreateProjectRequest = z.object({
|
|
4
|
+
project: z.intersection(
|
|
5
|
+
z.object({
|
|
6
|
+
_id: z.string().describe("Project ID.").regex(
|
|
7
|
+
/^[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}$/,
|
|
8
|
+
"Must be a valid GUID"
|
|
9
|
+
).optional().nullable(),
|
|
10
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
11
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
12
|
+
).optional().nullable(),
|
|
13
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
14
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
15
|
+
hidden: z.boolean().describe(
|
|
16
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
17
|
+
).optional().nullable(),
|
|
18
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
19
|
+
details: z.array(
|
|
20
|
+
z.intersection(
|
|
21
|
+
z.object({
|
|
22
|
+
label: z.string().describe("Project label.").optional()
|
|
23
|
+
}),
|
|
24
|
+
z.xor([
|
|
25
|
+
z.object({
|
|
26
|
+
text: z.never().optional(),
|
|
27
|
+
link: z.never().optional()
|
|
28
|
+
}),
|
|
29
|
+
z.object({
|
|
30
|
+
link: z.never().optional(),
|
|
31
|
+
text: z.string().describe("Project label in plain text format.")
|
|
32
|
+
}),
|
|
33
|
+
z.object({
|
|
34
|
+
text: z.never().optional(),
|
|
35
|
+
link: z.object({
|
|
36
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
37
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
38
|
+
target: z.string().describe(
|
|
39
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
40
|
+
).optional().nullable()
|
|
41
|
+
}).describe("Project label in link format.")
|
|
42
|
+
})
|
|
43
|
+
])
|
|
44
|
+
)
|
|
45
|
+
).optional(),
|
|
46
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
47
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
48
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
49
|
+
url: z.string().describe(
|
|
50
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
51
|
+
).optional(),
|
|
52
|
+
seoData: z.object({
|
|
53
|
+
tags: z.array(
|
|
54
|
+
z.object({
|
|
55
|
+
type: z.string().describe(
|
|
56
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
57
|
+
).optional(),
|
|
58
|
+
props: z.record(z.string(), z.any()).describe(
|
|
59
|
+
'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"}`.'
|
|
60
|
+
).optional().nullable(),
|
|
61
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
62
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
63
|
+
).optional().nullable(),
|
|
64
|
+
children: z.string().describe(
|
|
65
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
66
|
+
).optional(),
|
|
67
|
+
custom: z.boolean().describe(
|
|
68
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
69
|
+
).optional(),
|
|
70
|
+
disabled: z.boolean().describe(
|
|
71
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
72
|
+
).optional()
|
|
73
|
+
})
|
|
74
|
+
).optional(),
|
|
75
|
+
settings: z.object({
|
|
76
|
+
preventAutoRedirect: z.boolean().describe(
|
|
77
|
+
"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)."
|
|
78
|
+
).optional(),
|
|
79
|
+
keywords: z.array(
|
|
80
|
+
z.object({
|
|
81
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
82
|
+
isMain: z.boolean().describe(
|
|
83
|
+
"Whether the keyword is the main focus keyword."
|
|
84
|
+
).optional(),
|
|
85
|
+
origin: z.string().describe(
|
|
86
|
+
"The source that added the keyword terms to the SEO settings."
|
|
87
|
+
).max(1e3).optional().nullable()
|
|
88
|
+
})
|
|
89
|
+
).max(5).optional()
|
|
90
|
+
}).describe("SEO general settings.").optional()
|
|
91
|
+
}).describe("Project SEO data.").optional(),
|
|
92
|
+
watermark: z.object({
|
|
93
|
+
position: z.enum([
|
|
94
|
+
"NORTH_WEST",
|
|
95
|
+
"NORTH",
|
|
96
|
+
"NORTH_EAST",
|
|
97
|
+
"WEST",
|
|
98
|
+
"CENTER",
|
|
99
|
+
"EAST",
|
|
100
|
+
"SOUTH_WEST",
|
|
101
|
+
"SOUTH",
|
|
102
|
+
"SOUTH_EAST"
|
|
103
|
+
]).optional(),
|
|
104
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
105
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
106
|
+
imageUrl: z.string().describe("Image ID of the Watermark as saved in Media Platform.").max(300).optional(),
|
|
107
|
+
enabled: z.boolean().describe(
|
|
108
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
109
|
+
).optional()
|
|
110
|
+
}).describe(
|
|
111
|
+
"Optional watermark that can be applied to all project's images."
|
|
112
|
+
).optional()
|
|
113
|
+
}),
|
|
114
|
+
z.xor([
|
|
115
|
+
z.object({
|
|
116
|
+
coverImage: z.never().optional(),
|
|
117
|
+
coverVideo: z.never().optional()
|
|
118
|
+
}),
|
|
119
|
+
z.object({
|
|
120
|
+
coverVideo: z.never().optional(),
|
|
121
|
+
coverImage: z.object({
|
|
122
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
123
|
+
focalPoint: z.object({
|
|
124
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
125
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
126
|
+
}).describe("Focal point of the image.").optional()
|
|
127
|
+
}).describe("Project cover image.")
|
|
128
|
+
}),
|
|
129
|
+
z.object({
|
|
130
|
+
coverImage: z.never().optional(),
|
|
131
|
+
coverVideo: z.object({
|
|
132
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
133
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
134
|
+
}).describe("Project cover video.")
|
|
135
|
+
})
|
|
136
|
+
])
|
|
137
|
+
).describe("Project to create.")
|
|
138
|
+
});
|
|
139
|
+
var CreateProjectResponse = z.intersection(
|
|
140
|
+
z.object({
|
|
141
|
+
_id: z.string().describe("Project ID.").regex(
|
|
142
|
+
/^[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}$/,
|
|
143
|
+
"Must be a valid GUID"
|
|
144
|
+
).optional().nullable(),
|
|
145
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
146
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
147
|
+
).optional().nullable(),
|
|
148
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
149
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
150
|
+
hidden: z.boolean().describe(
|
|
151
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
152
|
+
).optional().nullable(),
|
|
153
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
154
|
+
details: z.array(
|
|
155
|
+
z.intersection(
|
|
156
|
+
z.object({ label: z.string().describe("Project label.").optional() }),
|
|
157
|
+
z.xor([
|
|
158
|
+
z.object({
|
|
159
|
+
text: z.never().optional(),
|
|
160
|
+
link: z.never().optional()
|
|
161
|
+
}),
|
|
162
|
+
z.object({
|
|
163
|
+
link: z.never().optional(),
|
|
164
|
+
text: z.string().describe("Project label in plain text format.")
|
|
165
|
+
}),
|
|
166
|
+
z.object({
|
|
167
|
+
text: z.never().optional(),
|
|
168
|
+
link: z.object({
|
|
169
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
170
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
171
|
+
target: z.string().describe(
|
|
172
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
173
|
+
).optional().nullable()
|
|
174
|
+
}).describe("Project label in link format.")
|
|
175
|
+
})
|
|
176
|
+
])
|
|
177
|
+
)
|
|
178
|
+
).optional(),
|
|
179
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
180
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
181
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
182
|
+
url: z.string().describe(
|
|
183
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
184
|
+
).optional(),
|
|
185
|
+
seoData: z.object({
|
|
186
|
+
tags: z.array(
|
|
187
|
+
z.object({
|
|
188
|
+
type: z.string().describe(
|
|
189
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
190
|
+
).optional(),
|
|
191
|
+
props: z.record(z.string(), z.any()).describe(
|
|
192
|
+
'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"}`.'
|
|
193
|
+
).optional().nullable(),
|
|
194
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
195
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
196
|
+
).optional().nullable(),
|
|
197
|
+
children: z.string().describe(
|
|
198
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
199
|
+
).optional(),
|
|
200
|
+
custom: z.boolean().describe(
|
|
201
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
202
|
+
).optional(),
|
|
203
|
+
disabled: z.boolean().describe(
|
|
204
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
205
|
+
).optional()
|
|
206
|
+
})
|
|
207
|
+
).optional(),
|
|
208
|
+
settings: z.object({
|
|
209
|
+
preventAutoRedirect: z.boolean().describe(
|
|
210
|
+
"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)."
|
|
211
|
+
).optional(),
|
|
212
|
+
keywords: z.array(
|
|
213
|
+
z.object({
|
|
214
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
215
|
+
isMain: z.boolean().describe("Whether the keyword is the main focus keyword.").optional(),
|
|
216
|
+
origin: z.string().describe(
|
|
217
|
+
"The source that added the keyword terms to the SEO settings."
|
|
218
|
+
).max(1e3).optional().nullable()
|
|
219
|
+
})
|
|
220
|
+
).max(5).optional()
|
|
221
|
+
}).describe("SEO general settings.").optional()
|
|
222
|
+
}).describe("Project SEO data.").optional(),
|
|
223
|
+
watermark: z.object({
|
|
224
|
+
position: z.enum([
|
|
225
|
+
"NORTH_WEST",
|
|
226
|
+
"NORTH",
|
|
227
|
+
"NORTH_EAST",
|
|
228
|
+
"WEST",
|
|
229
|
+
"CENTER",
|
|
230
|
+
"EAST",
|
|
231
|
+
"SOUTH_WEST",
|
|
232
|
+
"SOUTH",
|
|
233
|
+
"SOUTH_EAST"
|
|
234
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
235
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
236
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
237
|
+
imageUrl: z.string().describe("Image ID of the Watermark as saved in Media Platform.").max(300).optional(),
|
|
238
|
+
enabled: z.boolean().describe(
|
|
239
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
240
|
+
).optional()
|
|
241
|
+
}).describe(
|
|
242
|
+
"Optional watermark that can be applied to all project's images."
|
|
243
|
+
).optional()
|
|
244
|
+
}),
|
|
245
|
+
z.xor([
|
|
246
|
+
z.object({
|
|
247
|
+
coverImage: z.never().optional(),
|
|
248
|
+
coverVideo: z.never().optional()
|
|
249
|
+
}),
|
|
250
|
+
z.object({
|
|
251
|
+
coverVideo: z.never().optional(),
|
|
252
|
+
coverImage: z.object({
|
|
253
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
254
|
+
focalPoint: z.object({
|
|
255
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
256
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
257
|
+
}).describe("Focal point of the image.").optional()
|
|
258
|
+
}).describe("Project cover image.")
|
|
259
|
+
}),
|
|
260
|
+
z.object({
|
|
261
|
+
coverImage: z.never().optional(),
|
|
262
|
+
coverVideo: z.object({
|
|
263
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
264
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
265
|
+
}).describe("Project cover video.")
|
|
266
|
+
})
|
|
267
|
+
])
|
|
268
|
+
);
|
|
269
|
+
var GetProjectRequest = z.object({
|
|
270
|
+
projectId: z.string().describe("ID of the project to retrieve.").regex(
|
|
271
|
+
/^[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}$/,
|
|
272
|
+
"Must be a valid GUID"
|
|
273
|
+
),
|
|
274
|
+
options: z.object({
|
|
275
|
+
includePageUrl: z.boolean().describe(
|
|
276
|
+
"Whether to include the project's relative path and full URL in the response. Default: `false`"
|
|
277
|
+
).optional().nullable()
|
|
278
|
+
}).optional()
|
|
279
|
+
});
|
|
280
|
+
var GetProjectResponse = z.intersection(
|
|
281
|
+
z.object({
|
|
282
|
+
_id: z.string().describe("Project ID.").regex(
|
|
283
|
+
/^[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}$/,
|
|
284
|
+
"Must be a valid GUID"
|
|
285
|
+
).optional().nullable(),
|
|
286
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
287
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
288
|
+
).optional().nullable(),
|
|
289
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
290
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
291
|
+
hidden: z.boolean().describe(
|
|
292
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
293
|
+
).optional().nullable(),
|
|
294
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
295
|
+
details: z.array(
|
|
296
|
+
z.intersection(
|
|
297
|
+
z.object({ label: z.string().describe("Project label.").optional() }),
|
|
298
|
+
z.xor([
|
|
299
|
+
z.object({
|
|
300
|
+
text: z.never().optional(),
|
|
301
|
+
link: z.never().optional()
|
|
302
|
+
}),
|
|
303
|
+
z.object({
|
|
304
|
+
link: z.never().optional(),
|
|
305
|
+
text: z.string().describe("Project label in plain text format.")
|
|
306
|
+
}),
|
|
307
|
+
z.object({
|
|
308
|
+
text: z.never().optional(),
|
|
309
|
+
link: z.object({
|
|
310
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
311
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
312
|
+
target: z.string().describe(
|
|
313
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
314
|
+
).optional().nullable()
|
|
315
|
+
}).describe("Project label in link format.")
|
|
316
|
+
})
|
|
317
|
+
])
|
|
318
|
+
)
|
|
319
|
+
).optional(),
|
|
320
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
321
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
322
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
323
|
+
url: z.string().describe(
|
|
324
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
325
|
+
).optional(),
|
|
326
|
+
seoData: z.object({
|
|
327
|
+
tags: z.array(
|
|
328
|
+
z.object({
|
|
329
|
+
type: z.string().describe(
|
|
330
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
331
|
+
).optional(),
|
|
332
|
+
props: z.record(z.string(), z.any()).describe(
|
|
333
|
+
'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"}`.'
|
|
334
|
+
).optional().nullable(),
|
|
335
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
336
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
337
|
+
).optional().nullable(),
|
|
338
|
+
children: z.string().describe(
|
|
339
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
340
|
+
).optional(),
|
|
341
|
+
custom: z.boolean().describe(
|
|
342
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
343
|
+
).optional(),
|
|
344
|
+
disabled: z.boolean().describe(
|
|
345
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
346
|
+
).optional()
|
|
347
|
+
})
|
|
348
|
+
).optional(),
|
|
349
|
+
settings: z.object({
|
|
350
|
+
preventAutoRedirect: z.boolean().describe(
|
|
351
|
+
"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)."
|
|
352
|
+
).optional(),
|
|
353
|
+
keywords: z.array(
|
|
354
|
+
z.object({
|
|
355
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
356
|
+
isMain: z.boolean().describe("Whether the keyword is the main focus keyword.").optional(),
|
|
357
|
+
origin: z.string().describe(
|
|
358
|
+
"The source that added the keyword terms to the SEO settings."
|
|
359
|
+
).max(1e3).optional().nullable()
|
|
360
|
+
})
|
|
361
|
+
).max(5).optional()
|
|
362
|
+
}).describe("SEO general settings.").optional()
|
|
363
|
+
}).describe("Project SEO data.").optional(),
|
|
364
|
+
watermark: z.object({
|
|
365
|
+
position: z.enum([
|
|
366
|
+
"NORTH_WEST",
|
|
367
|
+
"NORTH",
|
|
368
|
+
"NORTH_EAST",
|
|
369
|
+
"WEST",
|
|
370
|
+
"CENTER",
|
|
371
|
+
"EAST",
|
|
372
|
+
"SOUTH_WEST",
|
|
373
|
+
"SOUTH",
|
|
374
|
+
"SOUTH_EAST"
|
|
375
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
376
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
377
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
378
|
+
imageUrl: z.string().describe("Image ID of the Watermark as saved in Media Platform.").max(300).optional(),
|
|
379
|
+
enabled: z.boolean().describe(
|
|
380
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
381
|
+
).optional()
|
|
382
|
+
}).describe(
|
|
383
|
+
"Optional watermark that can be applied to all project's images."
|
|
384
|
+
).optional()
|
|
385
|
+
}),
|
|
386
|
+
z.xor([
|
|
387
|
+
z.object({
|
|
388
|
+
coverImage: z.never().optional(),
|
|
389
|
+
coverVideo: z.never().optional()
|
|
390
|
+
}),
|
|
391
|
+
z.object({
|
|
392
|
+
coverVideo: z.never().optional(),
|
|
393
|
+
coverImage: z.object({
|
|
394
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
395
|
+
focalPoint: z.object({
|
|
396
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
397
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
398
|
+
}).describe("Focal point of the image.").optional()
|
|
399
|
+
}).describe("Project cover image.")
|
|
400
|
+
}),
|
|
401
|
+
z.object({
|
|
402
|
+
coverImage: z.never().optional(),
|
|
403
|
+
coverVideo: z.object({
|
|
404
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
405
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
406
|
+
}).describe("Project cover video.")
|
|
407
|
+
})
|
|
408
|
+
])
|
|
409
|
+
);
|
|
410
|
+
var ListProjectsRequest = z.object({
|
|
411
|
+
options: z.object({
|
|
412
|
+
paging: z.object({
|
|
413
|
+
limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
|
|
414
|
+
cursor: z.string().describe(
|
|
415
|
+
"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
|
|
416
|
+
).max(16e3).optional().nullable()
|
|
417
|
+
}).describe(
|
|
418
|
+
"Projects limit per response is maximum 100, In the first request the cursor is None ?"
|
|
419
|
+
).optional(),
|
|
420
|
+
includePageUrl: z.boolean().describe(
|
|
421
|
+
"Whether to include the project's relative path and full URL in the response. Default: `false`"
|
|
422
|
+
).optional().nullable()
|
|
423
|
+
}).optional()
|
|
424
|
+
});
|
|
425
|
+
var ListProjectsResponse = z.object({
|
|
426
|
+
projects: z.array(
|
|
427
|
+
z.intersection(
|
|
428
|
+
z.object({
|
|
429
|
+
_id: z.string().describe("Project ID.").regex(
|
|
430
|
+
/^[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}$/,
|
|
431
|
+
"Must be a valid GUID"
|
|
432
|
+
).optional().nullable(),
|
|
433
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
434
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
435
|
+
).optional().nullable(),
|
|
436
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
437
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
438
|
+
hidden: z.boolean().describe(
|
|
439
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
440
|
+
).optional().nullable(),
|
|
441
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
442
|
+
details: z.array(
|
|
443
|
+
z.intersection(
|
|
444
|
+
z.object({
|
|
445
|
+
label: z.string().describe("Project label.").optional()
|
|
446
|
+
}),
|
|
447
|
+
z.xor([
|
|
448
|
+
z.object({
|
|
449
|
+
text: z.never().optional(),
|
|
450
|
+
link: z.never().optional()
|
|
451
|
+
}),
|
|
452
|
+
z.object({
|
|
453
|
+
link: z.never().optional(),
|
|
454
|
+
text: z.string().describe("Project label in plain text format.")
|
|
455
|
+
}),
|
|
456
|
+
z.object({
|
|
457
|
+
text: z.never().optional(),
|
|
458
|
+
link: z.object({
|
|
459
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
460
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
461
|
+
target: z.string().describe(
|
|
462
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
463
|
+
).optional().nullable()
|
|
464
|
+
}).describe("Project label in link format.")
|
|
465
|
+
})
|
|
466
|
+
])
|
|
467
|
+
)
|
|
468
|
+
).optional(),
|
|
469
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
470
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
471
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
472
|
+
url: z.string().describe(
|
|
473
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
474
|
+
).optional(),
|
|
475
|
+
seoData: z.object({
|
|
476
|
+
tags: z.array(
|
|
477
|
+
z.object({
|
|
478
|
+
type: z.string().describe(
|
|
479
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
480
|
+
).optional(),
|
|
481
|
+
props: z.record(z.string(), z.any()).describe(
|
|
482
|
+
'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"}`.'
|
|
483
|
+
).optional().nullable(),
|
|
484
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
485
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
486
|
+
).optional().nullable(),
|
|
487
|
+
children: z.string().describe(
|
|
488
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
489
|
+
).optional(),
|
|
490
|
+
custom: z.boolean().describe(
|
|
491
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
492
|
+
).optional(),
|
|
493
|
+
disabled: z.boolean().describe(
|
|
494
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
495
|
+
).optional()
|
|
496
|
+
})
|
|
497
|
+
).optional(),
|
|
498
|
+
settings: z.object({
|
|
499
|
+
preventAutoRedirect: z.boolean().describe(
|
|
500
|
+
"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)."
|
|
501
|
+
).optional(),
|
|
502
|
+
keywords: z.array(
|
|
503
|
+
z.object({
|
|
504
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
505
|
+
isMain: z.boolean().describe(
|
|
506
|
+
"Whether the keyword is the main focus keyword."
|
|
507
|
+
).optional(),
|
|
508
|
+
origin: z.string().describe(
|
|
509
|
+
"The source that added the keyword terms to the SEO settings."
|
|
510
|
+
).max(1e3).optional().nullable()
|
|
511
|
+
})
|
|
512
|
+
).max(5).optional()
|
|
513
|
+
}).describe("SEO general settings.").optional()
|
|
514
|
+
}).describe("Project SEO data.").optional(),
|
|
515
|
+
watermark: z.object({
|
|
516
|
+
position: z.enum([
|
|
517
|
+
"NORTH_WEST",
|
|
518
|
+
"NORTH",
|
|
519
|
+
"NORTH_EAST",
|
|
520
|
+
"WEST",
|
|
521
|
+
"CENTER",
|
|
522
|
+
"EAST",
|
|
523
|
+
"SOUTH_WEST",
|
|
524
|
+
"SOUTH",
|
|
525
|
+
"SOUTH_EAST"
|
|
526
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
527
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
528
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
529
|
+
imageUrl: z.string().describe(
|
|
530
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
531
|
+
).max(300).optional(),
|
|
532
|
+
enabled: z.boolean().describe(
|
|
533
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
534
|
+
).optional()
|
|
535
|
+
}).describe(
|
|
536
|
+
"Optional watermark that can be applied to all project's images."
|
|
537
|
+
).optional()
|
|
538
|
+
}),
|
|
539
|
+
z.xor([
|
|
540
|
+
z.object({
|
|
541
|
+
coverImage: z.never().optional(),
|
|
542
|
+
coverVideo: z.never().optional()
|
|
543
|
+
}),
|
|
544
|
+
z.object({
|
|
545
|
+
coverVideo: z.never().optional(),
|
|
546
|
+
coverImage: z.object({
|
|
547
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
548
|
+
focalPoint: z.object({
|
|
549
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
550
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
551
|
+
}).describe("Focal point of the image.").optional()
|
|
552
|
+
}).describe("Project cover image.")
|
|
553
|
+
}),
|
|
554
|
+
z.object({
|
|
555
|
+
coverImage: z.never().optional(),
|
|
556
|
+
coverVideo: z.object({
|
|
557
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
558
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
559
|
+
}).describe("Project cover video.")
|
|
560
|
+
})
|
|
561
|
+
])
|
|
562
|
+
)
|
|
563
|
+
).optional(),
|
|
564
|
+
metadata: z.object({
|
|
565
|
+
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
566
|
+
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
567
|
+
total: z.number().int().describe(
|
|
568
|
+
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
569
|
+
).optional().nullable(),
|
|
570
|
+
tooManyToCount: z.boolean().describe(
|
|
571
|
+
"Flag that indicates the server failed to calculate the `total` field."
|
|
572
|
+
).optional().nullable(),
|
|
573
|
+
cursors: z.object({
|
|
574
|
+
next: z.string().describe(
|
|
575
|
+
"Cursor string pointing to the next page in the list of results."
|
|
576
|
+
).max(16e3).optional().nullable(),
|
|
577
|
+
prev: z.string().describe(
|
|
578
|
+
"Cursor pointing to the previous page in the list of results."
|
|
579
|
+
).max(16e3).optional().nullable()
|
|
580
|
+
}).describe(
|
|
581
|
+
"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."
|
|
582
|
+
).optional()
|
|
583
|
+
}).describe("Paging metadata.").optional()
|
|
584
|
+
});
|
|
585
|
+
var UpdateProjectRequest = z.object({
|
|
586
|
+
_id: z.string().describe("Project ID.").regex(
|
|
587
|
+
/^[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}$/,
|
|
588
|
+
"Must be a valid GUID"
|
|
589
|
+
),
|
|
590
|
+
project: z.intersection(
|
|
591
|
+
z.object({
|
|
592
|
+
_id: z.string().describe("Project ID.").regex(
|
|
593
|
+
/^[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}$/,
|
|
594
|
+
"Must be a valid GUID"
|
|
595
|
+
).optional().nullable(),
|
|
596
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
597
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
598
|
+
),
|
|
599
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
600
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
601
|
+
hidden: z.boolean().describe(
|
|
602
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
603
|
+
).optional().nullable(),
|
|
604
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
605
|
+
details: z.array(
|
|
606
|
+
z.intersection(
|
|
607
|
+
z.object({
|
|
608
|
+
label: z.string().describe("Project label.").optional()
|
|
609
|
+
}),
|
|
610
|
+
z.xor([
|
|
611
|
+
z.object({
|
|
612
|
+
text: z.never().optional(),
|
|
613
|
+
link: z.never().optional()
|
|
614
|
+
}),
|
|
615
|
+
z.object({
|
|
616
|
+
link: z.never().optional(),
|
|
617
|
+
text: z.string().describe("Project label in plain text format.")
|
|
618
|
+
}),
|
|
619
|
+
z.object({
|
|
620
|
+
text: z.never().optional(),
|
|
621
|
+
link: z.object({
|
|
622
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
623
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
624
|
+
target: z.string().describe(
|
|
625
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
626
|
+
).optional().nullable()
|
|
627
|
+
}).describe("Project label in link format.")
|
|
628
|
+
})
|
|
629
|
+
])
|
|
630
|
+
)
|
|
631
|
+
).optional(),
|
|
632
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
633
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
634
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
635
|
+
url: z.string().describe(
|
|
636
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
637
|
+
).optional(),
|
|
638
|
+
seoData: z.object({
|
|
639
|
+
tags: z.array(
|
|
640
|
+
z.object({
|
|
641
|
+
type: z.string().describe(
|
|
642
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
643
|
+
).optional(),
|
|
644
|
+
props: z.record(z.string(), z.any()).describe(
|
|
645
|
+
'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"}`.'
|
|
646
|
+
).optional().nullable(),
|
|
647
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
648
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
649
|
+
).optional().nullable(),
|
|
650
|
+
children: z.string().describe(
|
|
651
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
652
|
+
).optional(),
|
|
653
|
+
custom: z.boolean().describe(
|
|
654
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
655
|
+
).optional(),
|
|
656
|
+
disabled: z.boolean().describe(
|
|
657
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
658
|
+
).optional()
|
|
659
|
+
})
|
|
660
|
+
).optional(),
|
|
661
|
+
settings: z.object({
|
|
662
|
+
preventAutoRedirect: z.boolean().describe(
|
|
663
|
+
"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)."
|
|
664
|
+
).optional(),
|
|
665
|
+
keywords: z.array(
|
|
666
|
+
z.object({
|
|
667
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
668
|
+
isMain: z.boolean().describe(
|
|
669
|
+
"Whether the keyword is the main focus keyword."
|
|
670
|
+
).optional(),
|
|
671
|
+
origin: z.string().describe(
|
|
672
|
+
"The source that added the keyword terms to the SEO settings."
|
|
673
|
+
).max(1e3).optional().nullable()
|
|
674
|
+
})
|
|
675
|
+
).max(5).optional()
|
|
676
|
+
}).describe("SEO general settings.").optional()
|
|
677
|
+
}).describe("Project SEO data.").optional(),
|
|
678
|
+
watermark: z.object({
|
|
679
|
+
position: z.enum([
|
|
680
|
+
"NORTH_WEST",
|
|
681
|
+
"NORTH",
|
|
682
|
+
"NORTH_EAST",
|
|
683
|
+
"WEST",
|
|
684
|
+
"CENTER",
|
|
685
|
+
"EAST",
|
|
686
|
+
"SOUTH_WEST",
|
|
687
|
+
"SOUTH",
|
|
688
|
+
"SOUTH_EAST"
|
|
689
|
+
]).optional(),
|
|
690
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
691
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
692
|
+
imageUrl: z.string().describe("Image ID of the Watermark as saved in Media Platform.").max(300).optional(),
|
|
693
|
+
enabled: z.boolean().describe(
|
|
694
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
695
|
+
).optional()
|
|
696
|
+
}).describe(
|
|
697
|
+
"Optional watermark that can be applied to all project's images."
|
|
698
|
+
).optional()
|
|
699
|
+
}),
|
|
700
|
+
z.xor([
|
|
701
|
+
z.object({
|
|
702
|
+
coverImage: z.never().optional(),
|
|
703
|
+
coverVideo: z.never().optional()
|
|
704
|
+
}),
|
|
705
|
+
z.object({
|
|
706
|
+
coverVideo: z.never().optional(),
|
|
707
|
+
coverImage: z.object({
|
|
708
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
709
|
+
focalPoint: z.object({
|
|
710
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
711
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
712
|
+
}).describe("Focal point of the image.").optional()
|
|
713
|
+
}).describe("Project cover image.")
|
|
714
|
+
}),
|
|
715
|
+
z.object({
|
|
716
|
+
coverImage: z.never().optional(),
|
|
717
|
+
coverVideo: z.object({
|
|
718
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
719
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
720
|
+
}).describe("Project cover video.")
|
|
721
|
+
})
|
|
722
|
+
])
|
|
723
|
+
).describe("Project to update.")
|
|
724
|
+
});
|
|
725
|
+
var UpdateProjectResponse = z.intersection(
|
|
726
|
+
z.object({
|
|
727
|
+
_id: z.string().describe("Project ID.").regex(
|
|
728
|
+
/^[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}$/,
|
|
729
|
+
"Must be a valid GUID"
|
|
730
|
+
).optional().nullable(),
|
|
731
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
732
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
733
|
+
).optional().nullable(),
|
|
734
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
735
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
736
|
+
hidden: z.boolean().describe(
|
|
737
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
738
|
+
).optional().nullable(),
|
|
739
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
740
|
+
details: z.array(
|
|
741
|
+
z.intersection(
|
|
742
|
+
z.object({ label: z.string().describe("Project label.").optional() }),
|
|
743
|
+
z.xor([
|
|
744
|
+
z.object({
|
|
745
|
+
text: z.never().optional(),
|
|
746
|
+
link: z.never().optional()
|
|
747
|
+
}),
|
|
748
|
+
z.object({
|
|
749
|
+
link: z.never().optional(),
|
|
750
|
+
text: z.string().describe("Project label in plain text format.")
|
|
751
|
+
}),
|
|
752
|
+
z.object({
|
|
753
|
+
text: z.never().optional(),
|
|
754
|
+
link: z.object({
|
|
755
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
756
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
757
|
+
target: z.string().describe(
|
|
758
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
759
|
+
).optional().nullable()
|
|
760
|
+
}).describe("Project label in link format.")
|
|
761
|
+
})
|
|
762
|
+
])
|
|
763
|
+
)
|
|
764
|
+
).optional(),
|
|
765
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
766
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
767
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
768
|
+
url: z.string().describe(
|
|
769
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
770
|
+
).optional(),
|
|
771
|
+
seoData: z.object({
|
|
772
|
+
tags: z.array(
|
|
773
|
+
z.object({
|
|
774
|
+
type: z.string().describe(
|
|
775
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
776
|
+
).optional(),
|
|
777
|
+
props: z.record(z.string(), z.any()).describe(
|
|
778
|
+
'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"}`.'
|
|
779
|
+
).optional().nullable(),
|
|
780
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
781
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
782
|
+
).optional().nullable(),
|
|
783
|
+
children: z.string().describe(
|
|
784
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
785
|
+
).optional(),
|
|
786
|
+
custom: z.boolean().describe(
|
|
787
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
788
|
+
).optional(),
|
|
789
|
+
disabled: z.boolean().describe(
|
|
790
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
791
|
+
).optional()
|
|
792
|
+
})
|
|
793
|
+
).optional(),
|
|
794
|
+
settings: z.object({
|
|
795
|
+
preventAutoRedirect: z.boolean().describe(
|
|
796
|
+
"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)."
|
|
797
|
+
).optional(),
|
|
798
|
+
keywords: z.array(
|
|
799
|
+
z.object({
|
|
800
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
801
|
+
isMain: z.boolean().describe("Whether the keyword is the main focus keyword.").optional(),
|
|
802
|
+
origin: z.string().describe(
|
|
803
|
+
"The source that added the keyword terms to the SEO settings."
|
|
804
|
+
).max(1e3).optional().nullable()
|
|
805
|
+
})
|
|
806
|
+
).max(5).optional()
|
|
807
|
+
}).describe("SEO general settings.").optional()
|
|
808
|
+
}).describe("Project SEO data.").optional(),
|
|
809
|
+
watermark: z.object({
|
|
810
|
+
position: z.enum([
|
|
811
|
+
"NORTH_WEST",
|
|
812
|
+
"NORTH",
|
|
813
|
+
"NORTH_EAST",
|
|
814
|
+
"WEST",
|
|
815
|
+
"CENTER",
|
|
816
|
+
"EAST",
|
|
817
|
+
"SOUTH_WEST",
|
|
818
|
+
"SOUTH",
|
|
819
|
+
"SOUTH_EAST"
|
|
820
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
821
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
822
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
823
|
+
imageUrl: z.string().describe("Image ID of the Watermark as saved in Media Platform.").max(300).optional(),
|
|
824
|
+
enabled: z.boolean().describe(
|
|
825
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
826
|
+
).optional()
|
|
827
|
+
}).describe(
|
|
828
|
+
"Optional watermark that can be applied to all project's images."
|
|
829
|
+
).optional()
|
|
830
|
+
}),
|
|
831
|
+
z.xor([
|
|
832
|
+
z.object({
|
|
833
|
+
coverImage: z.never().optional(),
|
|
834
|
+
coverVideo: z.never().optional()
|
|
835
|
+
}),
|
|
836
|
+
z.object({
|
|
837
|
+
coverVideo: z.never().optional(),
|
|
838
|
+
coverImage: z.object({
|
|
839
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
840
|
+
focalPoint: z.object({
|
|
841
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
842
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
843
|
+
}).describe("Focal point of the image.").optional()
|
|
844
|
+
}).describe("Project cover image.")
|
|
845
|
+
}),
|
|
846
|
+
z.object({
|
|
847
|
+
coverImage: z.never().optional(),
|
|
848
|
+
coverVideo: z.object({
|
|
849
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
850
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
851
|
+
}).describe("Project cover video.")
|
|
852
|
+
})
|
|
853
|
+
])
|
|
854
|
+
);
|
|
855
|
+
var BulkUpdateProjectsRequest = z.object({
|
|
856
|
+
options: z.object({
|
|
857
|
+
projects: z.array(
|
|
858
|
+
z.object({
|
|
859
|
+
project: z.intersection(
|
|
860
|
+
z.object({
|
|
861
|
+
_id: z.string().describe("Project ID.").regex(
|
|
862
|
+
/^[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}$/,
|
|
863
|
+
"Must be a valid GUID"
|
|
864
|
+
),
|
|
865
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
866
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
867
|
+
),
|
|
868
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
869
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
870
|
+
hidden: z.boolean().describe(
|
|
871
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
872
|
+
).optional().nullable(),
|
|
873
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
874
|
+
details: z.array(
|
|
875
|
+
z.intersection(
|
|
876
|
+
z.object({
|
|
877
|
+
label: z.string().describe("Project label.").optional()
|
|
878
|
+
}),
|
|
879
|
+
z.xor([
|
|
880
|
+
z.object({
|
|
881
|
+
text: z.never().optional(),
|
|
882
|
+
link: z.never().optional()
|
|
883
|
+
}),
|
|
884
|
+
z.object({
|
|
885
|
+
link: z.never().optional(),
|
|
886
|
+
text: z.string().describe("Project label in plain text format.")
|
|
887
|
+
}),
|
|
888
|
+
z.object({
|
|
889
|
+
text: z.never().optional(),
|
|
890
|
+
link: z.object({
|
|
891
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
892
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
893
|
+
target: z.string().describe(
|
|
894
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
895
|
+
).optional().nullable()
|
|
896
|
+
}).describe("Project label in link format.")
|
|
897
|
+
})
|
|
898
|
+
])
|
|
899
|
+
)
|
|
900
|
+
).optional(),
|
|
901
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
902
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
903
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
904
|
+
url: z.string().describe(
|
|
905
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
906
|
+
).optional(),
|
|
907
|
+
seoData: z.object({
|
|
908
|
+
tags: z.array(
|
|
909
|
+
z.object({
|
|
910
|
+
type: z.string().describe(
|
|
911
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
912
|
+
).optional(),
|
|
913
|
+
props: z.record(z.string(), z.any()).describe(
|
|
914
|
+
'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"}`.'
|
|
915
|
+
).optional().nullable(),
|
|
916
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
917
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
918
|
+
).optional().nullable(),
|
|
919
|
+
children: z.string().describe(
|
|
920
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
921
|
+
).optional(),
|
|
922
|
+
custom: z.boolean().describe(
|
|
923
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
924
|
+
).optional(),
|
|
925
|
+
disabled: z.boolean().describe(
|
|
926
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
927
|
+
).optional()
|
|
928
|
+
})
|
|
929
|
+
).optional(),
|
|
930
|
+
settings: z.object({
|
|
931
|
+
preventAutoRedirect: z.boolean().describe(
|
|
932
|
+
"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)."
|
|
933
|
+
).optional(),
|
|
934
|
+
keywords: z.array(
|
|
935
|
+
z.object({
|
|
936
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
937
|
+
isMain: z.boolean().describe(
|
|
938
|
+
"Whether the keyword is the main focus keyword."
|
|
939
|
+
).optional(),
|
|
940
|
+
origin: z.string().describe(
|
|
941
|
+
"The source that added the keyword terms to the SEO settings."
|
|
942
|
+
).max(1e3).optional().nullable()
|
|
943
|
+
})
|
|
944
|
+
).max(5).optional()
|
|
945
|
+
}).describe("SEO general settings.").optional()
|
|
946
|
+
}).describe("Project SEO data.").optional(),
|
|
947
|
+
watermark: z.object({
|
|
948
|
+
position: z.enum([
|
|
949
|
+
"NORTH_WEST",
|
|
950
|
+
"NORTH",
|
|
951
|
+
"NORTH_EAST",
|
|
952
|
+
"WEST",
|
|
953
|
+
"CENTER",
|
|
954
|
+
"EAST",
|
|
955
|
+
"SOUTH_WEST",
|
|
956
|
+
"SOUTH",
|
|
957
|
+
"SOUTH_EAST"
|
|
958
|
+
]).optional(),
|
|
959
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
960
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
961
|
+
imageUrl: z.string().describe(
|
|
962
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
963
|
+
).max(300).optional(),
|
|
964
|
+
enabled: z.boolean().describe(
|
|
965
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
966
|
+
).optional()
|
|
967
|
+
}).describe(
|
|
968
|
+
"Optional watermark that can be applied to all project's images."
|
|
969
|
+
).optional()
|
|
970
|
+
}),
|
|
971
|
+
z.xor([
|
|
972
|
+
z.object({
|
|
973
|
+
coverImage: z.never().optional(),
|
|
974
|
+
coverVideo: z.never().optional()
|
|
975
|
+
}),
|
|
976
|
+
z.object({
|
|
977
|
+
coverVideo: z.never().optional(),
|
|
978
|
+
coverImage: z.object({
|
|
979
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
980
|
+
focalPoint: z.object({
|
|
981
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
982
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
983
|
+
}).describe("Focal point of the image.").optional()
|
|
984
|
+
}).describe("Project cover image.")
|
|
985
|
+
}),
|
|
986
|
+
z.object({
|
|
987
|
+
coverImage: z.never().optional(),
|
|
988
|
+
coverVideo: z.object({
|
|
989
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
990
|
+
durationInMillis: z.number().int().describe(
|
|
991
|
+
"Manually defined Video duration in milliseconds."
|
|
992
|
+
).optional().nullable()
|
|
993
|
+
}).describe("Project cover video.")
|
|
994
|
+
})
|
|
995
|
+
])
|
|
996
|
+
).describe("Project to update.")
|
|
997
|
+
})
|
|
998
|
+
).max(100).optional(),
|
|
999
|
+
returnFullEntity: z.boolean().describe(
|
|
1000
|
+
"Whether to return the updated projects.\n\nSet to `true` to return the projects in the response.\n\nDefault: `false`"
|
|
1001
|
+
).optional().nullable()
|
|
1002
|
+
}).optional()
|
|
1003
|
+
});
|
|
1004
|
+
var BulkUpdateProjectsResponse = z.object({
|
|
1005
|
+
results: z.array(
|
|
1006
|
+
z.object({
|
|
1007
|
+
itemMetadata: z.object({
|
|
1008
|
+
_id: z.string().describe(
|
|
1009
|
+
"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
|
|
1010
|
+
).optional().nullable(),
|
|
1011
|
+
originalIndex: z.number().int().describe(
|
|
1012
|
+
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
1013
|
+
).optional(),
|
|
1014
|
+
success: z.boolean().describe(
|
|
1015
|
+
"Whether the requested action was successful for this item. When `false`, the `error` field is populated."
|
|
1016
|
+
).optional(),
|
|
1017
|
+
error: z.object({
|
|
1018
|
+
code: z.string().describe("Error code.").optional(),
|
|
1019
|
+
description: z.string().describe("Description of the error.").optional(),
|
|
1020
|
+
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
1021
|
+
}).describe("Details about the error in case of failure.").optional()
|
|
1022
|
+
}).describe(
|
|
1023
|
+
"Information about the updated project.\nIncluding its ID, index in the bulk request and whether it was successfully updated."
|
|
1024
|
+
).optional(),
|
|
1025
|
+
project: z.intersection(
|
|
1026
|
+
z.object({
|
|
1027
|
+
_id: z.string().describe("Project ID.").regex(
|
|
1028
|
+
/^[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}$/,
|
|
1029
|
+
"Must be a valid GUID"
|
|
1030
|
+
).optional().nullable(),
|
|
1031
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
1032
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
1033
|
+
).optional().nullable(),
|
|
1034
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
1035
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
1036
|
+
hidden: z.boolean().describe(
|
|
1037
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
1038
|
+
).optional().nullable(),
|
|
1039
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
1040
|
+
details: z.array(
|
|
1041
|
+
z.intersection(
|
|
1042
|
+
z.object({
|
|
1043
|
+
label: z.string().describe("Project label.").optional()
|
|
1044
|
+
}),
|
|
1045
|
+
z.xor([
|
|
1046
|
+
z.object({
|
|
1047
|
+
text: z.never().optional(),
|
|
1048
|
+
link: z.never().optional()
|
|
1049
|
+
}),
|
|
1050
|
+
z.object({
|
|
1051
|
+
link: z.never().optional(),
|
|
1052
|
+
text: z.string().describe("Project label in plain text format.")
|
|
1053
|
+
}),
|
|
1054
|
+
z.object({
|
|
1055
|
+
text: z.never().optional(),
|
|
1056
|
+
link: z.object({
|
|
1057
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
1058
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
1059
|
+
target: z.string().describe(
|
|
1060
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
1061
|
+
).optional().nullable()
|
|
1062
|
+
}).describe("Project label in link format.")
|
|
1063
|
+
})
|
|
1064
|
+
])
|
|
1065
|
+
)
|
|
1066
|
+
).optional(),
|
|
1067
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
1068
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
1069
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
1070
|
+
url: z.string().describe(
|
|
1071
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
1072
|
+
).optional(),
|
|
1073
|
+
seoData: z.object({
|
|
1074
|
+
tags: z.array(
|
|
1075
|
+
z.object({
|
|
1076
|
+
type: z.string().describe(
|
|
1077
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
1078
|
+
).optional(),
|
|
1079
|
+
props: z.record(z.string(), z.any()).describe(
|
|
1080
|
+
'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"}`.'
|
|
1081
|
+
).optional().nullable(),
|
|
1082
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
1083
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1084
|
+
).optional().nullable(),
|
|
1085
|
+
children: z.string().describe(
|
|
1086
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1087
|
+
).optional(),
|
|
1088
|
+
custom: z.boolean().describe(
|
|
1089
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
1090
|
+
).optional(),
|
|
1091
|
+
disabled: z.boolean().describe(
|
|
1092
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1093
|
+
).optional()
|
|
1094
|
+
})
|
|
1095
|
+
).optional(),
|
|
1096
|
+
settings: z.object({
|
|
1097
|
+
preventAutoRedirect: z.boolean().describe(
|
|
1098
|
+
"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)."
|
|
1099
|
+
).optional(),
|
|
1100
|
+
keywords: z.array(
|
|
1101
|
+
z.object({
|
|
1102
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
1103
|
+
isMain: z.boolean().describe(
|
|
1104
|
+
"Whether the keyword is the main focus keyword."
|
|
1105
|
+
).optional(),
|
|
1106
|
+
origin: z.string().describe(
|
|
1107
|
+
"The source that added the keyword terms to the SEO settings."
|
|
1108
|
+
).max(1e3).optional().nullable()
|
|
1109
|
+
})
|
|
1110
|
+
).max(5).optional()
|
|
1111
|
+
}).describe("SEO general settings.").optional()
|
|
1112
|
+
}).describe("Project SEO data.").optional(),
|
|
1113
|
+
watermark: z.object({
|
|
1114
|
+
position: z.enum([
|
|
1115
|
+
"NORTH_WEST",
|
|
1116
|
+
"NORTH",
|
|
1117
|
+
"NORTH_EAST",
|
|
1118
|
+
"WEST",
|
|
1119
|
+
"CENTER",
|
|
1120
|
+
"EAST",
|
|
1121
|
+
"SOUTH_WEST",
|
|
1122
|
+
"SOUTH",
|
|
1123
|
+
"SOUTH_EAST"
|
|
1124
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
1125
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
1126
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
1127
|
+
imageUrl: z.string().describe(
|
|
1128
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
1129
|
+
).max(300).optional(),
|
|
1130
|
+
enabled: z.boolean().describe(
|
|
1131
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
1132
|
+
).optional()
|
|
1133
|
+
}).describe(
|
|
1134
|
+
"Optional watermark that can be applied to all project's images."
|
|
1135
|
+
).optional()
|
|
1136
|
+
}),
|
|
1137
|
+
z.xor([
|
|
1138
|
+
z.object({
|
|
1139
|
+
coverImage: z.never().optional(),
|
|
1140
|
+
coverVideo: z.never().optional()
|
|
1141
|
+
}),
|
|
1142
|
+
z.object({
|
|
1143
|
+
coverVideo: z.never().optional(),
|
|
1144
|
+
coverImage: z.object({
|
|
1145
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
1146
|
+
focalPoint: z.object({
|
|
1147
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
1148
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
1149
|
+
}).describe("Focal point of the image.").optional()
|
|
1150
|
+
}).describe("Project cover image.")
|
|
1151
|
+
}),
|
|
1152
|
+
z.object({
|
|
1153
|
+
coverImage: z.never().optional(),
|
|
1154
|
+
coverVideo: z.object({
|
|
1155
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
1156
|
+
durationInMillis: z.number().int().describe(
|
|
1157
|
+
"Manually defined Video duration in milliseconds."
|
|
1158
|
+
).optional().nullable()
|
|
1159
|
+
}).describe("Project cover video.")
|
|
1160
|
+
})
|
|
1161
|
+
])
|
|
1162
|
+
).describe(
|
|
1163
|
+
"Updated project. Only returned if `returnEntity` is set to `true` in the request."
|
|
1164
|
+
).optional()
|
|
1165
|
+
})
|
|
1166
|
+
).optional(),
|
|
1167
|
+
bulkActionMetadata: z.object({
|
|
1168
|
+
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
|
|
1169
|
+
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
|
|
1170
|
+
undetailedFailures: z.number().int().describe(
|
|
1171
|
+
"Number of failures without details because detailed failure threshold was exceeded."
|
|
1172
|
+
).optional()
|
|
1173
|
+
}).describe(
|
|
1174
|
+
"Total number of successes and failures for Bulk Update Projects."
|
|
1175
|
+
).optional()
|
|
1176
|
+
});
|
|
1177
|
+
var DeleteProjectRequest = z.object({
|
|
1178
|
+
projectId: z.string().describe("ID of the project to delete.").regex(
|
|
1179
|
+
/^[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}$/,
|
|
1180
|
+
"Must be a valid GUID"
|
|
1181
|
+
)
|
|
1182
|
+
});
|
|
1183
|
+
var DeleteProjectResponse = z.object({
|
|
1184
|
+
projectId: z.string().describe("ID of the deleted project.").regex(
|
|
1185
|
+
/^[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}$/,
|
|
1186
|
+
"Must be a valid GUID"
|
|
1187
|
+
).optional()
|
|
1188
|
+
});
|
|
1189
|
+
var QueryProjectsRequest = z.object({
|
|
1190
|
+
query: z.object({
|
|
1191
|
+
filter: z.object({
|
|
1192
|
+
_id: z.object({
|
|
1193
|
+
$eq: z.string(),
|
|
1194
|
+
$exists: z.boolean(),
|
|
1195
|
+
$gt: z.string(),
|
|
1196
|
+
$gte: z.string(),
|
|
1197
|
+
$hasAll: z.array(z.string()),
|
|
1198
|
+
$hasSome: z.array(z.string()),
|
|
1199
|
+
$in: z.array(z.string()),
|
|
1200
|
+
$lt: z.string(),
|
|
1201
|
+
$lte: z.string(),
|
|
1202
|
+
$ne: z.string(),
|
|
1203
|
+
$nin: z.array(z.string()),
|
|
1204
|
+
$startsWith: z.string()
|
|
1205
|
+
}).partial().strict().optional(),
|
|
1206
|
+
title: z.object({
|
|
1207
|
+
$eq: z.string(),
|
|
1208
|
+
$exists: z.boolean(),
|
|
1209
|
+
$gt: z.string(),
|
|
1210
|
+
$gte: z.string(),
|
|
1211
|
+
$hasAll: z.array(z.string()),
|
|
1212
|
+
$hasSome: z.array(z.string()),
|
|
1213
|
+
$in: z.array(z.string()),
|
|
1214
|
+
$lt: z.string(),
|
|
1215
|
+
$lte: z.string(),
|
|
1216
|
+
$ne: z.string(),
|
|
1217
|
+
$nin: z.array(z.string()),
|
|
1218
|
+
$startsWith: z.string()
|
|
1219
|
+
}).partial().strict().optional(),
|
|
1220
|
+
description: z.object({
|
|
1221
|
+
$eq: z.string(),
|
|
1222
|
+
$exists: z.boolean(),
|
|
1223
|
+
$gt: z.string(),
|
|
1224
|
+
$gte: z.string(),
|
|
1225
|
+
$hasAll: z.array(z.string()),
|
|
1226
|
+
$hasSome: z.array(z.string()),
|
|
1227
|
+
$in: z.array(z.string()),
|
|
1228
|
+
$lt: z.string(),
|
|
1229
|
+
$lte: z.string(),
|
|
1230
|
+
$ne: z.string(),
|
|
1231
|
+
$nin: z.array(z.string()),
|
|
1232
|
+
$startsWith: z.string()
|
|
1233
|
+
}).partial().strict().optional(),
|
|
1234
|
+
slug: z.object({
|
|
1235
|
+
$eq: z.string(),
|
|
1236
|
+
$exists: z.boolean(),
|
|
1237
|
+
$gt: z.string(),
|
|
1238
|
+
$gte: z.string(),
|
|
1239
|
+
$hasAll: z.array(z.string()),
|
|
1240
|
+
$hasSome: z.array(z.string()),
|
|
1241
|
+
$in: z.array(z.string()),
|
|
1242
|
+
$lt: z.string(),
|
|
1243
|
+
$lte: z.string(),
|
|
1244
|
+
$ne: z.string(),
|
|
1245
|
+
$nin: z.array(z.string()),
|
|
1246
|
+
$startsWith: z.string()
|
|
1247
|
+
}).partial().strict().optional(),
|
|
1248
|
+
collectionIds: z.object({
|
|
1249
|
+
$eq: z.string(),
|
|
1250
|
+
$exists: z.boolean(),
|
|
1251
|
+
$gt: z.string(),
|
|
1252
|
+
$gte: z.string(),
|
|
1253
|
+
$hasAll: z.array(z.string()),
|
|
1254
|
+
$hasSome: z.array(z.string()),
|
|
1255
|
+
$in: z.array(z.string()),
|
|
1256
|
+
$lt: z.string(),
|
|
1257
|
+
$lte: z.string(),
|
|
1258
|
+
$ne: z.string(),
|
|
1259
|
+
$nin: z.array(z.string()),
|
|
1260
|
+
$startsWith: z.string()
|
|
1261
|
+
}).partial().strict().optional(),
|
|
1262
|
+
hidden: z.object({
|
|
1263
|
+
$eq: z.boolean(),
|
|
1264
|
+
$exists: z.boolean(),
|
|
1265
|
+
$gt: z.boolean(),
|
|
1266
|
+
$gte: z.boolean(),
|
|
1267
|
+
$hasAll: z.array(z.boolean()),
|
|
1268
|
+
$hasSome: z.array(z.boolean()),
|
|
1269
|
+
$in: z.array(z.boolean()),
|
|
1270
|
+
$lt: z.boolean(),
|
|
1271
|
+
$lte: z.boolean(),
|
|
1272
|
+
$ne: z.boolean(),
|
|
1273
|
+
$nin: z.array(z.boolean()),
|
|
1274
|
+
$startsWith: z.string()
|
|
1275
|
+
}).partial().strict().optional(),
|
|
1276
|
+
_createdDate: z.object({
|
|
1277
|
+
$eq: z.string(),
|
|
1278
|
+
$exists: z.boolean(),
|
|
1279
|
+
$gt: z.string(),
|
|
1280
|
+
$gte: z.string(),
|
|
1281
|
+
$hasAll: z.array(z.string()),
|
|
1282
|
+
$hasSome: z.array(z.string()),
|
|
1283
|
+
$in: z.array(z.string()),
|
|
1284
|
+
$lt: z.string(),
|
|
1285
|
+
$lte: z.string(),
|
|
1286
|
+
$ne: z.string(),
|
|
1287
|
+
$nin: z.array(z.string()),
|
|
1288
|
+
$startsWith: z.string()
|
|
1289
|
+
}).partial().strict().optional(),
|
|
1290
|
+
_updatedDate: z.object({
|
|
1291
|
+
$eq: z.string(),
|
|
1292
|
+
$exists: z.boolean(),
|
|
1293
|
+
$gt: z.string(),
|
|
1294
|
+
$gte: z.string(),
|
|
1295
|
+
$hasAll: z.array(z.string()),
|
|
1296
|
+
$hasSome: z.array(z.string()),
|
|
1297
|
+
$in: z.array(z.string()),
|
|
1298
|
+
$lt: z.string(),
|
|
1299
|
+
$lte: z.string(),
|
|
1300
|
+
$ne: z.string(),
|
|
1301
|
+
$nin: z.array(z.string()),
|
|
1302
|
+
$startsWith: z.string()
|
|
1303
|
+
}).partial().strict().optional(),
|
|
1304
|
+
$and: z.array(z.any()).optional(),
|
|
1305
|
+
$or: z.array(z.any()).optional(),
|
|
1306
|
+
$not: z.any().optional()
|
|
1307
|
+
}).strict().optional(),
|
|
1308
|
+
sort: z.array(
|
|
1309
|
+
z.object({
|
|
1310
|
+
fieldName: z.enum([
|
|
1311
|
+
"_id",
|
|
1312
|
+
"title",
|
|
1313
|
+
"description",
|
|
1314
|
+
"slug",
|
|
1315
|
+
"_createdDate",
|
|
1316
|
+
"_updatedDate"
|
|
1317
|
+
]).optional(),
|
|
1318
|
+
order: z.enum(["ASC", "DESC"]).optional()
|
|
1319
|
+
})
|
|
1320
|
+
).optional()
|
|
1321
|
+
}).catchall(z.any()).describe("Query options."),
|
|
1322
|
+
options: z.object({
|
|
1323
|
+
includePageUrl: z.boolean().describe(
|
|
1324
|
+
"Whether to include the project's relative path and full URL in the response. Default: `false`"
|
|
1325
|
+
).optional().nullable()
|
|
1326
|
+
}).optional()
|
|
1327
|
+
});
|
|
1328
|
+
var QueryProjectsResponse = z.object({
|
|
1329
|
+
projects: z.array(
|
|
1330
|
+
z.intersection(
|
|
1331
|
+
z.object({
|
|
1332
|
+
_id: z.string().describe("Project ID.").regex(
|
|
1333
|
+
/^[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}$/,
|
|
1334
|
+
"Must be a valid GUID"
|
|
1335
|
+
).optional().nullable(),
|
|
1336
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
1337
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
1338
|
+
).optional().nullable(),
|
|
1339
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
1340
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
1341
|
+
hidden: z.boolean().describe(
|
|
1342
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
1343
|
+
).optional().nullable(),
|
|
1344
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
1345
|
+
details: z.array(
|
|
1346
|
+
z.intersection(
|
|
1347
|
+
z.object({
|
|
1348
|
+
label: z.string().describe("Project label.").optional()
|
|
1349
|
+
}),
|
|
1350
|
+
z.xor([
|
|
1351
|
+
z.object({
|
|
1352
|
+
text: z.never().optional(),
|
|
1353
|
+
link: z.never().optional()
|
|
1354
|
+
}),
|
|
1355
|
+
z.object({
|
|
1356
|
+
link: z.never().optional(),
|
|
1357
|
+
text: z.string().describe("Project label in plain text format.")
|
|
1358
|
+
}),
|
|
1359
|
+
z.object({
|
|
1360
|
+
text: z.never().optional(),
|
|
1361
|
+
link: z.object({
|
|
1362
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
1363
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
1364
|
+
target: z.string().describe(
|
|
1365
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
1366
|
+
).optional().nullable()
|
|
1367
|
+
}).describe("Project label in link format.")
|
|
1368
|
+
})
|
|
1369
|
+
])
|
|
1370
|
+
)
|
|
1371
|
+
).optional(),
|
|
1372
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
1373
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
1374
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
1375
|
+
url: z.string().describe(
|
|
1376
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
1377
|
+
).optional(),
|
|
1378
|
+
seoData: z.object({
|
|
1379
|
+
tags: z.array(
|
|
1380
|
+
z.object({
|
|
1381
|
+
type: z.string().describe(
|
|
1382
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
1383
|
+
).optional(),
|
|
1384
|
+
props: z.record(z.string(), z.any()).describe(
|
|
1385
|
+
'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"}`.'
|
|
1386
|
+
).optional().nullable(),
|
|
1387
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
1388
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1389
|
+
).optional().nullable(),
|
|
1390
|
+
children: z.string().describe(
|
|
1391
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1392
|
+
).optional(),
|
|
1393
|
+
custom: z.boolean().describe(
|
|
1394
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
1395
|
+
).optional(),
|
|
1396
|
+
disabled: z.boolean().describe(
|
|
1397
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1398
|
+
).optional()
|
|
1399
|
+
})
|
|
1400
|
+
).optional(),
|
|
1401
|
+
settings: z.object({
|
|
1402
|
+
preventAutoRedirect: z.boolean().describe(
|
|
1403
|
+
"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)."
|
|
1404
|
+
).optional(),
|
|
1405
|
+
keywords: z.array(
|
|
1406
|
+
z.object({
|
|
1407
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
1408
|
+
isMain: z.boolean().describe(
|
|
1409
|
+
"Whether the keyword is the main focus keyword."
|
|
1410
|
+
).optional(),
|
|
1411
|
+
origin: z.string().describe(
|
|
1412
|
+
"The source that added the keyword terms to the SEO settings."
|
|
1413
|
+
).max(1e3).optional().nullable()
|
|
1414
|
+
})
|
|
1415
|
+
).max(5).optional()
|
|
1416
|
+
}).describe("SEO general settings.").optional()
|
|
1417
|
+
}).describe("Project SEO data.").optional(),
|
|
1418
|
+
watermark: z.object({
|
|
1419
|
+
position: z.enum([
|
|
1420
|
+
"NORTH_WEST",
|
|
1421
|
+
"NORTH",
|
|
1422
|
+
"NORTH_EAST",
|
|
1423
|
+
"WEST",
|
|
1424
|
+
"CENTER",
|
|
1425
|
+
"EAST",
|
|
1426
|
+
"SOUTH_WEST",
|
|
1427
|
+
"SOUTH",
|
|
1428
|
+
"SOUTH_EAST"
|
|
1429
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
1430
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
1431
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
1432
|
+
imageUrl: z.string().describe(
|
|
1433
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
1434
|
+
).max(300).optional(),
|
|
1435
|
+
enabled: z.boolean().describe(
|
|
1436
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
1437
|
+
).optional()
|
|
1438
|
+
}).describe(
|
|
1439
|
+
"Optional watermark that can be applied to all project's images."
|
|
1440
|
+
).optional()
|
|
1441
|
+
}),
|
|
1442
|
+
z.xor([
|
|
1443
|
+
z.object({
|
|
1444
|
+
coverImage: z.never().optional(),
|
|
1445
|
+
coverVideo: z.never().optional()
|
|
1446
|
+
}),
|
|
1447
|
+
z.object({
|
|
1448
|
+
coverVideo: z.never().optional(),
|
|
1449
|
+
coverImage: z.object({
|
|
1450
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
1451
|
+
focalPoint: z.object({
|
|
1452
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
1453
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
1454
|
+
}).describe("Focal point of the image.").optional()
|
|
1455
|
+
}).describe("Project cover image.")
|
|
1456
|
+
}),
|
|
1457
|
+
z.object({
|
|
1458
|
+
coverImage: z.never().optional(),
|
|
1459
|
+
coverVideo: z.object({
|
|
1460
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
1461
|
+
durationInMillis: z.number().int().describe("Manually defined Video duration in milliseconds.").optional().nullable()
|
|
1462
|
+
}).describe("Project cover video.")
|
|
1463
|
+
})
|
|
1464
|
+
])
|
|
1465
|
+
)
|
|
1466
|
+
).optional(),
|
|
1467
|
+
metadata: z.object({
|
|
1468
|
+
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1469
|
+
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1470
|
+
total: z.number().int().describe(
|
|
1471
|
+
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
1472
|
+
).optional().nullable(),
|
|
1473
|
+
tooManyToCount: z.boolean().describe(
|
|
1474
|
+
"Flag that indicates the server failed to calculate the `total` field."
|
|
1475
|
+
).optional().nullable(),
|
|
1476
|
+
cursors: z.object({
|
|
1477
|
+
next: z.string().describe(
|
|
1478
|
+
"Cursor string pointing to the next page in the list of results."
|
|
1479
|
+
).max(16e3).optional().nullable(),
|
|
1480
|
+
prev: z.string().describe(
|
|
1481
|
+
"Cursor pointing to the previous page in the list of results."
|
|
1482
|
+
).max(16e3).optional().nullable()
|
|
1483
|
+
}).describe(
|
|
1484
|
+
"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."
|
|
1485
|
+
).optional()
|
|
1486
|
+
}).describe("Paging metadata.").optional()
|
|
1487
|
+
});
|
|
1488
|
+
var UpdateProjectOrderInCollectionRequest = z.object({
|
|
1489
|
+
identifiers: z.object({
|
|
1490
|
+
projectId: z.string().describe("ID of the project to update.").regex(
|
|
1491
|
+
/^[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}$/,
|
|
1492
|
+
"Must be a valid GUID"
|
|
1493
|
+
),
|
|
1494
|
+
collectionId: z.string().describe("Collection ID.").regex(
|
|
1495
|
+
/^[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}$/,
|
|
1496
|
+
"Must be a valid GUID"
|
|
1497
|
+
)
|
|
1498
|
+
}),
|
|
1499
|
+
sortOrder: z.number().describe(
|
|
1500
|
+
"Index that determines the placement of a project within the collection."
|
|
1501
|
+
)
|
|
1502
|
+
});
|
|
1503
|
+
var UpdateProjectOrderInCollectionResponse = z.object({
|
|
1504
|
+
projectInCollection: z.object({
|
|
1505
|
+
collectionId: z.string().describe("Collection ID.").regex(
|
|
1506
|
+
/^[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}$/,
|
|
1507
|
+
"Must be a valid GUID"
|
|
1508
|
+
).optional(),
|
|
1509
|
+
project: z.intersection(
|
|
1510
|
+
z.object({
|
|
1511
|
+
_id: z.string().describe("Project ID.").regex(
|
|
1512
|
+
/^[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}$/,
|
|
1513
|
+
"Must be a valid GUID"
|
|
1514
|
+
).optional().nullable(),
|
|
1515
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
1516
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
1517
|
+
).optional().nullable(),
|
|
1518
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
1519
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
1520
|
+
hidden: z.boolean().describe(
|
|
1521
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
1522
|
+
).optional().nullable(),
|
|
1523
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
1524
|
+
details: z.array(
|
|
1525
|
+
z.intersection(
|
|
1526
|
+
z.object({
|
|
1527
|
+
label: z.string().describe("Project label.").optional()
|
|
1528
|
+
}),
|
|
1529
|
+
z.xor([
|
|
1530
|
+
z.object({
|
|
1531
|
+
text: z.never().optional(),
|
|
1532
|
+
link: z.never().optional()
|
|
1533
|
+
}),
|
|
1534
|
+
z.object({
|
|
1535
|
+
link: z.never().optional(),
|
|
1536
|
+
text: z.string().describe("Project label in plain text format.")
|
|
1537
|
+
}),
|
|
1538
|
+
z.object({
|
|
1539
|
+
text: z.never().optional(),
|
|
1540
|
+
link: z.object({
|
|
1541
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
1542
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
1543
|
+
target: z.string().describe(
|
|
1544
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
1545
|
+
).optional().nullable()
|
|
1546
|
+
}).describe("Project label in link format.")
|
|
1547
|
+
})
|
|
1548
|
+
])
|
|
1549
|
+
)
|
|
1550
|
+
).optional(),
|
|
1551
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
1552
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
1553
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
1554
|
+
url: z.string().describe(
|
|
1555
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
1556
|
+
).optional(),
|
|
1557
|
+
seoData: z.object({
|
|
1558
|
+
tags: z.array(
|
|
1559
|
+
z.object({
|
|
1560
|
+
type: z.string().describe(
|
|
1561
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
1562
|
+
).optional(),
|
|
1563
|
+
props: z.record(z.string(), z.any()).describe(
|
|
1564
|
+
'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"}`.'
|
|
1565
|
+
).optional().nullable(),
|
|
1566
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
1567
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1568
|
+
).optional().nullable(),
|
|
1569
|
+
children: z.string().describe(
|
|
1570
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1571
|
+
).optional(),
|
|
1572
|
+
custom: z.boolean().describe(
|
|
1573
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
1574
|
+
).optional(),
|
|
1575
|
+
disabled: z.boolean().describe(
|
|
1576
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1577
|
+
).optional()
|
|
1578
|
+
})
|
|
1579
|
+
).optional(),
|
|
1580
|
+
settings: z.object({
|
|
1581
|
+
preventAutoRedirect: z.boolean().describe(
|
|
1582
|
+
"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)."
|
|
1583
|
+
).optional(),
|
|
1584
|
+
keywords: z.array(
|
|
1585
|
+
z.object({
|
|
1586
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
1587
|
+
isMain: z.boolean().describe(
|
|
1588
|
+
"Whether the keyword is the main focus keyword."
|
|
1589
|
+
).optional(),
|
|
1590
|
+
origin: z.string().describe(
|
|
1591
|
+
"The source that added the keyword terms to the SEO settings."
|
|
1592
|
+
).max(1e3).optional().nullable()
|
|
1593
|
+
})
|
|
1594
|
+
).max(5).optional()
|
|
1595
|
+
}).describe("SEO general settings.").optional()
|
|
1596
|
+
}).describe("Project SEO data.").optional(),
|
|
1597
|
+
watermark: z.object({
|
|
1598
|
+
position: z.enum([
|
|
1599
|
+
"NORTH_WEST",
|
|
1600
|
+
"NORTH",
|
|
1601
|
+
"NORTH_EAST",
|
|
1602
|
+
"WEST",
|
|
1603
|
+
"CENTER",
|
|
1604
|
+
"EAST",
|
|
1605
|
+
"SOUTH_WEST",
|
|
1606
|
+
"SOUTH",
|
|
1607
|
+
"SOUTH_EAST"
|
|
1608
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
1609
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
1610
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
1611
|
+
imageUrl: z.string().describe(
|
|
1612
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
1613
|
+
).max(300).optional(),
|
|
1614
|
+
enabled: z.boolean().describe(
|
|
1615
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
1616
|
+
).optional()
|
|
1617
|
+
}).describe(
|
|
1618
|
+
"Optional watermark that can be applied to all project's images."
|
|
1619
|
+
).optional()
|
|
1620
|
+
}),
|
|
1621
|
+
z.xor([
|
|
1622
|
+
z.object({
|
|
1623
|
+
coverImage: z.never().optional(),
|
|
1624
|
+
coverVideo: z.never().optional()
|
|
1625
|
+
}),
|
|
1626
|
+
z.object({
|
|
1627
|
+
coverVideo: z.never().optional(),
|
|
1628
|
+
coverImage: z.object({
|
|
1629
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
1630
|
+
focalPoint: z.object({
|
|
1631
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
1632
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
1633
|
+
}).describe("Focal point of the image.").optional()
|
|
1634
|
+
}).describe("Project cover image.")
|
|
1635
|
+
}),
|
|
1636
|
+
z.object({
|
|
1637
|
+
coverImage: z.never().optional(),
|
|
1638
|
+
coverVideo: z.object({
|
|
1639
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
1640
|
+
durationInMillis: z.number().int().describe(
|
|
1641
|
+
"Manually defined Video duration in milliseconds."
|
|
1642
|
+
).optional().nullable()
|
|
1643
|
+
}).describe("Project cover video.")
|
|
1644
|
+
})
|
|
1645
|
+
])
|
|
1646
|
+
).describe("Project object.").optional(),
|
|
1647
|
+
sortOrder: z.number().describe(
|
|
1648
|
+
"Index that determines the placement of a project within the collection. <br />\n\nDefault: [Epoch](https://www.epoch101.com/) timestamp. <br />"
|
|
1649
|
+
).optional().nullable(),
|
|
1650
|
+
_id: z.string().describe("Project placement ID.").regex(
|
|
1651
|
+
/^[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}$/,
|
|
1652
|
+
"Must be a valid GUID"
|
|
1653
|
+
).optional().nullable()
|
|
1654
|
+
}).describe("Updated project placement within the specified collection.").optional()
|
|
1655
|
+
});
|
|
1656
|
+
var QueryProjectsWithCollectionInfoRequest = z.object({
|
|
1657
|
+
query: z.intersection(
|
|
1658
|
+
z.object({
|
|
1659
|
+
filter: z.record(z.string(), z.any()).describe(
|
|
1660
|
+
"Filter object.\n\nLearn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters)."
|
|
1661
|
+
).optional().nullable(),
|
|
1662
|
+
sort: z.array(
|
|
1663
|
+
z.object({
|
|
1664
|
+
fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
|
|
1665
|
+
order: z.enum(["ASC", "DESC"]).optional()
|
|
1666
|
+
})
|
|
1667
|
+
).optional(),
|
|
1668
|
+
fields: z.array(z.string()).optional(),
|
|
1669
|
+
fieldsets: z.array(z.string()).optional()
|
|
1670
|
+
}),
|
|
1671
|
+
z.xor([
|
|
1672
|
+
z.object({
|
|
1673
|
+
paging: z.never().optional(),
|
|
1674
|
+
cursorPaging: z.never().optional()
|
|
1675
|
+
}),
|
|
1676
|
+
z.object({
|
|
1677
|
+
cursorPaging: z.never().optional(),
|
|
1678
|
+
paging: z.object({
|
|
1679
|
+
limit: z.number().int().describe("Number of items to load.").min(0).optional().nullable(),
|
|
1680
|
+
offset: z.number().int().describe("Number of items to skip in the current sort order.").min(0).optional().nullable()
|
|
1681
|
+
}).describe(
|
|
1682
|
+
"Paging options to limit and offset the number of items."
|
|
1683
|
+
)
|
|
1684
|
+
}),
|
|
1685
|
+
z.object({
|
|
1686
|
+
paging: z.never().optional(),
|
|
1687
|
+
cursorPaging: z.object({
|
|
1688
|
+
limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
|
|
1689
|
+
cursor: z.string().describe(
|
|
1690
|
+
"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
|
|
1691
|
+
).max(16e3).optional().nullable()
|
|
1692
|
+
}).describe(
|
|
1693
|
+
"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`."
|
|
1694
|
+
)
|
|
1695
|
+
})
|
|
1696
|
+
])
|
|
1697
|
+
).describe("WQL expression"),
|
|
1698
|
+
options: z.object({
|
|
1699
|
+
includePageUrl: z.boolean().describe("Include page url").optional().nullable()
|
|
1700
|
+
}).optional()
|
|
1701
|
+
});
|
|
1702
|
+
var QueryProjectsWithCollectionInfoResponse = z.object({
|
|
1703
|
+
projects: z.array(
|
|
1704
|
+
z.object({
|
|
1705
|
+
collectionId: z.string().describe("Collection ID.").regex(
|
|
1706
|
+
/^[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}$/,
|
|
1707
|
+
"Must be a valid GUID"
|
|
1708
|
+
).optional(),
|
|
1709
|
+
project: z.intersection(
|
|
1710
|
+
z.object({
|
|
1711
|
+
_id: z.string().describe("Project ID.").regex(
|
|
1712
|
+
/^[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}$/,
|
|
1713
|
+
"Must be a valid GUID"
|
|
1714
|
+
).optional().nullable(),
|
|
1715
|
+
revision: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
|
|
1716
|
+
"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object."
|
|
1717
|
+
).optional().nullable(),
|
|
1718
|
+
title: z.string().describe("Project title.").max(100).optional().nullable(),
|
|
1719
|
+
description: z.string().describe("Project description.").optional().nullable(),
|
|
1720
|
+
hidden: z.boolean().describe(
|
|
1721
|
+
"Whether the project is hidden from the portfolio. Default: `false`"
|
|
1722
|
+
).optional().nullable(),
|
|
1723
|
+
collectionIds: z.array(z.string()).max(1e3).optional(),
|
|
1724
|
+
details: z.array(
|
|
1725
|
+
z.intersection(
|
|
1726
|
+
z.object({
|
|
1727
|
+
label: z.string().describe("Project label.").optional()
|
|
1728
|
+
}),
|
|
1729
|
+
z.xor([
|
|
1730
|
+
z.object({
|
|
1731
|
+
text: z.never().optional(),
|
|
1732
|
+
link: z.never().optional()
|
|
1733
|
+
}),
|
|
1734
|
+
z.object({
|
|
1735
|
+
link: z.never().optional(),
|
|
1736
|
+
text: z.string().describe("Project label in plain text format.")
|
|
1737
|
+
}),
|
|
1738
|
+
z.object({
|
|
1739
|
+
text: z.never().optional(),
|
|
1740
|
+
link: z.object({
|
|
1741
|
+
text: z.string().describe("Display text of the link.").optional().nullable(),
|
|
1742
|
+
url: z.string().describe("Target URL of the link.").url().optional().nullable(),
|
|
1743
|
+
target: z.string().describe(
|
|
1744
|
+
"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window."
|
|
1745
|
+
).optional().nullable()
|
|
1746
|
+
}).describe("Project label in link format.")
|
|
1747
|
+
})
|
|
1748
|
+
])
|
|
1749
|
+
)
|
|
1750
|
+
).optional(),
|
|
1751
|
+
slug: z.string().describe("Project slug.").optional().nullable(),
|
|
1752
|
+
_createdDate: z.date().describe("Date and time the project was created.").optional().nullable(),
|
|
1753
|
+
_updatedDate: z.date().describe("Date and time the project was updated.").optional().nullable(),
|
|
1754
|
+
url: z.string().describe(
|
|
1755
|
+
"Project page URL and relative path. Returned when `includePageUrl` is `true` in the request."
|
|
1756
|
+
).optional(),
|
|
1757
|
+
seoData: z.object({
|
|
1758
|
+
tags: z.array(
|
|
1759
|
+
z.object({
|
|
1760
|
+
type: z.string().describe(
|
|
1761
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
1762
|
+
).optional(),
|
|
1763
|
+
props: z.record(z.string(), z.any()).describe(
|
|
1764
|
+
'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"}`.'
|
|
1765
|
+
).optional().nullable(),
|
|
1766
|
+
meta: z.record(z.string(), z.any()).describe(
|
|
1767
|
+
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1768
|
+
).optional().nullable(),
|
|
1769
|
+
children: z.string().describe(
|
|
1770
|
+
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1771
|
+
).optional(),
|
|
1772
|
+
custom: z.boolean().describe(
|
|
1773
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
1774
|
+
).optional(),
|
|
1775
|
+
disabled: z.boolean().describe(
|
|
1776
|
+
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1777
|
+
).optional()
|
|
1778
|
+
})
|
|
1779
|
+
).optional(),
|
|
1780
|
+
settings: z.object({
|
|
1781
|
+
preventAutoRedirect: z.boolean().describe(
|
|
1782
|
+
"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)."
|
|
1783
|
+
).optional(),
|
|
1784
|
+
keywords: z.array(
|
|
1785
|
+
z.object({
|
|
1786
|
+
term: z.string().describe("Keyword value.").optional(),
|
|
1787
|
+
isMain: z.boolean().describe(
|
|
1788
|
+
"Whether the keyword is the main focus keyword."
|
|
1789
|
+
).optional(),
|
|
1790
|
+
origin: z.string().describe(
|
|
1791
|
+
"The source that added the keyword terms to the SEO settings."
|
|
1792
|
+
).max(1e3).optional().nullable()
|
|
1793
|
+
})
|
|
1794
|
+
).max(5).optional()
|
|
1795
|
+
}).describe("SEO general settings.").optional()
|
|
1796
|
+
}).describe("Project SEO data.").optional(),
|
|
1797
|
+
watermark: z.object({
|
|
1798
|
+
position: z.enum([
|
|
1799
|
+
"NORTH_WEST",
|
|
1800
|
+
"NORTH",
|
|
1801
|
+
"NORTH_EAST",
|
|
1802
|
+
"WEST",
|
|
1803
|
+
"CENTER",
|
|
1804
|
+
"EAST",
|
|
1805
|
+
"SOUTH_WEST",
|
|
1806
|
+
"SOUTH",
|
|
1807
|
+
"SOUTH_EAST"
|
|
1808
|
+
]).describe("Position of the watermark on the image.").optional(),
|
|
1809
|
+
size: z.number().int().describe("Size of the watermark, from 0 to 100.").min(0).max(100).optional(),
|
|
1810
|
+
opacity: z.number().int().describe("Opacity of the watermark.").min(1).max(100).optional(),
|
|
1811
|
+
imageUrl: z.string().describe(
|
|
1812
|
+
"Image ID of the Watermark as saved in Media Platform."
|
|
1813
|
+
).max(300).optional(),
|
|
1814
|
+
enabled: z.boolean().describe(
|
|
1815
|
+
"Whether the watermark is to be displayed on Items & Cover Photos."
|
|
1816
|
+
).optional()
|
|
1817
|
+
}).describe(
|
|
1818
|
+
"Optional watermark that can be applied to all project's images."
|
|
1819
|
+
).optional()
|
|
1820
|
+
}),
|
|
1821
|
+
z.xor([
|
|
1822
|
+
z.object({
|
|
1823
|
+
coverImage: z.never().optional(),
|
|
1824
|
+
coverVideo: z.never().optional()
|
|
1825
|
+
}),
|
|
1826
|
+
z.object({
|
|
1827
|
+
coverVideo: z.never().optional(),
|
|
1828
|
+
coverImage: z.object({
|
|
1829
|
+
imageInfo: z.string().describe("Information about the Wix Media image.").optional(),
|
|
1830
|
+
focalPoint: z.object({
|
|
1831
|
+
x: z.number().describe("X-coordinate of the focal point.").optional(),
|
|
1832
|
+
y: z.number().describe("Y-coordinate of the focal point.").optional()
|
|
1833
|
+
}).describe("Focal point of the image.").optional()
|
|
1834
|
+
}).describe("Project cover image.")
|
|
1835
|
+
}),
|
|
1836
|
+
z.object({
|
|
1837
|
+
coverImage: z.never().optional(),
|
|
1838
|
+
coverVideo: z.object({
|
|
1839
|
+
videoInfo: z.string().describe("Information about the Wix Media video.").optional(),
|
|
1840
|
+
durationInMillis: z.number().int().describe(
|
|
1841
|
+
"Manually defined Video duration in milliseconds."
|
|
1842
|
+
).optional().nullable()
|
|
1843
|
+
}).describe("Project cover video.")
|
|
1844
|
+
})
|
|
1845
|
+
])
|
|
1846
|
+
).describe("Project object.").optional(),
|
|
1847
|
+
sortOrder: z.number().describe(
|
|
1848
|
+
"Index that determines the placement of a project within the collection. <br />\n\nDefault: [Epoch](https://www.epoch101.com/) timestamp. <br />"
|
|
1849
|
+
).optional().nullable(),
|
|
1850
|
+
_id: z.string().describe("Project placement ID.").regex(
|
|
1851
|
+
/^[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}$/,
|
|
1852
|
+
"Must be a valid GUID"
|
|
1853
|
+
).optional().nullable()
|
|
1854
|
+
})
|
|
1855
|
+
).optional(),
|
|
1856
|
+
metadata: z.object({
|
|
1857
|
+
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
1858
|
+
offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
|
|
1859
|
+
total: z.number().int().describe(
|
|
1860
|
+
"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."
|
|
1861
|
+
).optional().nullable(),
|
|
1862
|
+
tooManyToCount: z.boolean().describe(
|
|
1863
|
+
"Flag that indicates the server failed to calculate the `total` field."
|
|
1864
|
+
).optional().nullable(),
|
|
1865
|
+
cursors: z.object({
|
|
1866
|
+
next: z.string().describe(
|
|
1867
|
+
"Cursor string pointing to the next page in the list of results."
|
|
1868
|
+
).max(16e3).optional().nullable(),
|
|
1869
|
+
prev: z.string().describe(
|
|
1870
|
+
"Cursor pointing to the previous page in the list of results."
|
|
1871
|
+
).max(16e3).optional().nullable()
|
|
1872
|
+
}).describe(
|
|
1873
|
+
"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."
|
|
1874
|
+
).optional()
|
|
1875
|
+
}).describe("Paging metadata").optional()
|
|
1876
|
+
});
|
|
1877
|
+
export {
|
|
1878
|
+
BulkUpdateProjectsRequest,
|
|
1879
|
+
BulkUpdateProjectsResponse,
|
|
1880
|
+
CreateProjectRequest,
|
|
1881
|
+
CreateProjectResponse,
|
|
1882
|
+
DeleteProjectRequest,
|
|
1883
|
+
DeleteProjectResponse,
|
|
1884
|
+
GetProjectRequest,
|
|
1885
|
+
GetProjectResponse,
|
|
1886
|
+
ListProjectsRequest,
|
|
1887
|
+
ListProjectsResponse,
|
|
1888
|
+
QueryProjectsRequest,
|
|
1889
|
+
QueryProjectsResponse,
|
|
1890
|
+
QueryProjectsWithCollectionInfoRequest,
|
|
1891
|
+
QueryProjectsWithCollectionInfoResponse,
|
|
1892
|
+
UpdateProjectOrderInCollectionRequest,
|
|
1893
|
+
UpdateProjectOrderInCollectionResponse,
|
|
1894
|
+
UpdateProjectRequest,
|
|
1895
|
+
UpdateProjectResponse
|
|
1896
|
+
};
|
|
1897
|
+
//# sourceMappingURL=schemas.mjs.map
|