@nuxtseo/protocol 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/analytics-codecs/analytics-row.d.ts +265 -0
- package/dist/analytics-codecs/analytics-row.js +175 -0
- package/dist/analytics-codecs/analytics-web-vitals.d.ts +57 -0
- package/dist/analytics-codecs/analytics-web-vitals.js +76 -0
- package/dist/analytics-codecs/capabilities.d.ts +35 -0
- package/dist/analytics-codecs/capabilities.js +76 -0
- package/dist/analytics-codecs/index.d.ts +3 -0
- package/dist/analytics-codecs/index.js +3 -0
- package/dist/cli-pairing.d.ts +67 -0
- package/dist/cli-pairing.js +52 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/v1/account.d.ts +715 -0
- package/dist/v1/account.js +123 -0
- package/dist/v1/actions.d.ts +2591 -0
- package/dist/v1/actions.js +460 -0
- package/dist/v1/analytics.d.ts +6145 -0
- package/dist/v1/analytics.js +296 -0
- package/dist/v1/audit.d.ts +4053 -0
- package/dist/v1/audit.js +609 -0
- package/dist/v1/backlinks.d.ts +1002 -0
- package/dist/v1/backlinks.js +239 -0
- package/dist/v1/content.d.ts +2745 -0
- package/dist/v1/content.js +326 -0
- package/dist/v1/core.d.ts +301 -0
- package/dist/v1/core.js +333 -0
- package/dist/v1/documents.d.ts +4 -0
- package/dist/v1/documents.js +216 -0
- package/dist/v1/gsc.d.ts +5172 -0
- package/dist/v1/gsc.js +583 -0
- package/dist/v1/index.d.ts +49 -0
- package/dist/v1/index.js +52 -0
- package/dist/v1/pages.d.ts +1404 -0
- package/dist/v1/pages.js +287 -0
- package/dist/v1/performance.d.ts +1379 -0
- package/dist/v1/performance.js +198 -0
- package/dist/v1/research.d.ts +1173 -0
- package/dist/v1/research.js +174 -0
- package/dist/v1/sitemaps.d.ts +1506 -0
- package/dist/v1/sitemaps.js +199 -0
- package/dist/v1/sites.d.ts +591 -0
- package/dist/v1/sites.js +101 -0
- package/generated/openapi.v1.json +1 -0
- package/package.json +131 -0
|
@@ -0,0 +1,1506 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
import { gscdumpSitemapUrlsQuerySchema } from '@gscdump/contracts';
|
|
3
|
+
export declare const siteSitemapParamsSchema: z.ZodObject<{
|
|
4
|
+
siteId: z.ZodString;
|
|
5
|
+
}, z.core.$strict>;
|
|
6
|
+
export declare const siteSitemapActionBodySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
7
|
+
action: z.ZodLiteral<"submit">;
|
|
8
|
+
sitemapUrl: z.ZodString;
|
|
9
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10
|
+
action: z.ZodLiteral<"delete">;
|
|
11
|
+
sitemapUrl: z.ZodString;
|
|
12
|
+
}, z.core.$strip>], "action">;
|
|
13
|
+
export declare const siteSitemapsResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
14
|
+
data: z.ZodObject<{
|
|
15
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
16
|
+
path: z.ZodString;
|
|
17
|
+
urlCount: z.ZodNumber;
|
|
18
|
+
errors: z.ZodNumber;
|
|
19
|
+
warnings: z.ZodNumber;
|
|
20
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
21
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
22
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
23
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
24
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
25
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
26
|
+
}, z.core.$loose>>;
|
|
27
|
+
history: z.ZodArray<z.ZodObject<{
|
|
28
|
+
date: z.ZodString;
|
|
29
|
+
errors: z.ZodNumber;
|
|
30
|
+
warnings: z.ZodNumber;
|
|
31
|
+
urlCount: z.ZodNumber;
|
|
32
|
+
urlDelta: z.ZodNumber;
|
|
33
|
+
}, z.core.$loose>>;
|
|
34
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
35
|
+
date: z.ZodString;
|
|
36
|
+
urlCount: z.ZodNumber;
|
|
37
|
+
changed: z.ZodBoolean;
|
|
38
|
+
urlDelta: z.ZodNumber;
|
|
39
|
+
}, z.core.$loose>>>;
|
|
40
|
+
meta: z.ZodObject<{
|
|
41
|
+
siteUrl: z.ZodString;
|
|
42
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
43
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
44
|
+
sitemapScope: z.ZodObject<{
|
|
45
|
+
excludedCount: z.ZodNumber;
|
|
46
|
+
duplicateCount: z.ZodNumber;
|
|
47
|
+
}, z.core.$strip>;
|
|
48
|
+
}, z.core.$loose>;
|
|
49
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
50
|
+
id: z.ZodString;
|
|
51
|
+
observedAt: z.ZodNumber;
|
|
52
|
+
publishedAt: z.ZodNumber;
|
|
53
|
+
completeness: z.ZodObject<{
|
|
54
|
+
_tag: z.ZodLiteral<"complete">;
|
|
55
|
+
}, z.core.$strict>;
|
|
56
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
57
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
58
|
+
_tag: z.ZodLiteral<"none">;
|
|
59
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
60
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
61
|
+
importedAt: z.ZodNumber;
|
|
62
|
+
recordCount: z.ZodNumber;
|
|
63
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
64
|
+
}, z.core.$strict>], "_tag">;
|
|
65
|
+
}, z.core.$strict>>>;
|
|
66
|
+
}, z.core.$strict>;
|
|
67
|
+
meta: z.ZodObject<{
|
|
68
|
+
requestId: z.ZodString;
|
|
69
|
+
version: z.ZodLiteral<"1.0">;
|
|
70
|
+
}, z.core.$strict>;
|
|
71
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
72
|
+
data: z.ZodObject<{
|
|
73
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
74
|
+
path: z.ZodString;
|
|
75
|
+
urlCount: z.ZodNumber;
|
|
76
|
+
errors: z.ZodNumber;
|
|
77
|
+
warnings: z.ZodNumber;
|
|
78
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
79
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
80
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
81
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
82
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
83
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
84
|
+
}, z.core.$loose>>;
|
|
85
|
+
history: z.ZodArray<z.ZodObject<{
|
|
86
|
+
date: z.ZodString;
|
|
87
|
+
errors: z.ZodNumber;
|
|
88
|
+
warnings: z.ZodNumber;
|
|
89
|
+
urlCount: z.ZodNumber;
|
|
90
|
+
urlDelta: z.ZodNumber;
|
|
91
|
+
}, z.core.$loose>>;
|
|
92
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
93
|
+
date: z.ZodString;
|
|
94
|
+
urlCount: z.ZodNumber;
|
|
95
|
+
changed: z.ZodBoolean;
|
|
96
|
+
urlDelta: z.ZodNumber;
|
|
97
|
+
}, z.core.$loose>>>;
|
|
98
|
+
meta: z.ZodObject<{
|
|
99
|
+
siteUrl: z.ZodString;
|
|
100
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
101
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
102
|
+
sitemapScope: z.ZodObject<{
|
|
103
|
+
excludedCount: z.ZodNumber;
|
|
104
|
+
duplicateCount: z.ZodNumber;
|
|
105
|
+
}, z.core.$strip>;
|
|
106
|
+
}, z.core.$loose>;
|
|
107
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
108
|
+
id: z.ZodString;
|
|
109
|
+
observedAt: z.ZodNumber;
|
|
110
|
+
publishedAt: z.ZodNumber;
|
|
111
|
+
completeness: z.ZodObject<{
|
|
112
|
+
_tag: z.ZodLiteral<"complete">;
|
|
113
|
+
}, z.core.$strict>;
|
|
114
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
115
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
116
|
+
_tag: z.ZodLiteral<"none">;
|
|
117
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
118
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
119
|
+
importedAt: z.ZodNumber;
|
|
120
|
+
recordCount: z.ZodNumber;
|
|
121
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
122
|
+
}, z.core.$strict>], "_tag">;
|
|
123
|
+
}, z.core.$strict>>>;
|
|
124
|
+
}, z.core.$loose>;
|
|
125
|
+
meta: z.ZodObject<{
|
|
126
|
+
requestId: z.ZodString;
|
|
127
|
+
version: z.ZodLiteral<"1.0">;
|
|
128
|
+
}, z.core.$loose>;
|
|
129
|
+
}, z.core.$strip>>;
|
|
130
|
+
export declare const siteSitemapUrlsResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
131
|
+
data: z.ZodObject<{
|
|
132
|
+
generation: z.ZodObject<{
|
|
133
|
+
id: z.ZodString;
|
|
134
|
+
observedAt: z.ZodNumber;
|
|
135
|
+
publishedAt: z.ZodNumber;
|
|
136
|
+
completeness: z.ZodObject<{
|
|
137
|
+
_tag: z.ZodLiteral<"complete">;
|
|
138
|
+
}, z.core.$strict>;
|
|
139
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
140
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
141
|
+
_tag: z.ZodLiteral<"none">;
|
|
142
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
143
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
144
|
+
importedAt: z.ZodNumber;
|
|
145
|
+
recordCount: z.ZodNumber;
|
|
146
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
147
|
+
}, z.core.$strict>], "_tag">;
|
|
148
|
+
}, z.core.$strict>;
|
|
149
|
+
items: z.ZodArray<z.ZodObject<{
|
|
150
|
+
url: z.ZodString;
|
|
151
|
+
feedpath: z.ZodString;
|
|
152
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
153
|
+
firstSeenAt: z.ZodNumber;
|
|
154
|
+
lastSeenAt: z.ZodNumber;
|
|
155
|
+
}, z.core.$strict>>;
|
|
156
|
+
page: z.ZodObject<{
|
|
157
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
158
|
+
limit: z.ZodNumber;
|
|
159
|
+
}, z.core.$strict>;
|
|
160
|
+
}, z.core.$strict>;
|
|
161
|
+
meta: z.ZodObject<{
|
|
162
|
+
requestId: z.ZodString;
|
|
163
|
+
version: z.ZodLiteral<"1.0">;
|
|
164
|
+
}, z.core.$strict>;
|
|
165
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
166
|
+
data: z.ZodObject<{
|
|
167
|
+
generation: z.ZodObject<{
|
|
168
|
+
id: z.ZodString;
|
|
169
|
+
observedAt: z.ZodNumber;
|
|
170
|
+
publishedAt: z.ZodNumber;
|
|
171
|
+
completeness: z.ZodObject<{
|
|
172
|
+
_tag: z.ZodLiteral<"complete">;
|
|
173
|
+
}, z.core.$strict>;
|
|
174
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
175
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
176
|
+
_tag: z.ZodLiteral<"none">;
|
|
177
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
178
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
179
|
+
importedAt: z.ZodNumber;
|
|
180
|
+
recordCount: z.ZodNumber;
|
|
181
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
182
|
+
}, z.core.$strict>], "_tag">;
|
|
183
|
+
}, z.core.$strict>;
|
|
184
|
+
items: z.ZodArray<z.ZodObject<{
|
|
185
|
+
url: z.ZodString;
|
|
186
|
+
feedpath: z.ZodString;
|
|
187
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
188
|
+
firstSeenAt: z.ZodNumber;
|
|
189
|
+
lastSeenAt: z.ZodNumber;
|
|
190
|
+
}, z.core.$strict>>;
|
|
191
|
+
page: z.ZodObject<{
|
|
192
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
193
|
+
limit: z.ZodNumber;
|
|
194
|
+
}, z.core.$strict>;
|
|
195
|
+
}, z.core.$loose>;
|
|
196
|
+
meta: z.ZodObject<{
|
|
197
|
+
requestId: z.ZodString;
|
|
198
|
+
version: z.ZodLiteral<"1.0">;
|
|
199
|
+
}, z.core.$loose>;
|
|
200
|
+
}, z.core.$strip>>;
|
|
201
|
+
export declare const siteSitemapActionResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
202
|
+
data: z.ZodObject<{
|
|
203
|
+
success: z.ZodBoolean;
|
|
204
|
+
action: z.ZodEnum<{
|
|
205
|
+
deleted: "deleted";
|
|
206
|
+
submitted: "submitted";
|
|
207
|
+
}>;
|
|
208
|
+
sitemapUrl: z.ZodString;
|
|
209
|
+
sitemapCount: z.ZodNumber;
|
|
210
|
+
}, z.core.$strict>;
|
|
211
|
+
meta: z.ZodObject<{
|
|
212
|
+
requestId: z.ZodString;
|
|
213
|
+
version: z.ZodLiteral<"1.0">;
|
|
214
|
+
}, z.core.$strict>;
|
|
215
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
216
|
+
data: z.ZodObject<{
|
|
217
|
+
success: z.ZodBoolean;
|
|
218
|
+
action: z.ZodEnum<{
|
|
219
|
+
deleted: "deleted";
|
|
220
|
+
submitted: "submitted";
|
|
221
|
+
}>;
|
|
222
|
+
sitemapUrl: z.ZodString;
|
|
223
|
+
sitemapCount: z.ZodNumber;
|
|
224
|
+
}, z.core.$loose>;
|
|
225
|
+
meta: z.ZodObject<{
|
|
226
|
+
requestId: z.ZodString;
|
|
227
|
+
version: z.ZodLiteral<"1.0">;
|
|
228
|
+
}, z.core.$loose>;
|
|
229
|
+
}, z.core.$strip>>;
|
|
230
|
+
export type SiteSitemapsResponse = z.output<typeof siteSitemapsResponseSchema.client>;
|
|
231
|
+
export type SiteSitemapUrlsQuery = z.input<typeof gscdumpSitemapUrlsQuerySchema>;
|
|
232
|
+
export type SiteSitemapUrlsResponse = z.output<typeof siteSitemapUrlsResponseSchema.client>;
|
|
233
|
+
export type SiteSitemapActionBody = z.input<typeof siteSitemapActionBodySchema>;
|
|
234
|
+
export type SiteSitemapActionResponse = z.output<typeof siteSitemapActionResponseSchema.client>;
|
|
235
|
+
export declare const siteSitemapsListOperation: {
|
|
236
|
+
readonly id: 'sites.sitemaps.list';
|
|
237
|
+
readonly method: 'GET';
|
|
238
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps';
|
|
239
|
+
readonly visibility: 'public';
|
|
240
|
+
readonly semantics: {
|
|
241
|
+
readonly kind: 'query';
|
|
242
|
+
readonly sideEffects: 'none';
|
|
243
|
+
readonly retry: 'idempotent';
|
|
244
|
+
readonly readConsistency: 'primary';
|
|
245
|
+
};
|
|
246
|
+
readonly auth: {
|
|
247
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
248
|
+
readonly scopes: readonly ["sites:read"];
|
|
249
|
+
readonly minimumRole: 'viewer';
|
|
250
|
+
readonly ownership: 'site';
|
|
251
|
+
};
|
|
252
|
+
readonly request: {
|
|
253
|
+
readonly params: z.ZodObject<{
|
|
254
|
+
siteId: z.ZodString;
|
|
255
|
+
}, z.core.$strict>;
|
|
256
|
+
readonly query: null;
|
|
257
|
+
readonly headers: null;
|
|
258
|
+
readonly body: null;
|
|
259
|
+
};
|
|
260
|
+
readonly responses: {
|
|
261
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
262
|
+
data: z.ZodObject<{
|
|
263
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
264
|
+
path: z.ZodString;
|
|
265
|
+
urlCount: z.ZodNumber;
|
|
266
|
+
errors: z.ZodNumber;
|
|
267
|
+
warnings: z.ZodNumber;
|
|
268
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
269
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
270
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
271
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
272
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
273
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
274
|
+
}, z.core.$loose>>;
|
|
275
|
+
history: z.ZodArray<z.ZodObject<{
|
|
276
|
+
date: z.ZodString;
|
|
277
|
+
errors: z.ZodNumber;
|
|
278
|
+
warnings: z.ZodNumber;
|
|
279
|
+
urlCount: z.ZodNumber;
|
|
280
|
+
urlDelta: z.ZodNumber;
|
|
281
|
+
}, z.core.$loose>>;
|
|
282
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
283
|
+
date: z.ZodString;
|
|
284
|
+
urlCount: z.ZodNumber;
|
|
285
|
+
changed: z.ZodBoolean;
|
|
286
|
+
urlDelta: z.ZodNumber;
|
|
287
|
+
}, z.core.$loose>>>;
|
|
288
|
+
meta: z.ZodObject<{
|
|
289
|
+
siteUrl: z.ZodString;
|
|
290
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
291
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
292
|
+
sitemapScope: z.ZodObject<{
|
|
293
|
+
excludedCount: z.ZodNumber;
|
|
294
|
+
duplicateCount: z.ZodNumber;
|
|
295
|
+
}, z.core.$strip>;
|
|
296
|
+
}, z.core.$loose>;
|
|
297
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
298
|
+
id: z.ZodString;
|
|
299
|
+
observedAt: z.ZodNumber;
|
|
300
|
+
publishedAt: z.ZodNumber;
|
|
301
|
+
completeness: z.ZodObject<{
|
|
302
|
+
_tag: z.ZodLiteral<"complete">;
|
|
303
|
+
}, z.core.$strict>;
|
|
304
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
305
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
306
|
+
_tag: z.ZodLiteral<"none">;
|
|
307
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
308
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
309
|
+
importedAt: z.ZodNumber;
|
|
310
|
+
recordCount: z.ZodNumber;
|
|
311
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
312
|
+
}, z.core.$strict>], "_tag">;
|
|
313
|
+
}, z.core.$strict>>>;
|
|
314
|
+
}, z.core.$strict>;
|
|
315
|
+
meta: z.ZodObject<{
|
|
316
|
+
requestId: z.ZodString;
|
|
317
|
+
version: z.ZodLiteral<"1.0">;
|
|
318
|
+
}, z.core.$strict>;
|
|
319
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
320
|
+
data: z.ZodObject<{
|
|
321
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
322
|
+
path: z.ZodString;
|
|
323
|
+
urlCount: z.ZodNumber;
|
|
324
|
+
errors: z.ZodNumber;
|
|
325
|
+
warnings: z.ZodNumber;
|
|
326
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
327
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
328
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
329
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
330
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
331
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
332
|
+
}, z.core.$loose>>;
|
|
333
|
+
history: z.ZodArray<z.ZodObject<{
|
|
334
|
+
date: z.ZodString;
|
|
335
|
+
errors: z.ZodNumber;
|
|
336
|
+
warnings: z.ZodNumber;
|
|
337
|
+
urlCount: z.ZodNumber;
|
|
338
|
+
urlDelta: z.ZodNumber;
|
|
339
|
+
}, z.core.$loose>>;
|
|
340
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
341
|
+
date: z.ZodString;
|
|
342
|
+
urlCount: z.ZodNumber;
|
|
343
|
+
changed: z.ZodBoolean;
|
|
344
|
+
urlDelta: z.ZodNumber;
|
|
345
|
+
}, z.core.$loose>>>;
|
|
346
|
+
meta: z.ZodObject<{
|
|
347
|
+
siteUrl: z.ZodString;
|
|
348
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
349
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
350
|
+
sitemapScope: z.ZodObject<{
|
|
351
|
+
excludedCount: z.ZodNumber;
|
|
352
|
+
duplicateCount: z.ZodNumber;
|
|
353
|
+
}, z.core.$strip>;
|
|
354
|
+
}, z.core.$loose>;
|
|
355
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
356
|
+
id: z.ZodString;
|
|
357
|
+
observedAt: z.ZodNumber;
|
|
358
|
+
publishedAt: z.ZodNumber;
|
|
359
|
+
completeness: z.ZodObject<{
|
|
360
|
+
_tag: z.ZodLiteral<"complete">;
|
|
361
|
+
}, z.core.$strict>;
|
|
362
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
363
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
364
|
+
_tag: z.ZodLiteral<"none">;
|
|
365
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
366
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
367
|
+
importedAt: z.ZodNumber;
|
|
368
|
+
recordCount: z.ZodNumber;
|
|
369
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
370
|
+
}, z.core.$strict>], "_tag">;
|
|
371
|
+
}, z.core.$strict>>>;
|
|
372
|
+
}, z.core.$loose>;
|
|
373
|
+
meta: z.ZodObject<{
|
|
374
|
+
requestId: z.ZodString;
|
|
375
|
+
version: z.ZodLiteral<"1.0">;
|
|
376
|
+
}, z.core.$loose>;
|
|
377
|
+
}, z.core.$strip>>;
|
|
378
|
+
};
|
|
379
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
380
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
381
|
+
readonly error: z.ZodObject<{
|
|
382
|
+
code: z.ZodEnum<{
|
|
383
|
+
auth_expired: "auth_expired";
|
|
384
|
+
conflict: "conflict";
|
|
385
|
+
contract_violation: "contract_violation";
|
|
386
|
+
entitlement_required: "entitlement_required";
|
|
387
|
+
forbidden: "forbidden";
|
|
388
|
+
internal_error: "internal_error";
|
|
389
|
+
invalid_request: "invalid_request";
|
|
390
|
+
not_found: "not_found";
|
|
391
|
+
provider_unavailable: "provider_unavailable";
|
|
392
|
+
quota_exhausted: "quota_exhausted";
|
|
393
|
+
rate_limited: "rate_limited";
|
|
394
|
+
site_ambiguous: "site_ambiguous";
|
|
395
|
+
stale_evidence: "stale_evidence";
|
|
396
|
+
unauthorized: "unauthorized";
|
|
397
|
+
}>;
|
|
398
|
+
message: z.ZodString;
|
|
399
|
+
requestId: z.ZodString;
|
|
400
|
+
retryable: z.ZodBoolean;
|
|
401
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
402
|
+
}, z.core.$strict>;
|
|
403
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
404
|
+
readonly error: z.ZodObject<{
|
|
405
|
+
code: z.ZodEnum<{
|
|
406
|
+
auth_expired: "auth_expired";
|
|
407
|
+
conflict: "conflict";
|
|
408
|
+
contract_violation: "contract_violation";
|
|
409
|
+
entitlement_required: "entitlement_required";
|
|
410
|
+
forbidden: "forbidden";
|
|
411
|
+
internal_error: "internal_error";
|
|
412
|
+
invalid_request: "invalid_request";
|
|
413
|
+
not_found: "not_found";
|
|
414
|
+
provider_unavailable: "provider_unavailable";
|
|
415
|
+
quota_exhausted: "quota_exhausted";
|
|
416
|
+
rate_limited: "rate_limited";
|
|
417
|
+
site_ambiguous: "site_ambiguous";
|
|
418
|
+
stale_evidence: "stale_evidence";
|
|
419
|
+
unauthorized: "unauthorized";
|
|
420
|
+
}>;
|
|
421
|
+
message: z.ZodString;
|
|
422
|
+
requestId: z.ZodString;
|
|
423
|
+
retryable: z.ZodBoolean;
|
|
424
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
425
|
+
}, z.core.$loose>;
|
|
426
|
+
}, z.core.$strip>>;
|
|
427
|
+
readonly resources: {
|
|
428
|
+
readonly reads: readonly [{
|
|
429
|
+
readonly type: 'site.sitemaps';
|
|
430
|
+
readonly idFrom: 'params.siteId';
|
|
431
|
+
}];
|
|
432
|
+
readonly changes: readonly [];
|
|
433
|
+
};
|
|
434
|
+
readonly policy: {
|
|
435
|
+
readonly rate: {
|
|
436
|
+
readonly name: 'public-v1-fixed-window';
|
|
437
|
+
readonly limit: 50;
|
|
438
|
+
readonly windowSeconds: 60;
|
|
439
|
+
};
|
|
440
|
+
readonly idempotency: {
|
|
441
|
+
readonly _tag: 'none';
|
|
442
|
+
};
|
|
443
|
+
readonly entitlement: null;
|
|
444
|
+
readonly meter: null;
|
|
445
|
+
};
|
|
446
|
+
readonly lifecycle: {
|
|
447
|
+
readonly introduced: '1.0.0';
|
|
448
|
+
};
|
|
449
|
+
readonly docs: {
|
|
450
|
+
readonly summary: 'List Site sitemaps';
|
|
451
|
+
readonly description: 'Returns the Search Console sitemap snapshot and its upstream generation for a NuxtSEO Site.';
|
|
452
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
453
|
+
readonly examples: readonly [{
|
|
454
|
+
readonly request: {
|
|
455
|
+
readonly params: {
|
|
456
|
+
readonly siteId: 'site_01JXYZ';
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
readonly response: {
|
|
460
|
+
readonly status: 200;
|
|
461
|
+
readonly body: {
|
|
462
|
+
readonly data: {
|
|
463
|
+
readonly sitemaps: readonly [];
|
|
464
|
+
readonly history: readonly [];
|
|
465
|
+
readonly perSitemapHistory: {};
|
|
466
|
+
readonly generation: null;
|
|
467
|
+
readonly meta: {
|
|
468
|
+
readonly siteUrl: 'sc-domain:example.com';
|
|
469
|
+
readonly gscPropertyUrl: 'sc-domain:example.com';
|
|
470
|
+
readonly syncStatus: 'synced';
|
|
471
|
+
readonly sitemapScope: {
|
|
472
|
+
readonly excludedCount: 0;
|
|
473
|
+
readonly duplicateCount: 0;
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
readonly meta: {
|
|
478
|
+
readonly requestId: 'req_01JXYZ';
|
|
479
|
+
readonly version: '1.0';
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
}];
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
export declare const siteSitemapUrlsListOperation: {
|
|
487
|
+
readonly id: 'sites.sitemaps.urls.list';
|
|
488
|
+
readonly method: 'GET';
|
|
489
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps/urls';
|
|
490
|
+
readonly visibility: 'public';
|
|
491
|
+
readonly semantics: {
|
|
492
|
+
readonly kind: 'query';
|
|
493
|
+
readonly sideEffects: 'none';
|
|
494
|
+
readonly retry: 'idempotent';
|
|
495
|
+
readonly readConsistency: 'primary';
|
|
496
|
+
};
|
|
497
|
+
readonly auth: {
|
|
498
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
499
|
+
readonly scopes: readonly ["sites:read"];
|
|
500
|
+
readonly minimumRole: 'viewer';
|
|
501
|
+
readonly ownership: 'site';
|
|
502
|
+
};
|
|
503
|
+
readonly request: {
|
|
504
|
+
readonly params: z.ZodObject<{
|
|
505
|
+
siteId: z.ZodString;
|
|
506
|
+
}, z.core.$strict>;
|
|
507
|
+
readonly query: z.ZodObject<{
|
|
508
|
+
generationId: z.ZodOptional<z.ZodString>;
|
|
509
|
+
feedpath: z.ZodOptional<z.ZodString>;
|
|
510
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
511
|
+
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
512
|
+
}, z.core.$strict>;
|
|
513
|
+
readonly headers: null;
|
|
514
|
+
readonly body: null;
|
|
515
|
+
};
|
|
516
|
+
readonly responses: {
|
|
517
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
518
|
+
data: z.ZodObject<{
|
|
519
|
+
generation: z.ZodObject<{
|
|
520
|
+
id: z.ZodString;
|
|
521
|
+
observedAt: z.ZodNumber;
|
|
522
|
+
publishedAt: z.ZodNumber;
|
|
523
|
+
completeness: z.ZodObject<{
|
|
524
|
+
_tag: z.ZodLiteral<"complete">;
|
|
525
|
+
}, z.core.$strict>;
|
|
526
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
527
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
528
|
+
_tag: z.ZodLiteral<"none">;
|
|
529
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
530
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
531
|
+
importedAt: z.ZodNumber;
|
|
532
|
+
recordCount: z.ZodNumber;
|
|
533
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
534
|
+
}, z.core.$strict>], "_tag">;
|
|
535
|
+
}, z.core.$strict>;
|
|
536
|
+
items: z.ZodArray<z.ZodObject<{
|
|
537
|
+
url: z.ZodString;
|
|
538
|
+
feedpath: z.ZodString;
|
|
539
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
540
|
+
firstSeenAt: z.ZodNumber;
|
|
541
|
+
lastSeenAt: z.ZodNumber;
|
|
542
|
+
}, z.core.$strict>>;
|
|
543
|
+
page: z.ZodObject<{
|
|
544
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
545
|
+
limit: z.ZodNumber;
|
|
546
|
+
}, z.core.$strict>;
|
|
547
|
+
}, z.core.$strict>;
|
|
548
|
+
meta: z.ZodObject<{
|
|
549
|
+
requestId: z.ZodString;
|
|
550
|
+
version: z.ZodLiteral<"1.0">;
|
|
551
|
+
}, z.core.$strict>;
|
|
552
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
553
|
+
data: z.ZodObject<{
|
|
554
|
+
generation: z.ZodObject<{
|
|
555
|
+
id: z.ZodString;
|
|
556
|
+
observedAt: z.ZodNumber;
|
|
557
|
+
publishedAt: z.ZodNumber;
|
|
558
|
+
completeness: z.ZodObject<{
|
|
559
|
+
_tag: z.ZodLiteral<"complete">;
|
|
560
|
+
}, z.core.$strict>;
|
|
561
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
562
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
563
|
+
_tag: z.ZodLiteral<"none">;
|
|
564
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
565
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
566
|
+
importedAt: z.ZodNumber;
|
|
567
|
+
recordCount: z.ZodNumber;
|
|
568
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
569
|
+
}, z.core.$strict>], "_tag">;
|
|
570
|
+
}, z.core.$strict>;
|
|
571
|
+
items: z.ZodArray<z.ZodObject<{
|
|
572
|
+
url: z.ZodString;
|
|
573
|
+
feedpath: z.ZodString;
|
|
574
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
575
|
+
firstSeenAt: z.ZodNumber;
|
|
576
|
+
lastSeenAt: z.ZodNumber;
|
|
577
|
+
}, z.core.$strict>>;
|
|
578
|
+
page: z.ZodObject<{
|
|
579
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
580
|
+
limit: z.ZodNumber;
|
|
581
|
+
}, z.core.$strict>;
|
|
582
|
+
}, z.core.$loose>;
|
|
583
|
+
meta: z.ZodObject<{
|
|
584
|
+
requestId: z.ZodString;
|
|
585
|
+
version: z.ZodLiteral<"1.0">;
|
|
586
|
+
}, z.core.$loose>;
|
|
587
|
+
}, z.core.$strip>>;
|
|
588
|
+
};
|
|
589
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
590
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
591
|
+
readonly error: z.ZodObject<{
|
|
592
|
+
code: z.ZodEnum<{
|
|
593
|
+
auth_expired: "auth_expired";
|
|
594
|
+
conflict: "conflict";
|
|
595
|
+
contract_violation: "contract_violation";
|
|
596
|
+
entitlement_required: "entitlement_required";
|
|
597
|
+
forbidden: "forbidden";
|
|
598
|
+
internal_error: "internal_error";
|
|
599
|
+
invalid_request: "invalid_request";
|
|
600
|
+
not_found: "not_found";
|
|
601
|
+
provider_unavailable: "provider_unavailable";
|
|
602
|
+
quota_exhausted: "quota_exhausted";
|
|
603
|
+
rate_limited: "rate_limited";
|
|
604
|
+
site_ambiguous: "site_ambiguous";
|
|
605
|
+
stale_evidence: "stale_evidence";
|
|
606
|
+
unauthorized: "unauthorized";
|
|
607
|
+
}>;
|
|
608
|
+
message: z.ZodString;
|
|
609
|
+
requestId: z.ZodString;
|
|
610
|
+
retryable: z.ZodBoolean;
|
|
611
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
612
|
+
}, z.core.$strict>;
|
|
613
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
614
|
+
readonly error: z.ZodObject<{
|
|
615
|
+
code: z.ZodEnum<{
|
|
616
|
+
auth_expired: "auth_expired";
|
|
617
|
+
conflict: "conflict";
|
|
618
|
+
contract_violation: "contract_violation";
|
|
619
|
+
entitlement_required: "entitlement_required";
|
|
620
|
+
forbidden: "forbidden";
|
|
621
|
+
internal_error: "internal_error";
|
|
622
|
+
invalid_request: "invalid_request";
|
|
623
|
+
not_found: "not_found";
|
|
624
|
+
provider_unavailable: "provider_unavailable";
|
|
625
|
+
quota_exhausted: "quota_exhausted";
|
|
626
|
+
rate_limited: "rate_limited";
|
|
627
|
+
site_ambiguous: "site_ambiguous";
|
|
628
|
+
stale_evidence: "stale_evidence";
|
|
629
|
+
unauthorized: "unauthorized";
|
|
630
|
+
}>;
|
|
631
|
+
message: z.ZodString;
|
|
632
|
+
requestId: z.ZodString;
|
|
633
|
+
retryable: z.ZodBoolean;
|
|
634
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
635
|
+
}, z.core.$loose>;
|
|
636
|
+
}, z.core.$strip>>;
|
|
637
|
+
readonly resources: {
|
|
638
|
+
readonly reads: readonly [{
|
|
639
|
+
readonly type: 'site.sitemaps';
|
|
640
|
+
readonly idFrom: 'params.siteId';
|
|
641
|
+
}];
|
|
642
|
+
readonly changes: readonly [];
|
|
643
|
+
};
|
|
644
|
+
readonly policy: {
|
|
645
|
+
readonly rate: {
|
|
646
|
+
readonly name: 'public-v1-fixed-window';
|
|
647
|
+
readonly limit: 50;
|
|
648
|
+
readonly windowSeconds: 60;
|
|
649
|
+
};
|
|
650
|
+
readonly idempotency: {
|
|
651
|
+
readonly _tag: 'none';
|
|
652
|
+
};
|
|
653
|
+
readonly entitlement: null;
|
|
654
|
+
readonly meter: null;
|
|
655
|
+
};
|
|
656
|
+
readonly lifecycle: {
|
|
657
|
+
readonly introduced: '1.0.0';
|
|
658
|
+
};
|
|
659
|
+
readonly docs: {
|
|
660
|
+
readonly summary: 'List Site sitemap URLs';
|
|
661
|
+
readonly description: 'Returns one cursor page of sitemap membership pinned to an exact upstream generation.';
|
|
662
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
663
|
+
readonly examples: readonly [{
|
|
664
|
+
readonly request: {
|
|
665
|
+
readonly params: {
|
|
666
|
+
readonly siteId: 'site_01JXYZ';
|
|
667
|
+
};
|
|
668
|
+
readonly query: {
|
|
669
|
+
readonly limit: 500;
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
readonly response: {
|
|
673
|
+
readonly status: 200;
|
|
674
|
+
readonly body: {
|
|
675
|
+
readonly data: {
|
|
676
|
+
readonly generation: {
|
|
677
|
+
readonly id: 'generation_01JXYZ';
|
|
678
|
+
readonly observedAt: 1786320000000;
|
|
679
|
+
readonly publishedAt: 1786320000100;
|
|
680
|
+
readonly completeness: {
|
|
681
|
+
readonly _tag: 'complete';
|
|
682
|
+
};
|
|
683
|
+
readonly membershipHistoryAvailableFrom: 1786320000000;
|
|
684
|
+
readonly legacyImport: {
|
|
685
|
+
readonly _tag: 'none';
|
|
686
|
+
};
|
|
687
|
+
};
|
|
688
|
+
readonly items: readonly [];
|
|
689
|
+
readonly page: {
|
|
690
|
+
readonly nextCursor: null;
|
|
691
|
+
readonly limit: 500;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly meta: {
|
|
695
|
+
readonly requestId: 'req_01JXYZ';
|
|
696
|
+
readonly version: '1.0';
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
};
|
|
700
|
+
}];
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
export declare const siteSitemapActionCreateOperation: {
|
|
704
|
+
readonly id: 'sites.sitemaps.action.create';
|
|
705
|
+
readonly method: 'POST';
|
|
706
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps/actions';
|
|
707
|
+
readonly visibility: 'public';
|
|
708
|
+
readonly semantics: {
|
|
709
|
+
readonly kind: 'mutation';
|
|
710
|
+
readonly sideEffects: 'state';
|
|
711
|
+
readonly retry: 'never';
|
|
712
|
+
readonly readConsistency: null;
|
|
713
|
+
};
|
|
714
|
+
readonly auth: {
|
|
715
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
716
|
+
readonly scopes: readonly ["sites:write"];
|
|
717
|
+
readonly minimumRole: 'member';
|
|
718
|
+
readonly ownership: 'site';
|
|
719
|
+
};
|
|
720
|
+
readonly request: {
|
|
721
|
+
readonly params: z.ZodObject<{
|
|
722
|
+
siteId: z.ZodString;
|
|
723
|
+
}, z.core.$strict>;
|
|
724
|
+
readonly query: null;
|
|
725
|
+
readonly headers: null;
|
|
726
|
+
readonly body: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
727
|
+
action: z.ZodLiteral<"submit">;
|
|
728
|
+
sitemapUrl: z.ZodString;
|
|
729
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
730
|
+
action: z.ZodLiteral<"delete">;
|
|
731
|
+
sitemapUrl: z.ZodString;
|
|
732
|
+
}, z.core.$strip>], "action">;
|
|
733
|
+
};
|
|
734
|
+
readonly responses: {
|
|
735
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
736
|
+
data: z.ZodObject<{
|
|
737
|
+
success: z.ZodBoolean;
|
|
738
|
+
action: z.ZodEnum<{
|
|
739
|
+
deleted: "deleted";
|
|
740
|
+
submitted: "submitted";
|
|
741
|
+
}>;
|
|
742
|
+
sitemapUrl: z.ZodString;
|
|
743
|
+
sitemapCount: z.ZodNumber;
|
|
744
|
+
}, z.core.$strict>;
|
|
745
|
+
meta: z.ZodObject<{
|
|
746
|
+
requestId: z.ZodString;
|
|
747
|
+
version: z.ZodLiteral<"1.0">;
|
|
748
|
+
}, z.core.$strict>;
|
|
749
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
750
|
+
data: z.ZodObject<{
|
|
751
|
+
success: z.ZodBoolean;
|
|
752
|
+
action: z.ZodEnum<{
|
|
753
|
+
deleted: "deleted";
|
|
754
|
+
submitted: "submitted";
|
|
755
|
+
}>;
|
|
756
|
+
sitemapUrl: z.ZodString;
|
|
757
|
+
sitemapCount: z.ZodNumber;
|
|
758
|
+
}, z.core.$loose>;
|
|
759
|
+
meta: z.ZodObject<{
|
|
760
|
+
requestId: z.ZodString;
|
|
761
|
+
version: z.ZodLiteral<"1.0">;
|
|
762
|
+
}, z.core.$loose>;
|
|
763
|
+
}, z.core.$strip>>;
|
|
764
|
+
};
|
|
765
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
766
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
767
|
+
readonly error: z.ZodObject<{
|
|
768
|
+
code: z.ZodEnum<{
|
|
769
|
+
auth_expired: "auth_expired";
|
|
770
|
+
conflict: "conflict";
|
|
771
|
+
contract_violation: "contract_violation";
|
|
772
|
+
entitlement_required: "entitlement_required";
|
|
773
|
+
forbidden: "forbidden";
|
|
774
|
+
internal_error: "internal_error";
|
|
775
|
+
invalid_request: "invalid_request";
|
|
776
|
+
not_found: "not_found";
|
|
777
|
+
provider_unavailable: "provider_unavailable";
|
|
778
|
+
quota_exhausted: "quota_exhausted";
|
|
779
|
+
rate_limited: "rate_limited";
|
|
780
|
+
site_ambiguous: "site_ambiguous";
|
|
781
|
+
stale_evidence: "stale_evidence";
|
|
782
|
+
unauthorized: "unauthorized";
|
|
783
|
+
}>;
|
|
784
|
+
message: z.ZodString;
|
|
785
|
+
requestId: z.ZodString;
|
|
786
|
+
retryable: z.ZodBoolean;
|
|
787
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
788
|
+
}, z.core.$strict>;
|
|
789
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
790
|
+
readonly error: z.ZodObject<{
|
|
791
|
+
code: z.ZodEnum<{
|
|
792
|
+
auth_expired: "auth_expired";
|
|
793
|
+
conflict: "conflict";
|
|
794
|
+
contract_violation: "contract_violation";
|
|
795
|
+
entitlement_required: "entitlement_required";
|
|
796
|
+
forbidden: "forbidden";
|
|
797
|
+
internal_error: "internal_error";
|
|
798
|
+
invalid_request: "invalid_request";
|
|
799
|
+
not_found: "not_found";
|
|
800
|
+
provider_unavailable: "provider_unavailable";
|
|
801
|
+
quota_exhausted: "quota_exhausted";
|
|
802
|
+
rate_limited: "rate_limited";
|
|
803
|
+
site_ambiguous: "site_ambiguous";
|
|
804
|
+
stale_evidence: "stale_evidence";
|
|
805
|
+
unauthorized: "unauthorized";
|
|
806
|
+
}>;
|
|
807
|
+
message: z.ZodString;
|
|
808
|
+
requestId: z.ZodString;
|
|
809
|
+
retryable: z.ZodBoolean;
|
|
810
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
811
|
+
}, z.core.$loose>;
|
|
812
|
+
}, z.core.$strip>>;
|
|
813
|
+
readonly resources: {
|
|
814
|
+
readonly reads: readonly [{
|
|
815
|
+
readonly type: 'site.sitemaps';
|
|
816
|
+
readonly idFrom: 'params.siteId';
|
|
817
|
+
}];
|
|
818
|
+
readonly changes: readonly [{
|
|
819
|
+
readonly type: 'site.sitemaps';
|
|
820
|
+
readonly idFrom: 'params.siteId';
|
|
821
|
+
}];
|
|
822
|
+
};
|
|
823
|
+
readonly policy: {
|
|
824
|
+
readonly rate: {
|
|
825
|
+
readonly name: 'public-v1-fixed-window';
|
|
826
|
+
readonly limit: 50;
|
|
827
|
+
readonly windowSeconds: 60;
|
|
828
|
+
};
|
|
829
|
+
readonly idempotency: {
|
|
830
|
+
readonly _tag: 'none';
|
|
831
|
+
};
|
|
832
|
+
readonly entitlement: null;
|
|
833
|
+
readonly meter: null;
|
|
834
|
+
};
|
|
835
|
+
readonly lifecycle: {
|
|
836
|
+
readonly introduced: '1.0.0';
|
|
837
|
+
};
|
|
838
|
+
readonly docs: {
|
|
839
|
+
readonly summary: 'Submit or delete a Site sitemap';
|
|
840
|
+
readonly description: 'Submits or deletes one sitemap through the stored Search Console credential bound to the NuxtSEO Site.';
|
|
841
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
842
|
+
readonly examples: readonly [{
|
|
843
|
+
readonly request: {
|
|
844
|
+
readonly params: {
|
|
845
|
+
readonly siteId: 'site_01JXYZ';
|
|
846
|
+
};
|
|
847
|
+
readonly body: {
|
|
848
|
+
readonly action: 'submit';
|
|
849
|
+
readonly sitemapUrl: 'https://example.com/sitemap.xml';
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
readonly response: {
|
|
853
|
+
readonly status: 200;
|
|
854
|
+
readonly body: {
|
|
855
|
+
readonly data: {
|
|
856
|
+
readonly success: true;
|
|
857
|
+
readonly action: 'submitted';
|
|
858
|
+
readonly sitemapUrl: 'https://example.com/sitemap.xml';
|
|
859
|
+
readonly sitemapCount: 1;
|
|
860
|
+
};
|
|
861
|
+
readonly meta: {
|
|
862
|
+
readonly requestId: 'req_01JXYZ';
|
|
863
|
+
readonly version: '1.0';
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
}];
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
export declare const sitemapsV1Registry: import("./core.js").PublicV1Registry<{
|
|
871
|
+
readonly list: {
|
|
872
|
+
readonly id: 'sites.sitemaps.list';
|
|
873
|
+
readonly method: 'GET';
|
|
874
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps';
|
|
875
|
+
readonly visibility: 'public';
|
|
876
|
+
readonly semantics: {
|
|
877
|
+
readonly kind: 'query';
|
|
878
|
+
readonly sideEffects: 'none';
|
|
879
|
+
readonly retry: 'idempotent';
|
|
880
|
+
readonly readConsistency: 'primary';
|
|
881
|
+
};
|
|
882
|
+
readonly auth: {
|
|
883
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
884
|
+
readonly scopes: readonly ["sites:read"];
|
|
885
|
+
readonly minimumRole: 'viewer';
|
|
886
|
+
readonly ownership: 'site';
|
|
887
|
+
};
|
|
888
|
+
readonly request: {
|
|
889
|
+
readonly params: z.ZodObject<{
|
|
890
|
+
siteId: z.ZodString;
|
|
891
|
+
}, z.core.$strict>;
|
|
892
|
+
readonly query: null;
|
|
893
|
+
readonly headers: null;
|
|
894
|
+
readonly body: null;
|
|
895
|
+
};
|
|
896
|
+
readonly responses: {
|
|
897
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
898
|
+
data: z.ZodObject<{
|
|
899
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
900
|
+
path: z.ZodString;
|
|
901
|
+
urlCount: z.ZodNumber;
|
|
902
|
+
errors: z.ZodNumber;
|
|
903
|
+
warnings: z.ZodNumber;
|
|
904
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
905
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
906
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
907
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
908
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
909
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
910
|
+
}, z.core.$loose>>;
|
|
911
|
+
history: z.ZodArray<z.ZodObject<{
|
|
912
|
+
date: z.ZodString;
|
|
913
|
+
errors: z.ZodNumber;
|
|
914
|
+
warnings: z.ZodNumber;
|
|
915
|
+
urlCount: z.ZodNumber;
|
|
916
|
+
urlDelta: z.ZodNumber;
|
|
917
|
+
}, z.core.$loose>>;
|
|
918
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
919
|
+
date: z.ZodString;
|
|
920
|
+
urlCount: z.ZodNumber;
|
|
921
|
+
changed: z.ZodBoolean;
|
|
922
|
+
urlDelta: z.ZodNumber;
|
|
923
|
+
}, z.core.$loose>>>;
|
|
924
|
+
meta: z.ZodObject<{
|
|
925
|
+
siteUrl: z.ZodString;
|
|
926
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
927
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
928
|
+
sitemapScope: z.ZodObject<{
|
|
929
|
+
excludedCount: z.ZodNumber;
|
|
930
|
+
duplicateCount: z.ZodNumber;
|
|
931
|
+
}, z.core.$strip>;
|
|
932
|
+
}, z.core.$loose>;
|
|
933
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
934
|
+
id: z.ZodString;
|
|
935
|
+
observedAt: z.ZodNumber;
|
|
936
|
+
publishedAt: z.ZodNumber;
|
|
937
|
+
completeness: z.ZodObject<{
|
|
938
|
+
_tag: z.ZodLiteral<"complete">;
|
|
939
|
+
}, z.core.$strict>;
|
|
940
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
941
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
942
|
+
_tag: z.ZodLiteral<"none">;
|
|
943
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
944
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
945
|
+
importedAt: z.ZodNumber;
|
|
946
|
+
recordCount: z.ZodNumber;
|
|
947
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
948
|
+
}, z.core.$strict>], "_tag">;
|
|
949
|
+
}, z.core.$strict>>>;
|
|
950
|
+
}, z.core.$strict>;
|
|
951
|
+
meta: z.ZodObject<{
|
|
952
|
+
requestId: z.ZodString;
|
|
953
|
+
version: z.ZodLiteral<"1.0">;
|
|
954
|
+
}, z.core.$strict>;
|
|
955
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
956
|
+
data: z.ZodObject<{
|
|
957
|
+
sitemaps: z.ZodArray<z.ZodObject<{
|
|
958
|
+
path: z.ZodString;
|
|
959
|
+
urlCount: z.ZodNumber;
|
|
960
|
+
errors: z.ZodNumber;
|
|
961
|
+
warnings: z.ZodNumber;
|
|
962
|
+
isIndex: z.ZodOptional<z.ZodBoolean>;
|
|
963
|
+
contentHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
964
|
+
lastDownloaded: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
965
|
+
lastError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
966
|
+
isPending: z.ZodOptional<z.ZodBoolean>;
|
|
967
|
+
fetchedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
968
|
+
}, z.core.$loose>>;
|
|
969
|
+
history: z.ZodArray<z.ZodObject<{
|
|
970
|
+
date: z.ZodString;
|
|
971
|
+
errors: z.ZodNumber;
|
|
972
|
+
warnings: z.ZodNumber;
|
|
973
|
+
urlCount: z.ZodNumber;
|
|
974
|
+
urlDelta: z.ZodNumber;
|
|
975
|
+
}, z.core.$loose>>;
|
|
976
|
+
perSitemapHistory: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
977
|
+
date: z.ZodString;
|
|
978
|
+
urlCount: z.ZodNumber;
|
|
979
|
+
changed: z.ZodBoolean;
|
|
980
|
+
urlDelta: z.ZodNumber;
|
|
981
|
+
}, z.core.$loose>>>;
|
|
982
|
+
meta: z.ZodObject<{
|
|
983
|
+
siteUrl: z.ZodString;
|
|
984
|
+
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
985
|
+
syncStatus: z.ZodNullable<z.ZodString>;
|
|
986
|
+
sitemapScope: z.ZodObject<{
|
|
987
|
+
excludedCount: z.ZodNumber;
|
|
988
|
+
duplicateCount: z.ZodNumber;
|
|
989
|
+
}, z.core.$strip>;
|
|
990
|
+
}, z.core.$loose>;
|
|
991
|
+
generation: z.ZodNullable<z.ZodLazy<z.ZodObject<{
|
|
992
|
+
id: z.ZodString;
|
|
993
|
+
observedAt: z.ZodNumber;
|
|
994
|
+
publishedAt: z.ZodNumber;
|
|
995
|
+
completeness: z.ZodObject<{
|
|
996
|
+
_tag: z.ZodLiteral<"complete">;
|
|
997
|
+
}, z.core.$strict>;
|
|
998
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
999
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1000
|
+
_tag: z.ZodLiteral<"none">;
|
|
1001
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1002
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
1003
|
+
importedAt: z.ZodNumber;
|
|
1004
|
+
recordCount: z.ZodNumber;
|
|
1005
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
1006
|
+
}, z.core.$strict>], "_tag">;
|
|
1007
|
+
}, z.core.$strict>>>;
|
|
1008
|
+
}, z.core.$loose>;
|
|
1009
|
+
meta: z.ZodObject<{
|
|
1010
|
+
requestId: z.ZodString;
|
|
1011
|
+
version: z.ZodLiteral<"1.0">;
|
|
1012
|
+
}, z.core.$loose>;
|
|
1013
|
+
}, z.core.$strip>>;
|
|
1014
|
+
};
|
|
1015
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
1016
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1017
|
+
readonly error: z.ZodObject<{
|
|
1018
|
+
code: z.ZodEnum<{
|
|
1019
|
+
auth_expired: "auth_expired";
|
|
1020
|
+
conflict: "conflict";
|
|
1021
|
+
contract_violation: "contract_violation";
|
|
1022
|
+
entitlement_required: "entitlement_required";
|
|
1023
|
+
forbidden: "forbidden";
|
|
1024
|
+
internal_error: "internal_error";
|
|
1025
|
+
invalid_request: "invalid_request";
|
|
1026
|
+
not_found: "not_found";
|
|
1027
|
+
provider_unavailable: "provider_unavailable";
|
|
1028
|
+
quota_exhausted: "quota_exhausted";
|
|
1029
|
+
rate_limited: "rate_limited";
|
|
1030
|
+
site_ambiguous: "site_ambiguous";
|
|
1031
|
+
stale_evidence: "stale_evidence";
|
|
1032
|
+
unauthorized: "unauthorized";
|
|
1033
|
+
}>;
|
|
1034
|
+
message: z.ZodString;
|
|
1035
|
+
requestId: z.ZodString;
|
|
1036
|
+
retryable: z.ZodBoolean;
|
|
1037
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1038
|
+
}, z.core.$strict>;
|
|
1039
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1040
|
+
readonly error: z.ZodObject<{
|
|
1041
|
+
code: z.ZodEnum<{
|
|
1042
|
+
auth_expired: "auth_expired";
|
|
1043
|
+
conflict: "conflict";
|
|
1044
|
+
contract_violation: "contract_violation";
|
|
1045
|
+
entitlement_required: "entitlement_required";
|
|
1046
|
+
forbidden: "forbidden";
|
|
1047
|
+
internal_error: "internal_error";
|
|
1048
|
+
invalid_request: "invalid_request";
|
|
1049
|
+
not_found: "not_found";
|
|
1050
|
+
provider_unavailable: "provider_unavailable";
|
|
1051
|
+
quota_exhausted: "quota_exhausted";
|
|
1052
|
+
rate_limited: "rate_limited";
|
|
1053
|
+
site_ambiguous: "site_ambiguous";
|
|
1054
|
+
stale_evidence: "stale_evidence";
|
|
1055
|
+
unauthorized: "unauthorized";
|
|
1056
|
+
}>;
|
|
1057
|
+
message: z.ZodString;
|
|
1058
|
+
requestId: z.ZodString;
|
|
1059
|
+
retryable: z.ZodBoolean;
|
|
1060
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1061
|
+
}, z.core.$loose>;
|
|
1062
|
+
}, z.core.$strip>>;
|
|
1063
|
+
readonly resources: {
|
|
1064
|
+
readonly reads: readonly [{
|
|
1065
|
+
readonly type: 'site.sitemaps';
|
|
1066
|
+
readonly idFrom: 'params.siteId';
|
|
1067
|
+
}];
|
|
1068
|
+
readonly changes: readonly [];
|
|
1069
|
+
};
|
|
1070
|
+
readonly policy: {
|
|
1071
|
+
readonly rate: {
|
|
1072
|
+
readonly name: 'public-v1-fixed-window';
|
|
1073
|
+
readonly limit: 50;
|
|
1074
|
+
readonly windowSeconds: 60;
|
|
1075
|
+
};
|
|
1076
|
+
readonly idempotency: {
|
|
1077
|
+
readonly _tag: 'none';
|
|
1078
|
+
};
|
|
1079
|
+
readonly entitlement: null;
|
|
1080
|
+
readonly meter: null;
|
|
1081
|
+
};
|
|
1082
|
+
readonly lifecycle: {
|
|
1083
|
+
readonly introduced: '1.0.0';
|
|
1084
|
+
};
|
|
1085
|
+
readonly docs: {
|
|
1086
|
+
readonly summary: 'List Site sitemaps';
|
|
1087
|
+
readonly description: 'Returns the Search Console sitemap snapshot and its upstream generation for a NuxtSEO Site.';
|
|
1088
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
1089
|
+
readonly examples: readonly [{
|
|
1090
|
+
readonly request: {
|
|
1091
|
+
readonly params: {
|
|
1092
|
+
readonly siteId: 'site_01JXYZ';
|
|
1093
|
+
};
|
|
1094
|
+
};
|
|
1095
|
+
readonly response: {
|
|
1096
|
+
readonly status: 200;
|
|
1097
|
+
readonly body: {
|
|
1098
|
+
readonly data: {
|
|
1099
|
+
readonly sitemaps: readonly [];
|
|
1100
|
+
readonly history: readonly [];
|
|
1101
|
+
readonly perSitemapHistory: {};
|
|
1102
|
+
readonly generation: null;
|
|
1103
|
+
readonly meta: {
|
|
1104
|
+
readonly siteUrl: 'sc-domain:example.com';
|
|
1105
|
+
readonly gscPropertyUrl: 'sc-domain:example.com';
|
|
1106
|
+
readonly syncStatus: 'synced';
|
|
1107
|
+
readonly sitemapScope: {
|
|
1108
|
+
readonly excludedCount: 0;
|
|
1109
|
+
readonly duplicateCount: 0;
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
};
|
|
1113
|
+
readonly meta: {
|
|
1114
|
+
readonly requestId: 'req_01JXYZ';
|
|
1115
|
+
readonly version: '1.0';
|
|
1116
|
+
};
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
}];
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1122
|
+
readonly listUrls: {
|
|
1123
|
+
readonly id: 'sites.sitemaps.urls.list';
|
|
1124
|
+
readonly method: 'GET';
|
|
1125
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps/urls';
|
|
1126
|
+
readonly visibility: 'public';
|
|
1127
|
+
readonly semantics: {
|
|
1128
|
+
readonly kind: 'query';
|
|
1129
|
+
readonly sideEffects: 'none';
|
|
1130
|
+
readonly retry: 'idempotent';
|
|
1131
|
+
readonly readConsistency: 'primary';
|
|
1132
|
+
};
|
|
1133
|
+
readonly auth: {
|
|
1134
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1135
|
+
readonly scopes: readonly ["sites:read"];
|
|
1136
|
+
readonly minimumRole: 'viewer';
|
|
1137
|
+
readonly ownership: 'site';
|
|
1138
|
+
};
|
|
1139
|
+
readonly request: {
|
|
1140
|
+
readonly params: z.ZodObject<{
|
|
1141
|
+
siteId: z.ZodString;
|
|
1142
|
+
}, z.core.$strict>;
|
|
1143
|
+
readonly query: z.ZodObject<{
|
|
1144
|
+
generationId: z.ZodOptional<z.ZodString>;
|
|
1145
|
+
feedpath: z.ZodOptional<z.ZodString>;
|
|
1146
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
1147
|
+
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
1148
|
+
}, z.core.$strict>;
|
|
1149
|
+
readonly headers: null;
|
|
1150
|
+
readonly body: null;
|
|
1151
|
+
};
|
|
1152
|
+
readonly responses: {
|
|
1153
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1154
|
+
data: z.ZodObject<{
|
|
1155
|
+
generation: z.ZodObject<{
|
|
1156
|
+
id: z.ZodString;
|
|
1157
|
+
observedAt: z.ZodNumber;
|
|
1158
|
+
publishedAt: z.ZodNumber;
|
|
1159
|
+
completeness: z.ZodObject<{
|
|
1160
|
+
_tag: z.ZodLiteral<"complete">;
|
|
1161
|
+
}, z.core.$strict>;
|
|
1162
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
1163
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1164
|
+
_tag: z.ZodLiteral<"none">;
|
|
1165
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1166
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
1167
|
+
importedAt: z.ZodNumber;
|
|
1168
|
+
recordCount: z.ZodNumber;
|
|
1169
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
1170
|
+
}, z.core.$strict>], "_tag">;
|
|
1171
|
+
}, z.core.$strict>;
|
|
1172
|
+
items: z.ZodArray<z.ZodObject<{
|
|
1173
|
+
url: z.ZodString;
|
|
1174
|
+
feedpath: z.ZodString;
|
|
1175
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
1176
|
+
firstSeenAt: z.ZodNumber;
|
|
1177
|
+
lastSeenAt: z.ZodNumber;
|
|
1178
|
+
}, z.core.$strict>>;
|
|
1179
|
+
page: z.ZodObject<{
|
|
1180
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
1181
|
+
limit: z.ZodNumber;
|
|
1182
|
+
}, z.core.$strict>;
|
|
1183
|
+
}, z.core.$strict>;
|
|
1184
|
+
meta: z.ZodObject<{
|
|
1185
|
+
requestId: z.ZodString;
|
|
1186
|
+
version: z.ZodLiteral<"1.0">;
|
|
1187
|
+
}, z.core.$strict>;
|
|
1188
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1189
|
+
data: z.ZodObject<{
|
|
1190
|
+
generation: z.ZodObject<{
|
|
1191
|
+
id: z.ZodString;
|
|
1192
|
+
observedAt: z.ZodNumber;
|
|
1193
|
+
publishedAt: z.ZodNumber;
|
|
1194
|
+
completeness: z.ZodObject<{
|
|
1195
|
+
_tag: z.ZodLiteral<"complete">;
|
|
1196
|
+
}, z.core.$strict>;
|
|
1197
|
+
membershipHistoryAvailableFrom: z.ZodNullable<z.ZodNumber>;
|
|
1198
|
+
legacyImport: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1199
|
+
_tag: z.ZodLiteral<"none">;
|
|
1200
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1201
|
+
_tag: z.ZodLiteral<"metadata_only">;
|
|
1202
|
+
importedAt: z.ZodNumber;
|
|
1203
|
+
recordCount: z.ZodNumber;
|
|
1204
|
+
source: z.ZodLiteral<"gsc_sitemaps">;
|
|
1205
|
+
}, z.core.$strict>], "_tag">;
|
|
1206
|
+
}, z.core.$strict>;
|
|
1207
|
+
items: z.ZodArray<z.ZodObject<{
|
|
1208
|
+
url: z.ZodString;
|
|
1209
|
+
feedpath: z.ZodString;
|
|
1210
|
+
lastmod: z.ZodNullable<z.ZodString>;
|
|
1211
|
+
firstSeenAt: z.ZodNumber;
|
|
1212
|
+
lastSeenAt: z.ZodNumber;
|
|
1213
|
+
}, z.core.$strict>>;
|
|
1214
|
+
page: z.ZodObject<{
|
|
1215
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
1216
|
+
limit: z.ZodNumber;
|
|
1217
|
+
}, z.core.$strict>;
|
|
1218
|
+
}, z.core.$loose>;
|
|
1219
|
+
meta: z.ZodObject<{
|
|
1220
|
+
requestId: z.ZodString;
|
|
1221
|
+
version: z.ZodLiteral<"1.0">;
|
|
1222
|
+
}, z.core.$loose>;
|
|
1223
|
+
}, z.core.$strip>>;
|
|
1224
|
+
};
|
|
1225
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
1226
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1227
|
+
readonly error: z.ZodObject<{
|
|
1228
|
+
code: z.ZodEnum<{
|
|
1229
|
+
auth_expired: "auth_expired";
|
|
1230
|
+
conflict: "conflict";
|
|
1231
|
+
contract_violation: "contract_violation";
|
|
1232
|
+
entitlement_required: "entitlement_required";
|
|
1233
|
+
forbidden: "forbidden";
|
|
1234
|
+
internal_error: "internal_error";
|
|
1235
|
+
invalid_request: "invalid_request";
|
|
1236
|
+
not_found: "not_found";
|
|
1237
|
+
provider_unavailable: "provider_unavailable";
|
|
1238
|
+
quota_exhausted: "quota_exhausted";
|
|
1239
|
+
rate_limited: "rate_limited";
|
|
1240
|
+
site_ambiguous: "site_ambiguous";
|
|
1241
|
+
stale_evidence: "stale_evidence";
|
|
1242
|
+
unauthorized: "unauthorized";
|
|
1243
|
+
}>;
|
|
1244
|
+
message: z.ZodString;
|
|
1245
|
+
requestId: z.ZodString;
|
|
1246
|
+
retryable: z.ZodBoolean;
|
|
1247
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1248
|
+
}, z.core.$strict>;
|
|
1249
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1250
|
+
readonly error: z.ZodObject<{
|
|
1251
|
+
code: z.ZodEnum<{
|
|
1252
|
+
auth_expired: "auth_expired";
|
|
1253
|
+
conflict: "conflict";
|
|
1254
|
+
contract_violation: "contract_violation";
|
|
1255
|
+
entitlement_required: "entitlement_required";
|
|
1256
|
+
forbidden: "forbidden";
|
|
1257
|
+
internal_error: "internal_error";
|
|
1258
|
+
invalid_request: "invalid_request";
|
|
1259
|
+
not_found: "not_found";
|
|
1260
|
+
provider_unavailable: "provider_unavailable";
|
|
1261
|
+
quota_exhausted: "quota_exhausted";
|
|
1262
|
+
rate_limited: "rate_limited";
|
|
1263
|
+
site_ambiguous: "site_ambiguous";
|
|
1264
|
+
stale_evidence: "stale_evidence";
|
|
1265
|
+
unauthorized: "unauthorized";
|
|
1266
|
+
}>;
|
|
1267
|
+
message: z.ZodString;
|
|
1268
|
+
requestId: z.ZodString;
|
|
1269
|
+
retryable: z.ZodBoolean;
|
|
1270
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1271
|
+
}, z.core.$loose>;
|
|
1272
|
+
}, z.core.$strip>>;
|
|
1273
|
+
readonly resources: {
|
|
1274
|
+
readonly reads: readonly [{
|
|
1275
|
+
readonly type: 'site.sitemaps';
|
|
1276
|
+
readonly idFrom: 'params.siteId';
|
|
1277
|
+
}];
|
|
1278
|
+
readonly changes: readonly [];
|
|
1279
|
+
};
|
|
1280
|
+
readonly policy: {
|
|
1281
|
+
readonly rate: {
|
|
1282
|
+
readonly name: 'public-v1-fixed-window';
|
|
1283
|
+
readonly limit: 50;
|
|
1284
|
+
readonly windowSeconds: 60;
|
|
1285
|
+
};
|
|
1286
|
+
readonly idempotency: {
|
|
1287
|
+
readonly _tag: 'none';
|
|
1288
|
+
};
|
|
1289
|
+
readonly entitlement: null;
|
|
1290
|
+
readonly meter: null;
|
|
1291
|
+
};
|
|
1292
|
+
readonly lifecycle: {
|
|
1293
|
+
readonly introduced: '1.0.0';
|
|
1294
|
+
};
|
|
1295
|
+
readonly docs: {
|
|
1296
|
+
readonly summary: 'List Site sitemap URLs';
|
|
1297
|
+
readonly description: 'Returns one cursor page of sitemap membership pinned to an exact upstream generation.';
|
|
1298
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
1299
|
+
readonly examples: readonly [{
|
|
1300
|
+
readonly request: {
|
|
1301
|
+
readonly params: {
|
|
1302
|
+
readonly siteId: 'site_01JXYZ';
|
|
1303
|
+
};
|
|
1304
|
+
readonly query: {
|
|
1305
|
+
readonly limit: 500;
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
readonly response: {
|
|
1309
|
+
readonly status: 200;
|
|
1310
|
+
readonly body: {
|
|
1311
|
+
readonly data: {
|
|
1312
|
+
readonly generation: {
|
|
1313
|
+
readonly id: 'generation_01JXYZ';
|
|
1314
|
+
readonly observedAt: 1786320000000;
|
|
1315
|
+
readonly publishedAt: 1786320000100;
|
|
1316
|
+
readonly completeness: {
|
|
1317
|
+
readonly _tag: 'complete';
|
|
1318
|
+
};
|
|
1319
|
+
readonly membershipHistoryAvailableFrom: 1786320000000;
|
|
1320
|
+
readonly legacyImport: {
|
|
1321
|
+
readonly _tag: 'none';
|
|
1322
|
+
};
|
|
1323
|
+
};
|
|
1324
|
+
readonly items: readonly [];
|
|
1325
|
+
readonly page: {
|
|
1326
|
+
readonly nextCursor: null;
|
|
1327
|
+
readonly limit: 500;
|
|
1328
|
+
};
|
|
1329
|
+
};
|
|
1330
|
+
readonly meta: {
|
|
1331
|
+
readonly requestId: 'req_01JXYZ';
|
|
1332
|
+
readonly version: '1.0';
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
};
|
|
1336
|
+
}];
|
|
1337
|
+
};
|
|
1338
|
+
};
|
|
1339
|
+
readonly createAction: {
|
|
1340
|
+
readonly id: 'sites.sitemaps.action.create';
|
|
1341
|
+
readonly method: 'POST';
|
|
1342
|
+
readonly path: '/api/v1/sites/{siteId}/sitemaps/actions';
|
|
1343
|
+
readonly visibility: 'public';
|
|
1344
|
+
readonly semantics: {
|
|
1345
|
+
readonly kind: 'mutation';
|
|
1346
|
+
readonly sideEffects: 'state';
|
|
1347
|
+
readonly retry: 'never';
|
|
1348
|
+
readonly readConsistency: null;
|
|
1349
|
+
};
|
|
1350
|
+
readonly auth: {
|
|
1351
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1352
|
+
readonly scopes: readonly ["sites:write"];
|
|
1353
|
+
readonly minimumRole: 'member';
|
|
1354
|
+
readonly ownership: 'site';
|
|
1355
|
+
};
|
|
1356
|
+
readonly request: {
|
|
1357
|
+
readonly params: z.ZodObject<{
|
|
1358
|
+
siteId: z.ZodString;
|
|
1359
|
+
}, z.core.$strict>;
|
|
1360
|
+
readonly query: null;
|
|
1361
|
+
readonly headers: null;
|
|
1362
|
+
readonly body: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1363
|
+
action: z.ZodLiteral<"submit">;
|
|
1364
|
+
sitemapUrl: z.ZodString;
|
|
1365
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1366
|
+
action: z.ZodLiteral<"delete">;
|
|
1367
|
+
sitemapUrl: z.ZodString;
|
|
1368
|
+
}, z.core.$strip>], "action">;
|
|
1369
|
+
};
|
|
1370
|
+
readonly responses: {
|
|
1371
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1372
|
+
data: z.ZodObject<{
|
|
1373
|
+
success: z.ZodBoolean;
|
|
1374
|
+
action: z.ZodEnum<{
|
|
1375
|
+
deleted: "deleted";
|
|
1376
|
+
submitted: "submitted";
|
|
1377
|
+
}>;
|
|
1378
|
+
sitemapUrl: z.ZodString;
|
|
1379
|
+
sitemapCount: z.ZodNumber;
|
|
1380
|
+
}, z.core.$strict>;
|
|
1381
|
+
meta: z.ZodObject<{
|
|
1382
|
+
requestId: z.ZodString;
|
|
1383
|
+
version: z.ZodLiteral<"1.0">;
|
|
1384
|
+
}, z.core.$strict>;
|
|
1385
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1386
|
+
data: z.ZodObject<{
|
|
1387
|
+
success: z.ZodBoolean;
|
|
1388
|
+
action: z.ZodEnum<{
|
|
1389
|
+
deleted: "deleted";
|
|
1390
|
+
submitted: "submitted";
|
|
1391
|
+
}>;
|
|
1392
|
+
sitemapUrl: z.ZodString;
|
|
1393
|
+
sitemapCount: z.ZodNumber;
|
|
1394
|
+
}, z.core.$loose>;
|
|
1395
|
+
meta: z.ZodObject<{
|
|
1396
|
+
requestId: z.ZodString;
|
|
1397
|
+
version: z.ZodLiteral<"1.0">;
|
|
1398
|
+
}, z.core.$loose>;
|
|
1399
|
+
}, z.core.$strip>>;
|
|
1400
|
+
};
|
|
1401
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "provider_unavailable", "contract_violation", "internal_error"];
|
|
1402
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1403
|
+
readonly error: z.ZodObject<{
|
|
1404
|
+
code: z.ZodEnum<{
|
|
1405
|
+
auth_expired: "auth_expired";
|
|
1406
|
+
conflict: "conflict";
|
|
1407
|
+
contract_violation: "contract_violation";
|
|
1408
|
+
entitlement_required: "entitlement_required";
|
|
1409
|
+
forbidden: "forbidden";
|
|
1410
|
+
internal_error: "internal_error";
|
|
1411
|
+
invalid_request: "invalid_request";
|
|
1412
|
+
not_found: "not_found";
|
|
1413
|
+
provider_unavailable: "provider_unavailable";
|
|
1414
|
+
quota_exhausted: "quota_exhausted";
|
|
1415
|
+
rate_limited: "rate_limited";
|
|
1416
|
+
site_ambiguous: "site_ambiguous";
|
|
1417
|
+
stale_evidence: "stale_evidence";
|
|
1418
|
+
unauthorized: "unauthorized";
|
|
1419
|
+
}>;
|
|
1420
|
+
message: z.ZodString;
|
|
1421
|
+
requestId: z.ZodString;
|
|
1422
|
+
retryable: z.ZodBoolean;
|
|
1423
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1424
|
+
}, z.core.$strict>;
|
|
1425
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1426
|
+
readonly error: z.ZodObject<{
|
|
1427
|
+
code: z.ZodEnum<{
|
|
1428
|
+
auth_expired: "auth_expired";
|
|
1429
|
+
conflict: "conflict";
|
|
1430
|
+
contract_violation: "contract_violation";
|
|
1431
|
+
entitlement_required: "entitlement_required";
|
|
1432
|
+
forbidden: "forbidden";
|
|
1433
|
+
internal_error: "internal_error";
|
|
1434
|
+
invalid_request: "invalid_request";
|
|
1435
|
+
not_found: "not_found";
|
|
1436
|
+
provider_unavailable: "provider_unavailable";
|
|
1437
|
+
quota_exhausted: "quota_exhausted";
|
|
1438
|
+
rate_limited: "rate_limited";
|
|
1439
|
+
site_ambiguous: "site_ambiguous";
|
|
1440
|
+
stale_evidence: "stale_evidence";
|
|
1441
|
+
unauthorized: "unauthorized";
|
|
1442
|
+
}>;
|
|
1443
|
+
message: z.ZodString;
|
|
1444
|
+
requestId: z.ZodString;
|
|
1445
|
+
retryable: z.ZodBoolean;
|
|
1446
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1447
|
+
}, z.core.$loose>;
|
|
1448
|
+
}, z.core.$strip>>;
|
|
1449
|
+
readonly resources: {
|
|
1450
|
+
readonly reads: readonly [{
|
|
1451
|
+
readonly type: 'site.sitemaps';
|
|
1452
|
+
readonly idFrom: 'params.siteId';
|
|
1453
|
+
}];
|
|
1454
|
+
readonly changes: readonly [{
|
|
1455
|
+
readonly type: 'site.sitemaps';
|
|
1456
|
+
readonly idFrom: 'params.siteId';
|
|
1457
|
+
}];
|
|
1458
|
+
};
|
|
1459
|
+
readonly policy: {
|
|
1460
|
+
readonly rate: {
|
|
1461
|
+
readonly name: 'public-v1-fixed-window';
|
|
1462
|
+
readonly limit: 50;
|
|
1463
|
+
readonly windowSeconds: 60;
|
|
1464
|
+
};
|
|
1465
|
+
readonly idempotency: {
|
|
1466
|
+
readonly _tag: 'none';
|
|
1467
|
+
};
|
|
1468
|
+
readonly entitlement: null;
|
|
1469
|
+
readonly meter: null;
|
|
1470
|
+
};
|
|
1471
|
+
readonly lifecycle: {
|
|
1472
|
+
readonly introduced: '1.0.0';
|
|
1473
|
+
};
|
|
1474
|
+
readonly docs: {
|
|
1475
|
+
readonly summary: 'Submit or delete a Site sitemap';
|
|
1476
|
+
readonly description: 'Submits or deletes one sitemap through the stored Search Console credential bound to the NuxtSEO Site.';
|
|
1477
|
+
readonly tags: readonly ["Sites", "Sitemaps"];
|
|
1478
|
+
readonly examples: readonly [{
|
|
1479
|
+
readonly request: {
|
|
1480
|
+
readonly params: {
|
|
1481
|
+
readonly siteId: 'site_01JXYZ';
|
|
1482
|
+
};
|
|
1483
|
+
readonly body: {
|
|
1484
|
+
readonly action: 'submit';
|
|
1485
|
+
readonly sitemapUrl: 'https://example.com/sitemap.xml';
|
|
1486
|
+
};
|
|
1487
|
+
};
|
|
1488
|
+
readonly response: {
|
|
1489
|
+
readonly status: 200;
|
|
1490
|
+
readonly body: {
|
|
1491
|
+
readonly data: {
|
|
1492
|
+
readonly success: true;
|
|
1493
|
+
readonly action: 'submitted';
|
|
1494
|
+
readonly sitemapUrl: 'https://example.com/sitemap.xml';
|
|
1495
|
+
readonly sitemapCount: 1;
|
|
1496
|
+
};
|
|
1497
|
+
readonly meta: {
|
|
1498
|
+
readonly requestId: 'req_01JXYZ';
|
|
1499
|
+
readonly version: '1.0';
|
|
1500
|
+
};
|
|
1501
|
+
};
|
|
1502
|
+
};
|
|
1503
|
+
}];
|
|
1504
|
+
};
|
|
1505
|
+
};
|
|
1506
|
+
}>;
|