@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,591 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
export declare const siteSearchConsoleStatusSchema: z.ZodEnum<{
|
|
3
|
+
action_required: "action_required";
|
|
4
|
+
connected: "connected";
|
|
5
|
+
disconnected: "disconnected";
|
|
6
|
+
}>;
|
|
7
|
+
export declare const siteMonitoringModeSchema: z.ZodNullable<z.ZodEnum<{
|
|
8
|
+
full_monitoring: "full_monitoring";
|
|
9
|
+
search_tracking: "search_tracking";
|
|
10
|
+
}>>;
|
|
11
|
+
export declare const siteMonitoringStatusSchema: z.ZodEnum<{
|
|
12
|
+
active: "active";
|
|
13
|
+
archived: "archived";
|
|
14
|
+
paused: "paused";
|
|
15
|
+
unconfigured: "unconfigured";
|
|
16
|
+
}>;
|
|
17
|
+
export declare const siteSummaryProducerSchema: z.ZodObject<{
|
|
18
|
+
id: z.ZodString;
|
|
19
|
+
name: z.ZodNullable<z.ZodString>;
|
|
20
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
21
|
+
searchConsole: z.ZodObject<{
|
|
22
|
+
status: z.ZodEnum<{
|
|
23
|
+
action_required: "action_required";
|
|
24
|
+
connected: "connected";
|
|
25
|
+
disconnected: "disconnected";
|
|
26
|
+
}>;
|
|
27
|
+
}, z.core.$strict>;
|
|
28
|
+
monitoring: z.ZodObject<{
|
|
29
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
30
|
+
full_monitoring: "full_monitoring";
|
|
31
|
+
search_tracking: "search_tracking";
|
|
32
|
+
}>>;
|
|
33
|
+
status: z.ZodEnum<{
|
|
34
|
+
active: "active";
|
|
35
|
+
archived: "archived";
|
|
36
|
+
paused: "paused";
|
|
37
|
+
unconfigured: "unconfigured";
|
|
38
|
+
}>;
|
|
39
|
+
analysisAvailable: z.ZodBoolean;
|
|
40
|
+
}, z.core.$strict>;
|
|
41
|
+
}, z.core.$strict>;
|
|
42
|
+
export declare const siteSummaryClientSchema: z.ZodObject<{
|
|
43
|
+
id: z.ZodString;
|
|
44
|
+
name: z.ZodNullable<z.ZodString>;
|
|
45
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
46
|
+
searchConsole: z.ZodObject<{
|
|
47
|
+
status: z.ZodEnum<{
|
|
48
|
+
action_required: "action_required";
|
|
49
|
+
connected: "connected";
|
|
50
|
+
disconnected: "disconnected";
|
|
51
|
+
}>;
|
|
52
|
+
}, z.core.$loose>;
|
|
53
|
+
monitoring: z.ZodObject<{
|
|
54
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
55
|
+
full_monitoring: "full_monitoring";
|
|
56
|
+
search_tracking: "search_tracking";
|
|
57
|
+
}>>;
|
|
58
|
+
status: z.ZodEnum<{
|
|
59
|
+
active: "active";
|
|
60
|
+
archived: "archived";
|
|
61
|
+
paused: "paused";
|
|
62
|
+
unconfigured: "unconfigured";
|
|
63
|
+
}>;
|
|
64
|
+
analysisAvailable: z.ZodBoolean;
|
|
65
|
+
}, z.core.$loose>;
|
|
66
|
+
}, z.core.$loose>;
|
|
67
|
+
export declare const sitesListDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
68
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
69
|
+
id: z.ZodString;
|
|
70
|
+
name: z.ZodNullable<z.ZodString>;
|
|
71
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
72
|
+
searchConsole: z.ZodObject<{
|
|
73
|
+
status: z.ZodEnum<{
|
|
74
|
+
action_required: "action_required";
|
|
75
|
+
connected: "connected";
|
|
76
|
+
disconnected: "disconnected";
|
|
77
|
+
}>;
|
|
78
|
+
}, z.core.$strict>;
|
|
79
|
+
monitoring: z.ZodObject<{
|
|
80
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
81
|
+
full_monitoring: "full_monitoring";
|
|
82
|
+
search_tracking: "search_tracking";
|
|
83
|
+
}>>;
|
|
84
|
+
status: z.ZodEnum<{
|
|
85
|
+
active: "active";
|
|
86
|
+
archived: "archived";
|
|
87
|
+
paused: "paused";
|
|
88
|
+
unconfigured: "unconfigured";
|
|
89
|
+
}>;
|
|
90
|
+
analysisAvailable: z.ZodBoolean;
|
|
91
|
+
}, z.core.$strict>;
|
|
92
|
+
}, z.core.$strict>>;
|
|
93
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
94
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
95
|
+
id: z.ZodString;
|
|
96
|
+
name: z.ZodNullable<z.ZodString>;
|
|
97
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
98
|
+
searchConsole: z.ZodObject<{
|
|
99
|
+
status: z.ZodEnum<{
|
|
100
|
+
action_required: "action_required";
|
|
101
|
+
connected: "connected";
|
|
102
|
+
disconnected: "disconnected";
|
|
103
|
+
}>;
|
|
104
|
+
}, z.core.$loose>;
|
|
105
|
+
monitoring: z.ZodObject<{
|
|
106
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
107
|
+
full_monitoring: "full_monitoring";
|
|
108
|
+
search_tracking: "search_tracking";
|
|
109
|
+
}>>;
|
|
110
|
+
status: z.ZodEnum<{
|
|
111
|
+
active: "active";
|
|
112
|
+
archived: "archived";
|
|
113
|
+
paused: "paused";
|
|
114
|
+
unconfigured: "unconfigured";
|
|
115
|
+
}>;
|
|
116
|
+
analysisAvailable: z.ZodBoolean;
|
|
117
|
+
}, z.core.$loose>;
|
|
118
|
+
}, z.core.$loose>>;
|
|
119
|
+
}, z.core.$strip>>;
|
|
120
|
+
export declare const sitesListMetaSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
121
|
+
readonly requestId: z.ZodString;
|
|
122
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
123
|
+
readonly total: z.ZodNumber;
|
|
124
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
125
|
+
readonly requestId: z.ZodString;
|
|
126
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
127
|
+
readonly total: z.ZodNumber;
|
|
128
|
+
}, z.core.$strip>>;
|
|
129
|
+
export declare const sitesListResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
130
|
+
data: z.ZodObject<{
|
|
131
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
132
|
+
id: z.ZodString;
|
|
133
|
+
name: z.ZodNullable<z.ZodString>;
|
|
134
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
135
|
+
searchConsole: z.ZodObject<{
|
|
136
|
+
status: z.ZodEnum<{
|
|
137
|
+
action_required: "action_required";
|
|
138
|
+
connected: "connected";
|
|
139
|
+
disconnected: "disconnected";
|
|
140
|
+
}>;
|
|
141
|
+
}, z.core.$strict>;
|
|
142
|
+
monitoring: z.ZodObject<{
|
|
143
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
144
|
+
full_monitoring: "full_monitoring";
|
|
145
|
+
search_tracking: "search_tracking";
|
|
146
|
+
}>>;
|
|
147
|
+
status: z.ZodEnum<{
|
|
148
|
+
active: "active";
|
|
149
|
+
archived: "archived";
|
|
150
|
+
paused: "paused";
|
|
151
|
+
unconfigured: "unconfigured";
|
|
152
|
+
}>;
|
|
153
|
+
analysisAvailable: z.ZodBoolean;
|
|
154
|
+
}, z.core.$strict>;
|
|
155
|
+
}, z.core.$strict>>;
|
|
156
|
+
}, z.core.$strip>;
|
|
157
|
+
meta: z.ZodObject<{
|
|
158
|
+
readonly requestId: z.ZodString;
|
|
159
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
160
|
+
readonly total: z.ZodNumber;
|
|
161
|
+
}, z.core.$strip>;
|
|
162
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
163
|
+
data: z.ZodObject<{
|
|
164
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
165
|
+
id: z.ZodString;
|
|
166
|
+
name: z.ZodNullable<z.ZodString>;
|
|
167
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
168
|
+
searchConsole: z.ZodObject<{
|
|
169
|
+
status: z.ZodEnum<{
|
|
170
|
+
action_required: "action_required";
|
|
171
|
+
connected: "connected";
|
|
172
|
+
disconnected: "disconnected";
|
|
173
|
+
}>;
|
|
174
|
+
}, z.core.$loose>;
|
|
175
|
+
monitoring: z.ZodObject<{
|
|
176
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
177
|
+
full_monitoring: "full_monitoring";
|
|
178
|
+
search_tracking: "search_tracking";
|
|
179
|
+
}>>;
|
|
180
|
+
status: z.ZodEnum<{
|
|
181
|
+
active: "active";
|
|
182
|
+
archived: "archived";
|
|
183
|
+
paused: "paused";
|
|
184
|
+
unconfigured: "unconfigured";
|
|
185
|
+
}>;
|
|
186
|
+
analysisAvailable: z.ZodBoolean;
|
|
187
|
+
}, z.core.$loose>;
|
|
188
|
+
}, z.core.$loose>>;
|
|
189
|
+
}, z.core.$strip>;
|
|
190
|
+
meta: z.ZodObject<{
|
|
191
|
+
readonly requestId: z.ZodString;
|
|
192
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
193
|
+
readonly total: z.ZodNumber;
|
|
194
|
+
}, z.core.$strip>;
|
|
195
|
+
}, z.core.$strip>>;
|
|
196
|
+
export type SiteSummary = z.output<typeof siteSummaryClientSchema>;
|
|
197
|
+
export type SitesListResponse = z.output<typeof sitesListResponseSchema.client>;
|
|
198
|
+
export declare const sitesListOperation: {
|
|
199
|
+
readonly id: 'sites.list';
|
|
200
|
+
readonly method: 'GET';
|
|
201
|
+
readonly path: '/api/v1/sites';
|
|
202
|
+
readonly visibility: 'public';
|
|
203
|
+
readonly semantics: {
|
|
204
|
+
readonly kind: 'query';
|
|
205
|
+
readonly sideEffects: 'none';
|
|
206
|
+
readonly retry: 'idempotent';
|
|
207
|
+
readonly readConsistency: 'primary';
|
|
208
|
+
};
|
|
209
|
+
readonly auth: {
|
|
210
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
211
|
+
readonly scopes: readonly ["sites:read"];
|
|
212
|
+
readonly minimumRole: 'viewer';
|
|
213
|
+
readonly ownership: 'team';
|
|
214
|
+
};
|
|
215
|
+
readonly request: {
|
|
216
|
+
readonly params: null;
|
|
217
|
+
readonly query: null;
|
|
218
|
+
readonly headers: null;
|
|
219
|
+
readonly body: null;
|
|
220
|
+
};
|
|
221
|
+
readonly responses: {
|
|
222
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
223
|
+
data: z.ZodObject<{
|
|
224
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
225
|
+
id: z.ZodString;
|
|
226
|
+
name: z.ZodNullable<z.ZodString>;
|
|
227
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
228
|
+
searchConsole: z.ZodObject<{
|
|
229
|
+
status: z.ZodEnum<{
|
|
230
|
+
action_required: "action_required";
|
|
231
|
+
connected: "connected";
|
|
232
|
+
disconnected: "disconnected";
|
|
233
|
+
}>;
|
|
234
|
+
}, z.core.$strict>;
|
|
235
|
+
monitoring: z.ZodObject<{
|
|
236
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
237
|
+
full_monitoring: "full_monitoring";
|
|
238
|
+
search_tracking: "search_tracking";
|
|
239
|
+
}>>;
|
|
240
|
+
status: z.ZodEnum<{
|
|
241
|
+
active: "active";
|
|
242
|
+
archived: "archived";
|
|
243
|
+
paused: "paused";
|
|
244
|
+
unconfigured: "unconfigured";
|
|
245
|
+
}>;
|
|
246
|
+
analysisAvailable: z.ZodBoolean;
|
|
247
|
+
}, z.core.$strict>;
|
|
248
|
+
}, z.core.$strict>>;
|
|
249
|
+
}, z.core.$strip>;
|
|
250
|
+
meta: z.ZodObject<{
|
|
251
|
+
readonly requestId: z.ZodString;
|
|
252
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
253
|
+
readonly total: z.ZodNumber;
|
|
254
|
+
}, z.core.$strip>;
|
|
255
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
256
|
+
data: z.ZodObject<{
|
|
257
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
258
|
+
id: z.ZodString;
|
|
259
|
+
name: z.ZodNullable<z.ZodString>;
|
|
260
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
261
|
+
searchConsole: z.ZodObject<{
|
|
262
|
+
status: z.ZodEnum<{
|
|
263
|
+
action_required: "action_required";
|
|
264
|
+
connected: "connected";
|
|
265
|
+
disconnected: "disconnected";
|
|
266
|
+
}>;
|
|
267
|
+
}, z.core.$loose>;
|
|
268
|
+
monitoring: z.ZodObject<{
|
|
269
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
270
|
+
full_monitoring: "full_monitoring";
|
|
271
|
+
search_tracking: "search_tracking";
|
|
272
|
+
}>>;
|
|
273
|
+
status: z.ZodEnum<{
|
|
274
|
+
active: "active";
|
|
275
|
+
archived: "archived";
|
|
276
|
+
paused: "paused";
|
|
277
|
+
unconfigured: "unconfigured";
|
|
278
|
+
}>;
|
|
279
|
+
analysisAvailable: z.ZodBoolean;
|
|
280
|
+
}, z.core.$loose>;
|
|
281
|
+
}, z.core.$loose>>;
|
|
282
|
+
}, z.core.$strip>;
|
|
283
|
+
meta: z.ZodObject<{
|
|
284
|
+
readonly requestId: z.ZodString;
|
|
285
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
286
|
+
readonly total: z.ZodNumber;
|
|
287
|
+
}, z.core.$strip>;
|
|
288
|
+
}, z.core.$strip>>;
|
|
289
|
+
};
|
|
290
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
|
|
291
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
292
|
+
readonly error: z.ZodObject<{
|
|
293
|
+
code: z.ZodEnum<{
|
|
294
|
+
auth_expired: "auth_expired";
|
|
295
|
+
conflict: "conflict";
|
|
296
|
+
contract_violation: "contract_violation";
|
|
297
|
+
entitlement_required: "entitlement_required";
|
|
298
|
+
forbidden: "forbidden";
|
|
299
|
+
internal_error: "internal_error";
|
|
300
|
+
invalid_request: "invalid_request";
|
|
301
|
+
not_found: "not_found";
|
|
302
|
+
provider_unavailable: "provider_unavailable";
|
|
303
|
+
quota_exhausted: "quota_exhausted";
|
|
304
|
+
rate_limited: "rate_limited";
|
|
305
|
+
site_ambiguous: "site_ambiguous";
|
|
306
|
+
stale_evidence: "stale_evidence";
|
|
307
|
+
unauthorized: "unauthorized";
|
|
308
|
+
}>;
|
|
309
|
+
message: z.ZodString;
|
|
310
|
+
requestId: z.ZodString;
|
|
311
|
+
retryable: z.ZodBoolean;
|
|
312
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
313
|
+
}, z.core.$strict>;
|
|
314
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
315
|
+
readonly error: z.ZodObject<{
|
|
316
|
+
code: z.ZodEnum<{
|
|
317
|
+
auth_expired: "auth_expired";
|
|
318
|
+
conflict: "conflict";
|
|
319
|
+
contract_violation: "contract_violation";
|
|
320
|
+
entitlement_required: "entitlement_required";
|
|
321
|
+
forbidden: "forbidden";
|
|
322
|
+
internal_error: "internal_error";
|
|
323
|
+
invalid_request: "invalid_request";
|
|
324
|
+
not_found: "not_found";
|
|
325
|
+
provider_unavailable: "provider_unavailable";
|
|
326
|
+
quota_exhausted: "quota_exhausted";
|
|
327
|
+
rate_limited: "rate_limited";
|
|
328
|
+
site_ambiguous: "site_ambiguous";
|
|
329
|
+
stale_evidence: "stale_evidence";
|
|
330
|
+
unauthorized: "unauthorized";
|
|
331
|
+
}>;
|
|
332
|
+
message: z.ZodString;
|
|
333
|
+
requestId: z.ZodString;
|
|
334
|
+
retryable: z.ZodBoolean;
|
|
335
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
336
|
+
}, z.core.$loose>;
|
|
337
|
+
}, z.core.$strip>>;
|
|
338
|
+
readonly resources: {
|
|
339
|
+
readonly reads: readonly [{
|
|
340
|
+
readonly type: 'site.collection';
|
|
341
|
+
readonly idFrom: 'team.id';
|
|
342
|
+
}];
|
|
343
|
+
readonly changes: readonly [];
|
|
344
|
+
};
|
|
345
|
+
readonly policy: {
|
|
346
|
+
readonly rate: {
|
|
347
|
+
readonly name: 'public-v1-fixed-window';
|
|
348
|
+
readonly limit: 50;
|
|
349
|
+
readonly windowSeconds: 60;
|
|
350
|
+
};
|
|
351
|
+
readonly idempotency: {
|
|
352
|
+
readonly _tag: 'none';
|
|
353
|
+
};
|
|
354
|
+
readonly entitlement: null;
|
|
355
|
+
readonly meter: null;
|
|
356
|
+
};
|
|
357
|
+
readonly lifecycle: {
|
|
358
|
+
readonly introduced: '1.0.0';
|
|
359
|
+
};
|
|
360
|
+
readonly docs: {
|
|
361
|
+
readonly summary: 'List accessible sites';
|
|
362
|
+
readonly description: 'Lists the stable public identity and current integration state of sites owned by the authenticated Team.';
|
|
363
|
+
readonly tags: readonly ["Sites"];
|
|
364
|
+
readonly examples: readonly [{
|
|
365
|
+
readonly request: {};
|
|
366
|
+
readonly response: {
|
|
367
|
+
readonly status: 200;
|
|
368
|
+
readonly body: {
|
|
369
|
+
readonly data: {
|
|
370
|
+
readonly sites: readonly [{
|
|
371
|
+
readonly id: 'site_01JXYZ';
|
|
372
|
+
readonly name: 'Example';
|
|
373
|
+
readonly url: 'https://example.com/';
|
|
374
|
+
readonly searchConsole: {
|
|
375
|
+
readonly status: 'connected';
|
|
376
|
+
};
|
|
377
|
+
readonly monitoring: {
|
|
378
|
+
readonly mode: 'full_monitoring';
|
|
379
|
+
readonly status: 'active';
|
|
380
|
+
readonly analysisAvailable: true;
|
|
381
|
+
};
|
|
382
|
+
}];
|
|
383
|
+
};
|
|
384
|
+
readonly meta: {
|
|
385
|
+
readonly requestId: 'req_01JXYZ';
|
|
386
|
+
readonly version: '1.0';
|
|
387
|
+
readonly total: 1;
|
|
388
|
+
};
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
}];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
export declare const sitesV1Registry: import("./core.js").PublicV1Registry<{
|
|
395
|
+
readonly list: {
|
|
396
|
+
readonly id: 'sites.list';
|
|
397
|
+
readonly method: 'GET';
|
|
398
|
+
readonly path: '/api/v1/sites';
|
|
399
|
+
readonly visibility: 'public';
|
|
400
|
+
readonly semantics: {
|
|
401
|
+
readonly kind: 'query';
|
|
402
|
+
readonly sideEffects: 'none';
|
|
403
|
+
readonly retry: 'idempotent';
|
|
404
|
+
readonly readConsistency: 'primary';
|
|
405
|
+
};
|
|
406
|
+
readonly auth: {
|
|
407
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
408
|
+
readonly scopes: readonly ["sites:read"];
|
|
409
|
+
readonly minimumRole: 'viewer';
|
|
410
|
+
readonly ownership: 'team';
|
|
411
|
+
};
|
|
412
|
+
readonly request: {
|
|
413
|
+
readonly params: null;
|
|
414
|
+
readonly query: null;
|
|
415
|
+
readonly headers: null;
|
|
416
|
+
readonly body: null;
|
|
417
|
+
};
|
|
418
|
+
readonly responses: {
|
|
419
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
420
|
+
data: z.ZodObject<{
|
|
421
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
422
|
+
id: z.ZodString;
|
|
423
|
+
name: z.ZodNullable<z.ZodString>;
|
|
424
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
425
|
+
searchConsole: z.ZodObject<{
|
|
426
|
+
status: z.ZodEnum<{
|
|
427
|
+
action_required: "action_required";
|
|
428
|
+
connected: "connected";
|
|
429
|
+
disconnected: "disconnected";
|
|
430
|
+
}>;
|
|
431
|
+
}, z.core.$strict>;
|
|
432
|
+
monitoring: z.ZodObject<{
|
|
433
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
434
|
+
full_monitoring: "full_monitoring";
|
|
435
|
+
search_tracking: "search_tracking";
|
|
436
|
+
}>>;
|
|
437
|
+
status: z.ZodEnum<{
|
|
438
|
+
active: "active";
|
|
439
|
+
archived: "archived";
|
|
440
|
+
paused: "paused";
|
|
441
|
+
unconfigured: "unconfigured";
|
|
442
|
+
}>;
|
|
443
|
+
analysisAvailable: z.ZodBoolean;
|
|
444
|
+
}, z.core.$strict>;
|
|
445
|
+
}, z.core.$strict>>;
|
|
446
|
+
}, z.core.$strip>;
|
|
447
|
+
meta: z.ZodObject<{
|
|
448
|
+
readonly requestId: z.ZodString;
|
|
449
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
450
|
+
readonly total: z.ZodNumber;
|
|
451
|
+
}, z.core.$strip>;
|
|
452
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
453
|
+
data: z.ZodObject<{
|
|
454
|
+
readonly sites: z.ZodArray<z.ZodObject<{
|
|
455
|
+
id: z.ZodString;
|
|
456
|
+
name: z.ZodNullable<z.ZodString>;
|
|
457
|
+
url: z.ZodNullable<z.ZodURL>;
|
|
458
|
+
searchConsole: z.ZodObject<{
|
|
459
|
+
status: z.ZodEnum<{
|
|
460
|
+
action_required: "action_required";
|
|
461
|
+
connected: "connected";
|
|
462
|
+
disconnected: "disconnected";
|
|
463
|
+
}>;
|
|
464
|
+
}, z.core.$loose>;
|
|
465
|
+
monitoring: z.ZodObject<{
|
|
466
|
+
mode: z.ZodNullable<z.ZodEnum<{
|
|
467
|
+
full_monitoring: "full_monitoring";
|
|
468
|
+
search_tracking: "search_tracking";
|
|
469
|
+
}>>;
|
|
470
|
+
status: z.ZodEnum<{
|
|
471
|
+
active: "active";
|
|
472
|
+
archived: "archived";
|
|
473
|
+
paused: "paused";
|
|
474
|
+
unconfigured: "unconfigured";
|
|
475
|
+
}>;
|
|
476
|
+
analysisAvailable: z.ZodBoolean;
|
|
477
|
+
}, z.core.$loose>;
|
|
478
|
+
}, z.core.$loose>>;
|
|
479
|
+
}, z.core.$strip>;
|
|
480
|
+
meta: z.ZodObject<{
|
|
481
|
+
readonly requestId: z.ZodString;
|
|
482
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
483
|
+
readonly total: z.ZodNumber;
|
|
484
|
+
}, z.core.$strip>;
|
|
485
|
+
}, z.core.$strip>>;
|
|
486
|
+
};
|
|
487
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
|
|
488
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
489
|
+
readonly error: z.ZodObject<{
|
|
490
|
+
code: z.ZodEnum<{
|
|
491
|
+
auth_expired: "auth_expired";
|
|
492
|
+
conflict: "conflict";
|
|
493
|
+
contract_violation: "contract_violation";
|
|
494
|
+
entitlement_required: "entitlement_required";
|
|
495
|
+
forbidden: "forbidden";
|
|
496
|
+
internal_error: "internal_error";
|
|
497
|
+
invalid_request: "invalid_request";
|
|
498
|
+
not_found: "not_found";
|
|
499
|
+
provider_unavailable: "provider_unavailable";
|
|
500
|
+
quota_exhausted: "quota_exhausted";
|
|
501
|
+
rate_limited: "rate_limited";
|
|
502
|
+
site_ambiguous: "site_ambiguous";
|
|
503
|
+
stale_evidence: "stale_evidence";
|
|
504
|
+
unauthorized: "unauthorized";
|
|
505
|
+
}>;
|
|
506
|
+
message: z.ZodString;
|
|
507
|
+
requestId: z.ZodString;
|
|
508
|
+
retryable: z.ZodBoolean;
|
|
509
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
510
|
+
}, z.core.$strict>;
|
|
511
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
512
|
+
readonly error: z.ZodObject<{
|
|
513
|
+
code: z.ZodEnum<{
|
|
514
|
+
auth_expired: "auth_expired";
|
|
515
|
+
conflict: "conflict";
|
|
516
|
+
contract_violation: "contract_violation";
|
|
517
|
+
entitlement_required: "entitlement_required";
|
|
518
|
+
forbidden: "forbidden";
|
|
519
|
+
internal_error: "internal_error";
|
|
520
|
+
invalid_request: "invalid_request";
|
|
521
|
+
not_found: "not_found";
|
|
522
|
+
provider_unavailable: "provider_unavailable";
|
|
523
|
+
quota_exhausted: "quota_exhausted";
|
|
524
|
+
rate_limited: "rate_limited";
|
|
525
|
+
site_ambiguous: "site_ambiguous";
|
|
526
|
+
stale_evidence: "stale_evidence";
|
|
527
|
+
unauthorized: "unauthorized";
|
|
528
|
+
}>;
|
|
529
|
+
message: z.ZodString;
|
|
530
|
+
requestId: z.ZodString;
|
|
531
|
+
retryable: z.ZodBoolean;
|
|
532
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
533
|
+
}, z.core.$loose>;
|
|
534
|
+
}, z.core.$strip>>;
|
|
535
|
+
readonly resources: {
|
|
536
|
+
readonly reads: readonly [{
|
|
537
|
+
readonly type: 'site.collection';
|
|
538
|
+
readonly idFrom: 'team.id';
|
|
539
|
+
}];
|
|
540
|
+
readonly changes: readonly [];
|
|
541
|
+
};
|
|
542
|
+
readonly policy: {
|
|
543
|
+
readonly rate: {
|
|
544
|
+
readonly name: 'public-v1-fixed-window';
|
|
545
|
+
readonly limit: 50;
|
|
546
|
+
readonly windowSeconds: 60;
|
|
547
|
+
};
|
|
548
|
+
readonly idempotency: {
|
|
549
|
+
readonly _tag: 'none';
|
|
550
|
+
};
|
|
551
|
+
readonly entitlement: null;
|
|
552
|
+
readonly meter: null;
|
|
553
|
+
};
|
|
554
|
+
readonly lifecycle: {
|
|
555
|
+
readonly introduced: '1.0.0';
|
|
556
|
+
};
|
|
557
|
+
readonly docs: {
|
|
558
|
+
readonly summary: 'List accessible sites';
|
|
559
|
+
readonly description: 'Lists the stable public identity and current integration state of sites owned by the authenticated Team.';
|
|
560
|
+
readonly tags: readonly ["Sites"];
|
|
561
|
+
readonly examples: readonly [{
|
|
562
|
+
readonly request: {};
|
|
563
|
+
readonly response: {
|
|
564
|
+
readonly status: 200;
|
|
565
|
+
readonly body: {
|
|
566
|
+
readonly data: {
|
|
567
|
+
readonly sites: readonly [{
|
|
568
|
+
readonly id: 'site_01JXYZ';
|
|
569
|
+
readonly name: 'Example';
|
|
570
|
+
readonly url: 'https://example.com/';
|
|
571
|
+
readonly searchConsole: {
|
|
572
|
+
readonly status: 'connected';
|
|
573
|
+
};
|
|
574
|
+
readonly monitoring: {
|
|
575
|
+
readonly mode: 'full_monitoring';
|
|
576
|
+
readonly status: 'active';
|
|
577
|
+
readonly analysisAvailable: true;
|
|
578
|
+
};
|
|
579
|
+
}];
|
|
580
|
+
};
|
|
581
|
+
readonly meta: {
|
|
582
|
+
readonly requestId: 'req_01JXYZ';
|
|
583
|
+
readonly version: '1.0';
|
|
584
|
+
readonly total: 1;
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
}];
|
|
589
|
+
};
|
|
590
|
+
};
|
|
591
|
+
}>;
|
package/dist/v1/sites.js
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { z as schema } from 'zod';
|
|
2
|
+
import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1MetaClientSchema, publicV1MetaProducerSchema, publicV1StandardRatePolicy, } from './core.js';
|
|
3
|
+
export const siteSearchConsoleStatusSchema = schema.enum(['connected', 'disconnected', 'action_required']);
|
|
4
|
+
export const siteMonitoringModeSchema = schema.enum(['search_tracking', 'full_monitoring']).nullable();
|
|
5
|
+
export const siteMonitoringStatusSchema = schema.enum(['active', 'paused', 'archived', 'unconfigured']);
|
|
6
|
+
export const siteSummaryProducerSchema = schema.strictObject({
|
|
7
|
+
id: schema.string().min(1),
|
|
8
|
+
name: schema.string().min(1).nullable(),
|
|
9
|
+
url: schema.url().nullable(),
|
|
10
|
+
searchConsole: schema.strictObject({
|
|
11
|
+
status: siteSearchConsoleStatusSchema,
|
|
12
|
+
}),
|
|
13
|
+
monitoring: schema.strictObject({
|
|
14
|
+
mode: siteMonitoringModeSchema,
|
|
15
|
+
status: siteMonitoringStatusSchema,
|
|
16
|
+
analysisAvailable: schema.boolean(),
|
|
17
|
+
}),
|
|
18
|
+
});
|
|
19
|
+
export const siteSummaryClientSchema = schema.looseObject({
|
|
20
|
+
id: schema.string().min(1),
|
|
21
|
+
name: schema.string().min(1).nullable(),
|
|
22
|
+
url: schema.url().nullable(),
|
|
23
|
+
searchConsole: schema.looseObject({
|
|
24
|
+
status: siteSearchConsoleStatusSchema,
|
|
25
|
+
}),
|
|
26
|
+
monitoring: schema.looseObject({
|
|
27
|
+
mode: siteMonitoringModeSchema,
|
|
28
|
+
status: siteMonitoringStatusSchema,
|
|
29
|
+
analysisAvailable: schema.boolean(),
|
|
30
|
+
}),
|
|
31
|
+
});
|
|
32
|
+
export const sitesListDataSchema = defineResponseObject({ sites: schema.array(siteSummaryProducerSchema) }, { sites: schema.array(siteSummaryClientSchema) });
|
|
33
|
+
export const sitesListMetaSchema = defineResponseObject({ ...publicV1MetaProducerSchema.shape, total: schema.number().int().nonnegative() }, { ...publicV1MetaClientSchema.shape, total: schema.number().int().nonnegative() });
|
|
34
|
+
export const sitesListResponseSchema = defineSuccessEnvelope(sitesListDataSchema, sitesListMetaSchema);
|
|
35
|
+
export const sitesListOperation = defineOperation({
|
|
36
|
+
id: 'sites.list',
|
|
37
|
+
method: 'GET',
|
|
38
|
+
path: '/api/v1/sites',
|
|
39
|
+
visibility: 'public',
|
|
40
|
+
semantics: {
|
|
41
|
+
kind: 'query',
|
|
42
|
+
sideEffects: 'none',
|
|
43
|
+
retry: 'idempotent',
|
|
44
|
+
readConsistency: 'primary',
|
|
45
|
+
},
|
|
46
|
+
auth: {
|
|
47
|
+
credentials: ['session', 'api_token'],
|
|
48
|
+
scopes: ['sites:read'],
|
|
49
|
+
minimumRole: 'viewer',
|
|
50
|
+
ownership: 'team',
|
|
51
|
+
},
|
|
52
|
+
request: {
|
|
53
|
+
params: null,
|
|
54
|
+
query: null,
|
|
55
|
+
headers: null,
|
|
56
|
+
body: null,
|
|
57
|
+
},
|
|
58
|
+
responses: { 200: sitesListResponseSchema },
|
|
59
|
+
errors: ['invalid_request', 'unauthorized', 'auth_expired', 'forbidden', 'rate_limited', 'contract_violation', 'internal_error'],
|
|
60
|
+
errorResponse: publicV1ErrorEnvelope,
|
|
61
|
+
resources: {
|
|
62
|
+
reads: [{ type: 'site.collection', idFrom: 'team.id' }],
|
|
63
|
+
changes: [],
|
|
64
|
+
},
|
|
65
|
+
policy: {
|
|
66
|
+
rate: publicV1StandardRatePolicy,
|
|
67
|
+
idempotency: { _tag: 'none' },
|
|
68
|
+
entitlement: null,
|
|
69
|
+
meter: null,
|
|
70
|
+
},
|
|
71
|
+
lifecycle: { introduced: '1.0.0' },
|
|
72
|
+
docs: {
|
|
73
|
+
summary: 'List accessible sites',
|
|
74
|
+
description: 'Lists the stable public identity and current integration state of sites owned by the authenticated Team.',
|
|
75
|
+
tags: ['Sites'],
|
|
76
|
+
examples: [{
|
|
77
|
+
request: {},
|
|
78
|
+
response: {
|
|
79
|
+
status: 200,
|
|
80
|
+
body: {
|
|
81
|
+
data: {
|
|
82
|
+
sites: [{
|
|
83
|
+
id: 'site_01JXYZ',
|
|
84
|
+
name: 'Example',
|
|
85
|
+
url: 'https://example.com/',
|
|
86
|
+
searchConsole: { status: 'connected' },
|
|
87
|
+
monitoring: { mode: 'full_monitoring', status: 'active', analysisAvailable: true },
|
|
88
|
+
}],
|
|
89
|
+
},
|
|
90
|
+
meta: { requestId: 'req_01JXYZ', version: '1.0', total: 1 },
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
}],
|
|
94
|
+
},
|
|
95
|
+
});
|
|
96
|
+
export const sitesV1Registry = defineRegistry({
|
|
97
|
+
feature: 'sites',
|
|
98
|
+
operations: {
|
|
99
|
+
list: sitesListOperation,
|
|
100
|
+
},
|
|
101
|
+
});
|