@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,2745 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
export declare const contentBriefStatusSchema: z.ZodEnum<{
|
|
3
|
+
archived: "archived";
|
|
4
|
+
failed: "failed";
|
|
5
|
+
published: "published";
|
|
6
|
+
queued: "queued";
|
|
7
|
+
ready: "ready";
|
|
8
|
+
researching: "researching";
|
|
9
|
+
stale: "stale";
|
|
10
|
+
written: "written";
|
|
11
|
+
}>;
|
|
12
|
+
export declare const contentBriefSiteParamsSchema: z.ZodObject<{
|
|
13
|
+
siteId: z.ZodString;
|
|
14
|
+
}, z.core.$strict>;
|
|
15
|
+
export declare const contentBriefParamsSchema: z.ZodObject<{
|
|
16
|
+
siteId: z.ZodString;
|
|
17
|
+
briefId: z.ZodString;
|
|
18
|
+
}, z.core.$strict>;
|
|
19
|
+
export declare const contentBriefListQuerySchema: z.ZodObject<{
|
|
20
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
21
|
+
archived: "archived";
|
|
22
|
+
failed: "failed";
|
|
23
|
+
published: "published";
|
|
24
|
+
queued: "queued";
|
|
25
|
+
ready: "ready";
|
|
26
|
+
researching: "researching";
|
|
27
|
+
stale: "stale";
|
|
28
|
+
written: "written";
|
|
29
|
+
}>>;
|
|
30
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
31
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
32
|
+
}, z.core.$strict>;
|
|
33
|
+
export declare const contentBriefCreateBodySchema: z.ZodObject<{
|
|
34
|
+
keyword: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
|
|
35
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
36
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
37
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
38
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
39
|
+
}, z.core.$strict>;
|
|
40
|
+
export declare const contentBriefSerpResultSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
41
|
+
position: z.ZodNumber;
|
|
42
|
+
url: z.ZodURL;
|
|
43
|
+
title: z.ZodString;
|
|
44
|
+
domain: z.ZodString;
|
|
45
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
46
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
47
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
48
|
+
position: z.ZodNumber;
|
|
49
|
+
url: z.ZodURL;
|
|
50
|
+
title: z.ZodString;
|
|
51
|
+
domain: z.ZodString;
|
|
52
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
53
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
54
|
+
}, z.core.$strip>>;
|
|
55
|
+
export declare const contentBriefPaaItemSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
56
|
+
question: z.ZodString;
|
|
57
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
58
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
59
|
+
question: z.ZodString;
|
|
60
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
61
|
+
}, z.core.$strip>>;
|
|
62
|
+
export declare const contentBriefSerpSnapshotSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
63
|
+
fetchedAt: z.ZodISODateTime;
|
|
64
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
65
|
+
position: z.ZodNumber;
|
|
66
|
+
url: z.ZodURL;
|
|
67
|
+
title: z.ZodString;
|
|
68
|
+
domain: z.ZodString;
|
|
69
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
70
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
71
|
+
}, z.core.$strip>>;
|
|
72
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
73
|
+
question: z.ZodString;
|
|
74
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
75
|
+
}, z.core.$strip>>>;
|
|
76
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
77
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
78
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
79
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
80
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
81
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
82
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
83
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
84
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
85
|
+
position: z.ZodNumber;
|
|
86
|
+
url: z.ZodURL;
|
|
87
|
+
title: z.ZodString;
|
|
88
|
+
domain: z.ZodString;
|
|
89
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
90
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
91
|
+
}, z.core.$strip>>;
|
|
92
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
93
|
+
question: z.ZodString;
|
|
94
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
95
|
+
}, z.core.$strip>>>;
|
|
96
|
+
}, z.core.$strip>>;
|
|
97
|
+
export declare const contentBriefOutlineItemSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
98
|
+
level: z.ZodEnum<{
|
|
99
|
+
h1: "h1";
|
|
100
|
+
h2: "h2";
|
|
101
|
+
h3: "h3";
|
|
102
|
+
}>;
|
|
103
|
+
heading: z.ZodString;
|
|
104
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
105
|
+
"from-aio": "from-aio";
|
|
106
|
+
"from-paa": "from-paa";
|
|
107
|
+
gap: "gap";
|
|
108
|
+
"intent-match": "intent-match";
|
|
109
|
+
"your-strength": "your-strength";
|
|
110
|
+
}>>;
|
|
111
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
112
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
113
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
114
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
115
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
116
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
117
|
+
level: z.ZodEnum<{
|
|
118
|
+
h1: "h1";
|
|
119
|
+
h2: "h2";
|
|
120
|
+
h3: "h3";
|
|
121
|
+
}>;
|
|
122
|
+
heading: z.ZodString;
|
|
123
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
124
|
+
"from-aio": "from-aio";
|
|
125
|
+
"from-paa": "from-paa";
|
|
126
|
+
gap: "gap";
|
|
127
|
+
"intent-match": "intent-match";
|
|
128
|
+
"your-strength": "your-strength";
|
|
129
|
+
}>>;
|
|
130
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
131
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
132
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
133
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
134
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
135
|
+
}, z.core.$strip>>;
|
|
136
|
+
export declare const contentBriefInternalLinkSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
137
|
+
url: z.ZodURL;
|
|
138
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
139
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
140
|
+
reasoning: z.ZodString;
|
|
141
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
142
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
143
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
144
|
+
url: z.ZodURL;
|
|
145
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
146
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
147
|
+
reasoning: z.ZodString;
|
|
148
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
149
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
150
|
+
}, z.core.$strip>>;
|
|
151
|
+
export declare const contentBriefPayloadSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
152
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
153
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
154
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
155
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
156
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
157
|
+
fetchedAt: z.ZodISODateTime;
|
|
158
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
159
|
+
position: z.ZodNumber;
|
|
160
|
+
url: z.ZodURL;
|
|
161
|
+
title: z.ZodString;
|
|
162
|
+
domain: z.ZodString;
|
|
163
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
164
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
165
|
+
}, z.core.$strip>>;
|
|
166
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
167
|
+
question: z.ZodString;
|
|
168
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
169
|
+
}, z.core.$strip>>>;
|
|
170
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
171
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
172
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
173
|
+
}, z.core.$strip>>;
|
|
174
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
175
|
+
level: z.ZodEnum<{
|
|
176
|
+
h1: "h1";
|
|
177
|
+
h2: "h2";
|
|
178
|
+
h3: "h3";
|
|
179
|
+
}>;
|
|
180
|
+
heading: z.ZodString;
|
|
181
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
182
|
+
"from-aio": "from-aio";
|
|
183
|
+
"from-paa": "from-paa";
|
|
184
|
+
gap: "gap";
|
|
185
|
+
"intent-match": "intent-match";
|
|
186
|
+
"your-strength": "your-strength";
|
|
187
|
+
}>>;
|
|
188
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
189
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
190
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
191
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
192
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
193
|
+
}, z.core.$strip>>>;
|
|
194
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
195
|
+
url: z.ZodURL;
|
|
196
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
197
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
198
|
+
reasoning: z.ZodString;
|
|
199
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
200
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
201
|
+
}, z.core.$strip>>>;
|
|
202
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
203
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
204
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
205
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
206
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
207
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
208
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
209
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
210
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
211
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
212
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
213
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
214
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
215
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
216
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
217
|
+
position: z.ZodNumber;
|
|
218
|
+
url: z.ZodURL;
|
|
219
|
+
title: z.ZodString;
|
|
220
|
+
domain: z.ZodString;
|
|
221
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
222
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
223
|
+
}, z.core.$strip>>;
|
|
224
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
225
|
+
question: z.ZodString;
|
|
226
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
227
|
+
}, z.core.$strip>>>;
|
|
228
|
+
}, z.core.$strip>>;
|
|
229
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
230
|
+
level: z.ZodEnum<{
|
|
231
|
+
h1: "h1";
|
|
232
|
+
h2: "h2";
|
|
233
|
+
h3: "h3";
|
|
234
|
+
}>;
|
|
235
|
+
heading: z.ZodString;
|
|
236
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
237
|
+
"from-aio": "from-aio";
|
|
238
|
+
"from-paa": "from-paa";
|
|
239
|
+
gap: "gap";
|
|
240
|
+
"intent-match": "intent-match";
|
|
241
|
+
"your-strength": "your-strength";
|
|
242
|
+
}>>;
|
|
243
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
244
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
245
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
246
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
247
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
248
|
+
}, z.core.$strip>>>;
|
|
249
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
250
|
+
url: z.ZodURL;
|
|
251
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
252
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
253
|
+
reasoning: z.ZodString;
|
|
254
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
255
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
256
|
+
}, z.core.$strip>>>;
|
|
257
|
+
}, z.core.$strip>>;
|
|
258
|
+
export declare const contentBriefSummarySchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
259
|
+
id: z.ZodString;
|
|
260
|
+
siteId: z.ZodString;
|
|
261
|
+
keyword: z.ZodString;
|
|
262
|
+
status: z.ZodEnum<{
|
|
263
|
+
archived: "archived";
|
|
264
|
+
failed: "failed";
|
|
265
|
+
published: "published";
|
|
266
|
+
queued: "queued";
|
|
267
|
+
ready: "ready";
|
|
268
|
+
researching: "researching";
|
|
269
|
+
stale: "stale";
|
|
270
|
+
written: "written";
|
|
271
|
+
}>;
|
|
272
|
+
error: z.ZodNullable<z.ZodString>;
|
|
273
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
274
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
275
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
276
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
277
|
+
id: z.ZodString;
|
|
278
|
+
siteId: z.ZodString;
|
|
279
|
+
keyword: z.ZodString;
|
|
280
|
+
status: z.ZodEnum<{
|
|
281
|
+
archived: "archived";
|
|
282
|
+
failed: "failed";
|
|
283
|
+
published: "published";
|
|
284
|
+
queued: "queued";
|
|
285
|
+
ready: "ready";
|
|
286
|
+
researching: "researching";
|
|
287
|
+
stale: "stale";
|
|
288
|
+
written: "written";
|
|
289
|
+
}>;
|
|
290
|
+
error: z.ZodNullable<z.ZodString>;
|
|
291
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
292
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
293
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
294
|
+
}, z.core.$strip>>;
|
|
295
|
+
export declare const contentBriefResourceSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
296
|
+
readonly id: z.ZodString;
|
|
297
|
+
readonly siteId: z.ZodString;
|
|
298
|
+
readonly keyword: z.ZodString;
|
|
299
|
+
readonly status: z.ZodEnum<{
|
|
300
|
+
archived: "archived";
|
|
301
|
+
failed: "failed";
|
|
302
|
+
published: "published";
|
|
303
|
+
queued: "queued";
|
|
304
|
+
ready: "ready";
|
|
305
|
+
researching: "researching";
|
|
306
|
+
stale: "stale";
|
|
307
|
+
written: "written";
|
|
308
|
+
}>;
|
|
309
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
310
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
311
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
312
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
313
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
314
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
315
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
316
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
317
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
318
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
319
|
+
fetchedAt: z.ZodISODateTime;
|
|
320
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
321
|
+
position: z.ZodNumber;
|
|
322
|
+
url: z.ZodURL;
|
|
323
|
+
title: z.ZodString;
|
|
324
|
+
domain: z.ZodString;
|
|
325
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
326
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
327
|
+
}, z.core.$strip>>;
|
|
328
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
329
|
+
question: z.ZodString;
|
|
330
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
331
|
+
}, z.core.$strip>>>;
|
|
332
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
333
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
334
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
335
|
+
}, z.core.$strip>>;
|
|
336
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
337
|
+
level: z.ZodEnum<{
|
|
338
|
+
h1: "h1";
|
|
339
|
+
h2: "h2";
|
|
340
|
+
h3: "h3";
|
|
341
|
+
}>;
|
|
342
|
+
heading: z.ZodString;
|
|
343
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
344
|
+
"from-aio": "from-aio";
|
|
345
|
+
"from-paa": "from-paa";
|
|
346
|
+
gap: "gap";
|
|
347
|
+
"intent-match": "intent-match";
|
|
348
|
+
"your-strength": "your-strength";
|
|
349
|
+
}>>;
|
|
350
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
351
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
352
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
353
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
354
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
355
|
+
}, z.core.$strip>>>;
|
|
356
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
357
|
+
url: z.ZodURL;
|
|
358
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
359
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
360
|
+
reasoning: z.ZodString;
|
|
361
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
362
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
363
|
+
}, z.core.$strip>>>;
|
|
364
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
365
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
366
|
+
}, z.core.$strip>>;
|
|
367
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
368
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
369
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
370
|
+
readonly id: z.ZodString;
|
|
371
|
+
readonly siteId: z.ZodString;
|
|
372
|
+
readonly keyword: z.ZodString;
|
|
373
|
+
readonly status: z.ZodEnum<{
|
|
374
|
+
archived: "archived";
|
|
375
|
+
failed: "failed";
|
|
376
|
+
published: "published";
|
|
377
|
+
queued: "queued";
|
|
378
|
+
ready: "ready";
|
|
379
|
+
researching: "researching";
|
|
380
|
+
stale: "stale";
|
|
381
|
+
written: "written";
|
|
382
|
+
}>;
|
|
383
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
384
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
385
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
386
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
387
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
388
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
389
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
390
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
391
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
392
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
393
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
394
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
395
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
396
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
397
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
398
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
399
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
400
|
+
position: z.ZodNumber;
|
|
401
|
+
url: z.ZodURL;
|
|
402
|
+
title: z.ZodString;
|
|
403
|
+
domain: z.ZodString;
|
|
404
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
405
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
406
|
+
}, z.core.$strip>>;
|
|
407
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
408
|
+
question: z.ZodString;
|
|
409
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
410
|
+
}, z.core.$strip>>>;
|
|
411
|
+
}, z.core.$strip>>;
|
|
412
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
413
|
+
level: z.ZodEnum<{
|
|
414
|
+
h1: "h1";
|
|
415
|
+
h2: "h2";
|
|
416
|
+
h3: "h3";
|
|
417
|
+
}>;
|
|
418
|
+
heading: z.ZodString;
|
|
419
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
420
|
+
"from-aio": "from-aio";
|
|
421
|
+
"from-paa": "from-paa";
|
|
422
|
+
gap: "gap";
|
|
423
|
+
"intent-match": "intent-match";
|
|
424
|
+
"your-strength": "your-strength";
|
|
425
|
+
}>>;
|
|
426
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
427
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
428
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
429
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
430
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
431
|
+
}, z.core.$strip>>>;
|
|
432
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
433
|
+
url: z.ZodURL;
|
|
434
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
435
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
436
|
+
reasoning: z.ZodString;
|
|
437
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
438
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
439
|
+
}, z.core.$strip>>>;
|
|
440
|
+
}, z.core.$strip>>;
|
|
441
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
442
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
443
|
+
}, z.core.$strip>>;
|
|
444
|
+
export declare const contentBriefListDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
445
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
446
|
+
id: z.ZodString;
|
|
447
|
+
siteId: z.ZodString;
|
|
448
|
+
keyword: z.ZodString;
|
|
449
|
+
status: z.ZodEnum<{
|
|
450
|
+
archived: "archived";
|
|
451
|
+
failed: "failed";
|
|
452
|
+
published: "published";
|
|
453
|
+
queued: "queued";
|
|
454
|
+
ready: "ready";
|
|
455
|
+
researching: "researching";
|
|
456
|
+
stale: "stale";
|
|
457
|
+
written: "written";
|
|
458
|
+
}>;
|
|
459
|
+
error: z.ZodNullable<z.ZodString>;
|
|
460
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
461
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
462
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
463
|
+
}, z.core.$strip>>;
|
|
464
|
+
readonly page: z.ZodObject<{
|
|
465
|
+
total: z.ZodNumber;
|
|
466
|
+
limit: z.ZodNumber;
|
|
467
|
+
offset: z.ZodNumber;
|
|
468
|
+
hasMore: z.ZodBoolean;
|
|
469
|
+
}, z.core.$strip>;
|
|
470
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
471
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
472
|
+
id: z.ZodString;
|
|
473
|
+
siteId: z.ZodString;
|
|
474
|
+
keyword: z.ZodString;
|
|
475
|
+
status: z.ZodEnum<{
|
|
476
|
+
archived: "archived";
|
|
477
|
+
failed: "failed";
|
|
478
|
+
published: "published";
|
|
479
|
+
queued: "queued";
|
|
480
|
+
ready: "ready";
|
|
481
|
+
researching: "researching";
|
|
482
|
+
stale: "stale";
|
|
483
|
+
written: "written";
|
|
484
|
+
}>;
|
|
485
|
+
error: z.ZodNullable<z.ZodString>;
|
|
486
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
487
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
488
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
489
|
+
}, z.core.$strip>>;
|
|
490
|
+
readonly page: z.ZodObject<{
|
|
491
|
+
total: z.ZodNumber;
|
|
492
|
+
limit: z.ZodNumber;
|
|
493
|
+
offset: z.ZodNumber;
|
|
494
|
+
hasMore: z.ZodBoolean;
|
|
495
|
+
}, z.core.$strip>;
|
|
496
|
+
}, z.core.$strip>>;
|
|
497
|
+
export declare const contentBriefCreateDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
498
|
+
readonly brief: z.ZodObject<{
|
|
499
|
+
readonly id: z.ZodString;
|
|
500
|
+
readonly siteId: z.ZodString;
|
|
501
|
+
readonly keyword: z.ZodString;
|
|
502
|
+
readonly status: z.ZodEnum<{
|
|
503
|
+
archived: "archived";
|
|
504
|
+
failed: "failed";
|
|
505
|
+
published: "published";
|
|
506
|
+
queued: "queued";
|
|
507
|
+
ready: "ready";
|
|
508
|
+
researching: "researching";
|
|
509
|
+
stale: "stale";
|
|
510
|
+
written: "written";
|
|
511
|
+
}>;
|
|
512
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
513
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
514
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
515
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
516
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
517
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
518
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
519
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
520
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
521
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
522
|
+
fetchedAt: z.ZodISODateTime;
|
|
523
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
524
|
+
position: z.ZodNumber;
|
|
525
|
+
url: z.ZodURL;
|
|
526
|
+
title: z.ZodString;
|
|
527
|
+
domain: z.ZodString;
|
|
528
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
529
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
530
|
+
}, z.core.$strip>>;
|
|
531
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
532
|
+
question: z.ZodString;
|
|
533
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
534
|
+
}, z.core.$strip>>>;
|
|
535
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
536
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
537
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
538
|
+
}, z.core.$strip>>;
|
|
539
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
540
|
+
level: z.ZodEnum<{
|
|
541
|
+
h1: "h1";
|
|
542
|
+
h2: "h2";
|
|
543
|
+
h3: "h3";
|
|
544
|
+
}>;
|
|
545
|
+
heading: z.ZodString;
|
|
546
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
547
|
+
"from-aio": "from-aio";
|
|
548
|
+
"from-paa": "from-paa";
|
|
549
|
+
gap: "gap";
|
|
550
|
+
"intent-match": "intent-match";
|
|
551
|
+
"your-strength": "your-strength";
|
|
552
|
+
}>>;
|
|
553
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
554
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
555
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
556
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
557
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
558
|
+
}, z.core.$strip>>>;
|
|
559
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
560
|
+
url: z.ZodURL;
|
|
561
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
562
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
563
|
+
reasoning: z.ZodString;
|
|
564
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
565
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
566
|
+
}, z.core.$strip>>>;
|
|
567
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
568
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
569
|
+
}, z.core.$strip>>;
|
|
570
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
571
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
572
|
+
}, z.core.$strip>;
|
|
573
|
+
readonly created: z.ZodBoolean;
|
|
574
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
575
|
+
readonly brief: z.ZodObject<{
|
|
576
|
+
readonly id: z.ZodString;
|
|
577
|
+
readonly siteId: z.ZodString;
|
|
578
|
+
readonly keyword: z.ZodString;
|
|
579
|
+
readonly status: z.ZodEnum<{
|
|
580
|
+
archived: "archived";
|
|
581
|
+
failed: "failed";
|
|
582
|
+
published: "published";
|
|
583
|
+
queued: "queued";
|
|
584
|
+
ready: "ready";
|
|
585
|
+
researching: "researching";
|
|
586
|
+
stale: "stale";
|
|
587
|
+
written: "written";
|
|
588
|
+
}>;
|
|
589
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
590
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
591
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
592
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
593
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
594
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
595
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
596
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
597
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
598
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
599
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
600
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
601
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
602
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
603
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
604
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
605
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
606
|
+
position: z.ZodNumber;
|
|
607
|
+
url: z.ZodURL;
|
|
608
|
+
title: z.ZodString;
|
|
609
|
+
domain: z.ZodString;
|
|
610
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
611
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
612
|
+
}, z.core.$strip>>;
|
|
613
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
614
|
+
question: z.ZodString;
|
|
615
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
616
|
+
}, z.core.$strip>>>;
|
|
617
|
+
}, z.core.$strip>>;
|
|
618
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
619
|
+
level: z.ZodEnum<{
|
|
620
|
+
h1: "h1";
|
|
621
|
+
h2: "h2";
|
|
622
|
+
h3: "h3";
|
|
623
|
+
}>;
|
|
624
|
+
heading: z.ZodString;
|
|
625
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
626
|
+
"from-aio": "from-aio";
|
|
627
|
+
"from-paa": "from-paa";
|
|
628
|
+
gap: "gap";
|
|
629
|
+
"intent-match": "intent-match";
|
|
630
|
+
"your-strength": "your-strength";
|
|
631
|
+
}>>;
|
|
632
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
633
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
634
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
635
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
636
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
637
|
+
}, z.core.$strip>>>;
|
|
638
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
639
|
+
url: z.ZodURL;
|
|
640
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
641
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
642
|
+
reasoning: z.ZodString;
|
|
643
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
644
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
645
|
+
}, z.core.$strip>>>;
|
|
646
|
+
}, z.core.$strip>>;
|
|
647
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
648
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
649
|
+
}, z.core.$strip>;
|
|
650
|
+
readonly created: z.ZodBoolean;
|
|
651
|
+
}, z.core.$strip>>;
|
|
652
|
+
export declare const contentBriefListResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
653
|
+
data: z.ZodObject<{
|
|
654
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
655
|
+
id: z.ZodString;
|
|
656
|
+
siteId: z.ZodString;
|
|
657
|
+
keyword: z.ZodString;
|
|
658
|
+
status: z.ZodEnum<{
|
|
659
|
+
archived: "archived";
|
|
660
|
+
failed: "failed";
|
|
661
|
+
published: "published";
|
|
662
|
+
queued: "queued";
|
|
663
|
+
ready: "ready";
|
|
664
|
+
researching: "researching";
|
|
665
|
+
stale: "stale";
|
|
666
|
+
written: "written";
|
|
667
|
+
}>;
|
|
668
|
+
error: z.ZodNullable<z.ZodString>;
|
|
669
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
670
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
671
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
672
|
+
}, z.core.$strip>>;
|
|
673
|
+
readonly page: z.ZodObject<{
|
|
674
|
+
total: z.ZodNumber;
|
|
675
|
+
limit: z.ZodNumber;
|
|
676
|
+
offset: z.ZodNumber;
|
|
677
|
+
hasMore: z.ZodBoolean;
|
|
678
|
+
}, z.core.$strip>;
|
|
679
|
+
}, z.core.$strip>;
|
|
680
|
+
meta: z.ZodObject<{
|
|
681
|
+
requestId: z.ZodString;
|
|
682
|
+
version: z.ZodLiteral<"1.0">;
|
|
683
|
+
}, z.core.$strict>;
|
|
684
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
685
|
+
data: z.ZodObject<{
|
|
686
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
687
|
+
id: z.ZodString;
|
|
688
|
+
siteId: z.ZodString;
|
|
689
|
+
keyword: z.ZodString;
|
|
690
|
+
status: z.ZodEnum<{
|
|
691
|
+
archived: "archived";
|
|
692
|
+
failed: "failed";
|
|
693
|
+
published: "published";
|
|
694
|
+
queued: "queued";
|
|
695
|
+
ready: "ready";
|
|
696
|
+
researching: "researching";
|
|
697
|
+
stale: "stale";
|
|
698
|
+
written: "written";
|
|
699
|
+
}>;
|
|
700
|
+
error: z.ZodNullable<z.ZodString>;
|
|
701
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
702
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
703
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
704
|
+
}, z.core.$strip>>;
|
|
705
|
+
readonly page: z.ZodObject<{
|
|
706
|
+
total: z.ZodNumber;
|
|
707
|
+
limit: z.ZodNumber;
|
|
708
|
+
offset: z.ZodNumber;
|
|
709
|
+
hasMore: z.ZodBoolean;
|
|
710
|
+
}, z.core.$strip>;
|
|
711
|
+
}, z.core.$strip>;
|
|
712
|
+
meta: z.ZodObject<{
|
|
713
|
+
requestId: z.ZodString;
|
|
714
|
+
version: z.ZodLiteral<"1.0">;
|
|
715
|
+
}, z.core.$loose>;
|
|
716
|
+
}, z.core.$strip>>;
|
|
717
|
+
export declare const contentBriefShowResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
718
|
+
data: z.ZodObject<{
|
|
719
|
+
readonly id: z.ZodString;
|
|
720
|
+
readonly siteId: z.ZodString;
|
|
721
|
+
readonly keyword: z.ZodString;
|
|
722
|
+
readonly status: z.ZodEnum<{
|
|
723
|
+
archived: "archived";
|
|
724
|
+
failed: "failed";
|
|
725
|
+
published: "published";
|
|
726
|
+
queued: "queued";
|
|
727
|
+
ready: "ready";
|
|
728
|
+
researching: "researching";
|
|
729
|
+
stale: "stale";
|
|
730
|
+
written: "written";
|
|
731
|
+
}>;
|
|
732
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
733
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
734
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
735
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
736
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
737
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
738
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
739
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
740
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
741
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
742
|
+
fetchedAt: z.ZodISODateTime;
|
|
743
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
744
|
+
position: z.ZodNumber;
|
|
745
|
+
url: z.ZodURL;
|
|
746
|
+
title: z.ZodString;
|
|
747
|
+
domain: z.ZodString;
|
|
748
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
749
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
750
|
+
}, z.core.$strip>>;
|
|
751
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
752
|
+
question: z.ZodString;
|
|
753
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
754
|
+
}, z.core.$strip>>>;
|
|
755
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
756
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
757
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
758
|
+
}, z.core.$strip>>;
|
|
759
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
760
|
+
level: z.ZodEnum<{
|
|
761
|
+
h1: "h1";
|
|
762
|
+
h2: "h2";
|
|
763
|
+
h3: "h3";
|
|
764
|
+
}>;
|
|
765
|
+
heading: z.ZodString;
|
|
766
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
767
|
+
"from-aio": "from-aio";
|
|
768
|
+
"from-paa": "from-paa";
|
|
769
|
+
gap: "gap";
|
|
770
|
+
"intent-match": "intent-match";
|
|
771
|
+
"your-strength": "your-strength";
|
|
772
|
+
}>>;
|
|
773
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
774
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
775
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
776
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
777
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
778
|
+
}, z.core.$strip>>>;
|
|
779
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
780
|
+
url: z.ZodURL;
|
|
781
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
782
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
783
|
+
reasoning: z.ZodString;
|
|
784
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
785
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
786
|
+
}, z.core.$strip>>>;
|
|
787
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
788
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
789
|
+
}, z.core.$strip>>;
|
|
790
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
791
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
792
|
+
}, z.core.$strip>;
|
|
793
|
+
meta: z.ZodObject<{
|
|
794
|
+
requestId: z.ZodString;
|
|
795
|
+
version: z.ZodLiteral<"1.0">;
|
|
796
|
+
}, z.core.$strict>;
|
|
797
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
798
|
+
data: z.ZodObject<{
|
|
799
|
+
readonly id: z.ZodString;
|
|
800
|
+
readonly siteId: z.ZodString;
|
|
801
|
+
readonly keyword: z.ZodString;
|
|
802
|
+
readonly status: z.ZodEnum<{
|
|
803
|
+
archived: "archived";
|
|
804
|
+
failed: "failed";
|
|
805
|
+
published: "published";
|
|
806
|
+
queued: "queued";
|
|
807
|
+
ready: "ready";
|
|
808
|
+
researching: "researching";
|
|
809
|
+
stale: "stale";
|
|
810
|
+
written: "written";
|
|
811
|
+
}>;
|
|
812
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
813
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
814
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
815
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
816
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
817
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
818
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
819
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
820
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
821
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
822
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
823
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
824
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
825
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
826
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
827
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
828
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
829
|
+
position: z.ZodNumber;
|
|
830
|
+
url: z.ZodURL;
|
|
831
|
+
title: z.ZodString;
|
|
832
|
+
domain: z.ZodString;
|
|
833
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
834
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
835
|
+
}, z.core.$strip>>;
|
|
836
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
837
|
+
question: z.ZodString;
|
|
838
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
839
|
+
}, z.core.$strip>>>;
|
|
840
|
+
}, z.core.$strip>>;
|
|
841
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
842
|
+
level: z.ZodEnum<{
|
|
843
|
+
h1: "h1";
|
|
844
|
+
h2: "h2";
|
|
845
|
+
h3: "h3";
|
|
846
|
+
}>;
|
|
847
|
+
heading: z.ZodString;
|
|
848
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
849
|
+
"from-aio": "from-aio";
|
|
850
|
+
"from-paa": "from-paa";
|
|
851
|
+
gap: "gap";
|
|
852
|
+
"intent-match": "intent-match";
|
|
853
|
+
"your-strength": "your-strength";
|
|
854
|
+
}>>;
|
|
855
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
856
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
857
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
858
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
859
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
860
|
+
}, z.core.$strip>>>;
|
|
861
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
862
|
+
url: z.ZodURL;
|
|
863
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
864
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
865
|
+
reasoning: z.ZodString;
|
|
866
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
867
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
868
|
+
}, z.core.$strip>>>;
|
|
869
|
+
}, z.core.$strip>>;
|
|
870
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
871
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
872
|
+
}, z.core.$strip>;
|
|
873
|
+
meta: z.ZodObject<{
|
|
874
|
+
requestId: z.ZodString;
|
|
875
|
+
version: z.ZodLiteral<"1.0">;
|
|
876
|
+
}, z.core.$loose>;
|
|
877
|
+
}, z.core.$strip>>;
|
|
878
|
+
export declare const contentBriefCreateResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
879
|
+
data: z.ZodObject<{
|
|
880
|
+
readonly brief: z.ZodObject<{
|
|
881
|
+
readonly id: z.ZodString;
|
|
882
|
+
readonly siteId: z.ZodString;
|
|
883
|
+
readonly keyword: z.ZodString;
|
|
884
|
+
readonly status: z.ZodEnum<{
|
|
885
|
+
archived: "archived";
|
|
886
|
+
failed: "failed";
|
|
887
|
+
published: "published";
|
|
888
|
+
queued: "queued";
|
|
889
|
+
ready: "ready";
|
|
890
|
+
researching: "researching";
|
|
891
|
+
stale: "stale";
|
|
892
|
+
written: "written";
|
|
893
|
+
}>;
|
|
894
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
895
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
896
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
897
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
898
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
899
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
900
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
901
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
902
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
903
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
904
|
+
fetchedAt: z.ZodISODateTime;
|
|
905
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
906
|
+
position: z.ZodNumber;
|
|
907
|
+
url: z.ZodURL;
|
|
908
|
+
title: z.ZodString;
|
|
909
|
+
domain: z.ZodString;
|
|
910
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
911
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
912
|
+
}, z.core.$strip>>;
|
|
913
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
914
|
+
question: z.ZodString;
|
|
915
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
916
|
+
}, z.core.$strip>>>;
|
|
917
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
918
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
919
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
920
|
+
}, z.core.$strip>>;
|
|
921
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
922
|
+
level: z.ZodEnum<{
|
|
923
|
+
h1: "h1";
|
|
924
|
+
h2: "h2";
|
|
925
|
+
h3: "h3";
|
|
926
|
+
}>;
|
|
927
|
+
heading: z.ZodString;
|
|
928
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
929
|
+
"from-aio": "from-aio";
|
|
930
|
+
"from-paa": "from-paa";
|
|
931
|
+
gap: "gap";
|
|
932
|
+
"intent-match": "intent-match";
|
|
933
|
+
"your-strength": "your-strength";
|
|
934
|
+
}>>;
|
|
935
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
936
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
937
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
938
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
939
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
940
|
+
}, z.core.$strip>>>;
|
|
941
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
942
|
+
url: z.ZodURL;
|
|
943
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
944
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
945
|
+
reasoning: z.ZodString;
|
|
946
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
947
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
948
|
+
}, z.core.$strip>>>;
|
|
949
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
950
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
951
|
+
}, z.core.$strip>>;
|
|
952
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
953
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
954
|
+
}, z.core.$strip>;
|
|
955
|
+
readonly created: z.ZodBoolean;
|
|
956
|
+
}, z.core.$strip>;
|
|
957
|
+
meta: z.ZodObject<{
|
|
958
|
+
requestId: z.ZodString;
|
|
959
|
+
version: z.ZodLiteral<"1.0">;
|
|
960
|
+
}, z.core.$strict>;
|
|
961
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
962
|
+
data: z.ZodObject<{
|
|
963
|
+
readonly brief: z.ZodObject<{
|
|
964
|
+
readonly id: z.ZodString;
|
|
965
|
+
readonly siteId: z.ZodString;
|
|
966
|
+
readonly keyword: z.ZodString;
|
|
967
|
+
readonly status: z.ZodEnum<{
|
|
968
|
+
archived: "archived";
|
|
969
|
+
failed: "failed";
|
|
970
|
+
published: "published";
|
|
971
|
+
queued: "queued";
|
|
972
|
+
ready: "ready";
|
|
973
|
+
researching: "researching";
|
|
974
|
+
stale: "stale";
|
|
975
|
+
written: "written";
|
|
976
|
+
}>;
|
|
977
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
978
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
979
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
980
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
981
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
982
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
983
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
984
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
985
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
986
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
987
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
988
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
989
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
990
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
991
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
992
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
993
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
994
|
+
position: z.ZodNumber;
|
|
995
|
+
url: z.ZodURL;
|
|
996
|
+
title: z.ZodString;
|
|
997
|
+
domain: z.ZodString;
|
|
998
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
999
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
1000
|
+
}, z.core.$strip>>;
|
|
1001
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1002
|
+
question: z.ZodString;
|
|
1003
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
1004
|
+
}, z.core.$strip>>>;
|
|
1005
|
+
}, z.core.$strip>>;
|
|
1006
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1007
|
+
level: z.ZodEnum<{
|
|
1008
|
+
h1: "h1";
|
|
1009
|
+
h2: "h2";
|
|
1010
|
+
h3: "h3";
|
|
1011
|
+
}>;
|
|
1012
|
+
heading: z.ZodString;
|
|
1013
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
1014
|
+
"from-aio": "from-aio";
|
|
1015
|
+
"from-paa": "from-paa";
|
|
1016
|
+
gap: "gap";
|
|
1017
|
+
"intent-match": "intent-match";
|
|
1018
|
+
"your-strength": "your-strength";
|
|
1019
|
+
}>>;
|
|
1020
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
1021
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
1022
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
1023
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
1024
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
1025
|
+
}, z.core.$strip>>>;
|
|
1026
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1027
|
+
url: z.ZodURL;
|
|
1028
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
1029
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
1030
|
+
reasoning: z.ZodString;
|
|
1031
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
1032
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
1033
|
+
}, z.core.$strip>>>;
|
|
1034
|
+
}, z.core.$strip>>;
|
|
1035
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1036
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1037
|
+
}, z.core.$strip>;
|
|
1038
|
+
readonly created: z.ZodBoolean;
|
|
1039
|
+
}, z.core.$strip>;
|
|
1040
|
+
meta: z.ZodObject<{
|
|
1041
|
+
requestId: z.ZodString;
|
|
1042
|
+
version: z.ZodLiteral<"1.0">;
|
|
1043
|
+
}, z.core.$loose>;
|
|
1044
|
+
}, z.core.$strip>>;
|
|
1045
|
+
export type ContentBriefStatus = z.output<typeof contentBriefStatusSchema>;
|
|
1046
|
+
export type ContentBriefListQuery = z.output<typeof contentBriefListQuerySchema>;
|
|
1047
|
+
export type ContentBriefCreateBody = z.output<typeof contentBriefCreateBodySchema>;
|
|
1048
|
+
export type ContentBriefSerpResult = z.output<typeof contentBriefSerpResultSchema.client>;
|
|
1049
|
+
export type ContentBriefPaaItem = z.output<typeof contentBriefPaaItemSchema.client>;
|
|
1050
|
+
export type ContentBriefSerpSnapshot = z.output<typeof contentBriefSerpSnapshotSchema.client>;
|
|
1051
|
+
export type ContentBriefOutlineItem = z.output<typeof contentBriefOutlineItemSchema.client>;
|
|
1052
|
+
export type ContentBriefInternalLink = z.output<typeof contentBriefInternalLinkSchema.client>;
|
|
1053
|
+
export type ContentBriefPayload = z.output<typeof contentBriefPayloadSchema.client>;
|
|
1054
|
+
export type ContentBriefSummary = z.output<typeof contentBriefSummarySchema.client>;
|
|
1055
|
+
export type ContentBrief = z.output<typeof contentBriefResourceSchema.client>;
|
|
1056
|
+
export type ContentBriefListData = z.output<typeof contentBriefListDataSchema.client>;
|
|
1057
|
+
export type ContentBriefCreateData = z.output<typeof contentBriefCreateDataSchema.client>;
|
|
1058
|
+
export declare const contentBriefListOperation: {
|
|
1059
|
+
readonly id: 'content.briefs.list';
|
|
1060
|
+
readonly method: 'GET';
|
|
1061
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs';
|
|
1062
|
+
readonly visibility: 'public';
|
|
1063
|
+
readonly semantics: {
|
|
1064
|
+
readonly kind: 'query';
|
|
1065
|
+
readonly sideEffects: 'none';
|
|
1066
|
+
readonly retry: 'idempotent';
|
|
1067
|
+
readonly readConsistency: 'primary';
|
|
1068
|
+
};
|
|
1069
|
+
readonly auth: {
|
|
1070
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1071
|
+
readonly scopes: readonly ["content:read"];
|
|
1072
|
+
readonly minimumRole: 'viewer';
|
|
1073
|
+
readonly ownership: 'site';
|
|
1074
|
+
};
|
|
1075
|
+
readonly request: {
|
|
1076
|
+
readonly params: z.ZodObject<{
|
|
1077
|
+
siteId: z.ZodString;
|
|
1078
|
+
}, z.core.$strict>;
|
|
1079
|
+
readonly query: z.ZodObject<{
|
|
1080
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
1081
|
+
archived: "archived";
|
|
1082
|
+
failed: "failed";
|
|
1083
|
+
published: "published";
|
|
1084
|
+
queued: "queued";
|
|
1085
|
+
ready: "ready";
|
|
1086
|
+
researching: "researching";
|
|
1087
|
+
stale: "stale";
|
|
1088
|
+
written: "written";
|
|
1089
|
+
}>>;
|
|
1090
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
1091
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
1092
|
+
}, z.core.$strict>;
|
|
1093
|
+
readonly headers: null;
|
|
1094
|
+
readonly body: null;
|
|
1095
|
+
};
|
|
1096
|
+
readonly responses: {
|
|
1097
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1098
|
+
data: z.ZodObject<{
|
|
1099
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
1100
|
+
id: z.ZodString;
|
|
1101
|
+
siteId: z.ZodString;
|
|
1102
|
+
keyword: z.ZodString;
|
|
1103
|
+
status: z.ZodEnum<{
|
|
1104
|
+
archived: "archived";
|
|
1105
|
+
failed: "failed";
|
|
1106
|
+
published: "published";
|
|
1107
|
+
queued: "queued";
|
|
1108
|
+
ready: "ready";
|
|
1109
|
+
researching: "researching";
|
|
1110
|
+
stale: "stale";
|
|
1111
|
+
written: "written";
|
|
1112
|
+
}>;
|
|
1113
|
+
error: z.ZodNullable<z.ZodString>;
|
|
1114
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1115
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1116
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1117
|
+
}, z.core.$strip>>;
|
|
1118
|
+
readonly page: z.ZodObject<{
|
|
1119
|
+
total: z.ZodNumber;
|
|
1120
|
+
limit: z.ZodNumber;
|
|
1121
|
+
offset: z.ZodNumber;
|
|
1122
|
+
hasMore: z.ZodBoolean;
|
|
1123
|
+
}, z.core.$strip>;
|
|
1124
|
+
}, z.core.$strip>;
|
|
1125
|
+
meta: z.ZodObject<{
|
|
1126
|
+
requestId: z.ZodString;
|
|
1127
|
+
version: z.ZodLiteral<"1.0">;
|
|
1128
|
+
}, z.core.$strict>;
|
|
1129
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1130
|
+
data: z.ZodObject<{
|
|
1131
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
1132
|
+
id: z.ZodString;
|
|
1133
|
+
siteId: z.ZodString;
|
|
1134
|
+
keyword: z.ZodString;
|
|
1135
|
+
status: z.ZodEnum<{
|
|
1136
|
+
archived: "archived";
|
|
1137
|
+
failed: "failed";
|
|
1138
|
+
published: "published";
|
|
1139
|
+
queued: "queued";
|
|
1140
|
+
ready: "ready";
|
|
1141
|
+
researching: "researching";
|
|
1142
|
+
stale: "stale";
|
|
1143
|
+
written: "written";
|
|
1144
|
+
}>;
|
|
1145
|
+
error: z.ZodNullable<z.ZodString>;
|
|
1146
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1147
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1148
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1149
|
+
}, z.core.$strip>>;
|
|
1150
|
+
readonly page: z.ZodObject<{
|
|
1151
|
+
total: z.ZodNumber;
|
|
1152
|
+
limit: z.ZodNumber;
|
|
1153
|
+
offset: z.ZodNumber;
|
|
1154
|
+
hasMore: z.ZodBoolean;
|
|
1155
|
+
}, z.core.$strip>;
|
|
1156
|
+
}, z.core.$strip>;
|
|
1157
|
+
meta: z.ZodObject<{
|
|
1158
|
+
requestId: z.ZodString;
|
|
1159
|
+
version: z.ZodLiteral<"1.0">;
|
|
1160
|
+
}, z.core.$loose>;
|
|
1161
|
+
}, z.core.$strip>>;
|
|
1162
|
+
};
|
|
1163
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
1164
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1165
|
+
readonly error: z.ZodObject<{
|
|
1166
|
+
code: z.ZodEnum<{
|
|
1167
|
+
auth_expired: "auth_expired";
|
|
1168
|
+
conflict: "conflict";
|
|
1169
|
+
contract_violation: "contract_violation";
|
|
1170
|
+
entitlement_required: "entitlement_required";
|
|
1171
|
+
forbidden: "forbidden";
|
|
1172
|
+
internal_error: "internal_error";
|
|
1173
|
+
invalid_request: "invalid_request";
|
|
1174
|
+
not_found: "not_found";
|
|
1175
|
+
provider_unavailable: "provider_unavailable";
|
|
1176
|
+
quota_exhausted: "quota_exhausted";
|
|
1177
|
+
rate_limited: "rate_limited";
|
|
1178
|
+
site_ambiguous: "site_ambiguous";
|
|
1179
|
+
stale_evidence: "stale_evidence";
|
|
1180
|
+
unauthorized: "unauthorized";
|
|
1181
|
+
}>;
|
|
1182
|
+
message: z.ZodString;
|
|
1183
|
+
requestId: z.ZodString;
|
|
1184
|
+
retryable: z.ZodBoolean;
|
|
1185
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1186
|
+
}, z.core.$strict>;
|
|
1187
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1188
|
+
readonly error: z.ZodObject<{
|
|
1189
|
+
code: z.ZodEnum<{
|
|
1190
|
+
auth_expired: "auth_expired";
|
|
1191
|
+
conflict: "conflict";
|
|
1192
|
+
contract_violation: "contract_violation";
|
|
1193
|
+
entitlement_required: "entitlement_required";
|
|
1194
|
+
forbidden: "forbidden";
|
|
1195
|
+
internal_error: "internal_error";
|
|
1196
|
+
invalid_request: "invalid_request";
|
|
1197
|
+
not_found: "not_found";
|
|
1198
|
+
provider_unavailable: "provider_unavailable";
|
|
1199
|
+
quota_exhausted: "quota_exhausted";
|
|
1200
|
+
rate_limited: "rate_limited";
|
|
1201
|
+
site_ambiguous: "site_ambiguous";
|
|
1202
|
+
stale_evidence: "stale_evidence";
|
|
1203
|
+
unauthorized: "unauthorized";
|
|
1204
|
+
}>;
|
|
1205
|
+
message: z.ZodString;
|
|
1206
|
+
requestId: z.ZodString;
|
|
1207
|
+
retryable: z.ZodBoolean;
|
|
1208
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1209
|
+
}, z.core.$loose>;
|
|
1210
|
+
}, z.core.$strip>>;
|
|
1211
|
+
readonly resources: {
|
|
1212
|
+
readonly reads: readonly [{
|
|
1213
|
+
readonly type: 'site.content';
|
|
1214
|
+
readonly idFrom: 'params.siteId';
|
|
1215
|
+
}];
|
|
1216
|
+
readonly changes: readonly [];
|
|
1217
|
+
};
|
|
1218
|
+
readonly policy: {
|
|
1219
|
+
readonly rate: {
|
|
1220
|
+
readonly name: 'public-v1-fixed-window';
|
|
1221
|
+
readonly limit: 50;
|
|
1222
|
+
readonly windowSeconds: 60;
|
|
1223
|
+
};
|
|
1224
|
+
readonly idempotency: {
|
|
1225
|
+
readonly _tag: 'none';
|
|
1226
|
+
};
|
|
1227
|
+
readonly entitlement: null;
|
|
1228
|
+
readonly meter: null;
|
|
1229
|
+
};
|
|
1230
|
+
readonly lifecycle: {
|
|
1231
|
+
readonly introduced: '1.0.0';
|
|
1232
|
+
};
|
|
1233
|
+
readonly docs: {
|
|
1234
|
+
readonly summary: 'List Content Briefs';
|
|
1235
|
+
readonly description: 'Lists one page of Content Brief summaries owned by a NuxtSEO Site.';
|
|
1236
|
+
readonly tags: readonly ["Content"];
|
|
1237
|
+
readonly examples: readonly [{
|
|
1238
|
+
readonly request: {
|
|
1239
|
+
readonly params: {
|
|
1240
|
+
readonly siteId: 'site_01JXYZ';
|
|
1241
|
+
};
|
|
1242
|
+
readonly query: {
|
|
1243
|
+
readonly limit: 25;
|
|
1244
|
+
readonly offset: 0;
|
|
1245
|
+
};
|
|
1246
|
+
};
|
|
1247
|
+
readonly response: {
|
|
1248
|
+
readonly status: 200;
|
|
1249
|
+
readonly body: {
|
|
1250
|
+
readonly data: {
|
|
1251
|
+
readonly briefs: readonly [{
|
|
1252
|
+
readonly id: 'brief_01JXYZ';
|
|
1253
|
+
readonly siteId: 'site_01JXYZ';
|
|
1254
|
+
readonly keyword: 'nuxt seo';
|
|
1255
|
+
readonly status: 'ready';
|
|
1256
|
+
readonly error: null;
|
|
1257
|
+
readonly generatedAt: '2026-08-10T00:00:00.000Z';
|
|
1258
|
+
readonly markedPublishedAt: null;
|
|
1259
|
+
readonly updatedAt: '2026-08-10T00:00:00.000Z';
|
|
1260
|
+
}];
|
|
1261
|
+
readonly page: {
|
|
1262
|
+
readonly total: 1;
|
|
1263
|
+
readonly limit: 25;
|
|
1264
|
+
readonly offset: 0;
|
|
1265
|
+
readonly hasMore: false;
|
|
1266
|
+
};
|
|
1267
|
+
};
|
|
1268
|
+
readonly meta: {
|
|
1269
|
+
readonly requestId: 'req_01JXYZ';
|
|
1270
|
+
readonly version: '1.0';
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
};
|
|
1274
|
+
}];
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
export declare const contentBriefShowOperation: {
|
|
1278
|
+
readonly id: 'content.briefs.show';
|
|
1279
|
+
readonly method: 'GET';
|
|
1280
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs/{briefId}';
|
|
1281
|
+
readonly visibility: 'public';
|
|
1282
|
+
readonly semantics: {
|
|
1283
|
+
readonly kind: 'query';
|
|
1284
|
+
readonly sideEffects: 'none';
|
|
1285
|
+
readonly retry: 'idempotent';
|
|
1286
|
+
readonly readConsistency: 'primary';
|
|
1287
|
+
};
|
|
1288
|
+
readonly auth: {
|
|
1289
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1290
|
+
readonly scopes: readonly ["content:read"];
|
|
1291
|
+
readonly minimumRole: 'viewer';
|
|
1292
|
+
readonly ownership: 'site';
|
|
1293
|
+
};
|
|
1294
|
+
readonly request: {
|
|
1295
|
+
readonly params: z.ZodObject<{
|
|
1296
|
+
siteId: z.ZodString;
|
|
1297
|
+
briefId: z.ZodString;
|
|
1298
|
+
}, z.core.$strict>;
|
|
1299
|
+
readonly query: null;
|
|
1300
|
+
readonly headers: null;
|
|
1301
|
+
readonly body: null;
|
|
1302
|
+
};
|
|
1303
|
+
readonly responses: {
|
|
1304
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1305
|
+
data: z.ZodObject<{
|
|
1306
|
+
readonly id: z.ZodString;
|
|
1307
|
+
readonly siteId: z.ZodString;
|
|
1308
|
+
readonly keyword: z.ZodString;
|
|
1309
|
+
readonly status: z.ZodEnum<{
|
|
1310
|
+
archived: "archived";
|
|
1311
|
+
failed: "failed";
|
|
1312
|
+
published: "published";
|
|
1313
|
+
queued: "queued";
|
|
1314
|
+
ready: "ready";
|
|
1315
|
+
researching: "researching";
|
|
1316
|
+
stale: "stale";
|
|
1317
|
+
written: "written";
|
|
1318
|
+
}>;
|
|
1319
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
1320
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1321
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1322
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1323
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
1324
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
1325
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
1326
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
1327
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
1328
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
1329
|
+
fetchedAt: z.ZodISODateTime;
|
|
1330
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
1331
|
+
position: z.ZodNumber;
|
|
1332
|
+
url: z.ZodURL;
|
|
1333
|
+
title: z.ZodString;
|
|
1334
|
+
domain: z.ZodString;
|
|
1335
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
1336
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
1337
|
+
}, z.core.$strip>>;
|
|
1338
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1339
|
+
question: z.ZodString;
|
|
1340
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
1341
|
+
}, z.core.$strip>>>;
|
|
1342
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
1343
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1344
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
1345
|
+
}, z.core.$strip>>;
|
|
1346
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1347
|
+
level: z.ZodEnum<{
|
|
1348
|
+
h1: "h1";
|
|
1349
|
+
h2: "h2";
|
|
1350
|
+
h3: "h3";
|
|
1351
|
+
}>;
|
|
1352
|
+
heading: z.ZodString;
|
|
1353
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
1354
|
+
"from-aio": "from-aio";
|
|
1355
|
+
"from-paa": "from-paa";
|
|
1356
|
+
gap: "gap";
|
|
1357
|
+
"intent-match": "intent-match";
|
|
1358
|
+
"your-strength": "your-strength";
|
|
1359
|
+
}>>;
|
|
1360
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
1361
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
1362
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
1363
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
1364
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
1365
|
+
}, z.core.$strip>>>;
|
|
1366
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1367
|
+
url: z.ZodURL;
|
|
1368
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
1369
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
1370
|
+
reasoning: z.ZodString;
|
|
1371
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
1372
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
1373
|
+
}, z.core.$strip>>>;
|
|
1374
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
1375
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1376
|
+
}, z.core.$strip>>;
|
|
1377
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1378
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1379
|
+
}, z.core.$strip>;
|
|
1380
|
+
meta: z.ZodObject<{
|
|
1381
|
+
requestId: z.ZodString;
|
|
1382
|
+
version: z.ZodLiteral<"1.0">;
|
|
1383
|
+
}, z.core.$strict>;
|
|
1384
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1385
|
+
data: z.ZodObject<{
|
|
1386
|
+
readonly id: z.ZodString;
|
|
1387
|
+
readonly siteId: z.ZodString;
|
|
1388
|
+
readonly keyword: z.ZodString;
|
|
1389
|
+
readonly status: z.ZodEnum<{
|
|
1390
|
+
archived: "archived";
|
|
1391
|
+
failed: "failed";
|
|
1392
|
+
published: "published";
|
|
1393
|
+
queued: "queued";
|
|
1394
|
+
ready: "ready";
|
|
1395
|
+
researching: "researching";
|
|
1396
|
+
stale: "stale";
|
|
1397
|
+
written: "written";
|
|
1398
|
+
}>;
|
|
1399
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
1400
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1401
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1402
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1403
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
1404
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
1405
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
1406
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
1407
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
1408
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
1409
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1410
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
1411
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
1412
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
1413
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1414
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
1415
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
1416
|
+
position: z.ZodNumber;
|
|
1417
|
+
url: z.ZodURL;
|
|
1418
|
+
title: z.ZodString;
|
|
1419
|
+
domain: z.ZodString;
|
|
1420
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
1421
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
1422
|
+
}, z.core.$strip>>;
|
|
1423
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1424
|
+
question: z.ZodString;
|
|
1425
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
1426
|
+
}, z.core.$strip>>>;
|
|
1427
|
+
}, z.core.$strip>>;
|
|
1428
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1429
|
+
level: z.ZodEnum<{
|
|
1430
|
+
h1: "h1";
|
|
1431
|
+
h2: "h2";
|
|
1432
|
+
h3: "h3";
|
|
1433
|
+
}>;
|
|
1434
|
+
heading: z.ZodString;
|
|
1435
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
1436
|
+
"from-aio": "from-aio";
|
|
1437
|
+
"from-paa": "from-paa";
|
|
1438
|
+
gap: "gap";
|
|
1439
|
+
"intent-match": "intent-match";
|
|
1440
|
+
"your-strength": "your-strength";
|
|
1441
|
+
}>>;
|
|
1442
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
1443
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
1444
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
1445
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
1446
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
1447
|
+
}, z.core.$strip>>>;
|
|
1448
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1449
|
+
url: z.ZodURL;
|
|
1450
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
1451
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
1452
|
+
reasoning: z.ZodString;
|
|
1453
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
1454
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
1455
|
+
}, z.core.$strip>>>;
|
|
1456
|
+
}, z.core.$strip>>;
|
|
1457
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1458
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1459
|
+
}, z.core.$strip>;
|
|
1460
|
+
meta: z.ZodObject<{
|
|
1461
|
+
requestId: z.ZodString;
|
|
1462
|
+
version: z.ZodLiteral<"1.0">;
|
|
1463
|
+
}, z.core.$loose>;
|
|
1464
|
+
}, z.core.$strip>>;
|
|
1465
|
+
};
|
|
1466
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
1467
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1468
|
+
readonly error: z.ZodObject<{
|
|
1469
|
+
code: z.ZodEnum<{
|
|
1470
|
+
auth_expired: "auth_expired";
|
|
1471
|
+
conflict: "conflict";
|
|
1472
|
+
contract_violation: "contract_violation";
|
|
1473
|
+
entitlement_required: "entitlement_required";
|
|
1474
|
+
forbidden: "forbidden";
|
|
1475
|
+
internal_error: "internal_error";
|
|
1476
|
+
invalid_request: "invalid_request";
|
|
1477
|
+
not_found: "not_found";
|
|
1478
|
+
provider_unavailable: "provider_unavailable";
|
|
1479
|
+
quota_exhausted: "quota_exhausted";
|
|
1480
|
+
rate_limited: "rate_limited";
|
|
1481
|
+
site_ambiguous: "site_ambiguous";
|
|
1482
|
+
stale_evidence: "stale_evidence";
|
|
1483
|
+
unauthorized: "unauthorized";
|
|
1484
|
+
}>;
|
|
1485
|
+
message: z.ZodString;
|
|
1486
|
+
requestId: z.ZodString;
|
|
1487
|
+
retryable: z.ZodBoolean;
|
|
1488
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1489
|
+
}, z.core.$strict>;
|
|
1490
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1491
|
+
readonly error: z.ZodObject<{
|
|
1492
|
+
code: z.ZodEnum<{
|
|
1493
|
+
auth_expired: "auth_expired";
|
|
1494
|
+
conflict: "conflict";
|
|
1495
|
+
contract_violation: "contract_violation";
|
|
1496
|
+
entitlement_required: "entitlement_required";
|
|
1497
|
+
forbidden: "forbidden";
|
|
1498
|
+
internal_error: "internal_error";
|
|
1499
|
+
invalid_request: "invalid_request";
|
|
1500
|
+
not_found: "not_found";
|
|
1501
|
+
provider_unavailable: "provider_unavailable";
|
|
1502
|
+
quota_exhausted: "quota_exhausted";
|
|
1503
|
+
rate_limited: "rate_limited";
|
|
1504
|
+
site_ambiguous: "site_ambiguous";
|
|
1505
|
+
stale_evidence: "stale_evidence";
|
|
1506
|
+
unauthorized: "unauthorized";
|
|
1507
|
+
}>;
|
|
1508
|
+
message: z.ZodString;
|
|
1509
|
+
requestId: z.ZodString;
|
|
1510
|
+
retryable: z.ZodBoolean;
|
|
1511
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1512
|
+
}, z.core.$loose>;
|
|
1513
|
+
}, z.core.$strip>>;
|
|
1514
|
+
readonly resources: {
|
|
1515
|
+
readonly reads: readonly [{
|
|
1516
|
+
readonly type: 'site.content';
|
|
1517
|
+
readonly idFrom: 'params.siteId';
|
|
1518
|
+
}];
|
|
1519
|
+
readonly changes: readonly [];
|
|
1520
|
+
};
|
|
1521
|
+
readonly policy: {
|
|
1522
|
+
readonly rate: {
|
|
1523
|
+
readonly name: 'public-v1-fixed-window';
|
|
1524
|
+
readonly limit: 50;
|
|
1525
|
+
readonly windowSeconds: 60;
|
|
1526
|
+
};
|
|
1527
|
+
readonly idempotency: {
|
|
1528
|
+
readonly _tag: 'none';
|
|
1529
|
+
};
|
|
1530
|
+
readonly entitlement: null;
|
|
1531
|
+
readonly meter: null;
|
|
1532
|
+
};
|
|
1533
|
+
readonly lifecycle: {
|
|
1534
|
+
readonly introduced: '1.0.0';
|
|
1535
|
+
};
|
|
1536
|
+
readonly docs: {
|
|
1537
|
+
readonly summary: 'Show a Content Brief';
|
|
1538
|
+
readonly description: 'Returns one Content Brief with its grounded SERP, outline, and internal-link evidence.';
|
|
1539
|
+
readonly tags: readonly ["Content"];
|
|
1540
|
+
readonly examples: readonly [{
|
|
1541
|
+
readonly request: {
|
|
1542
|
+
readonly params: {
|
|
1543
|
+
readonly siteId: 'site_01JXYZ';
|
|
1544
|
+
readonly briefId: 'brief_01JXYZ';
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1547
|
+
readonly response: {
|
|
1548
|
+
readonly status: 200;
|
|
1549
|
+
readonly body: {
|
|
1550
|
+
readonly data: {
|
|
1551
|
+
id: string;
|
|
1552
|
+
siteId: string;
|
|
1553
|
+
keyword: string;
|
|
1554
|
+
status: 'ready';
|
|
1555
|
+
error: null;
|
|
1556
|
+
generatedAt: string;
|
|
1557
|
+
markedPublishedAt: null;
|
|
1558
|
+
updatedAt: string;
|
|
1559
|
+
createdAt: string;
|
|
1560
|
+
markedWrittenAt: null;
|
|
1561
|
+
payload: {
|
|
1562
|
+
targetPage: string;
|
|
1563
|
+
outline: {
|
|
1564
|
+
level: 'h1';
|
|
1565
|
+
heading: string;
|
|
1566
|
+
}[];
|
|
1567
|
+
internalLinks: never[];
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
readonly meta: {
|
|
1571
|
+
readonly requestId: 'req_01JXYZ';
|
|
1572
|
+
readonly version: '1.0';
|
|
1573
|
+
};
|
|
1574
|
+
};
|
|
1575
|
+
};
|
|
1576
|
+
}];
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1579
|
+
export declare const contentBriefCreateOperation: {
|
|
1580
|
+
readonly id: 'content.briefs.create';
|
|
1581
|
+
readonly method: 'POST';
|
|
1582
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs';
|
|
1583
|
+
readonly visibility: 'public';
|
|
1584
|
+
readonly semantics: {
|
|
1585
|
+
readonly kind: 'mutation';
|
|
1586
|
+
readonly sideEffects: 'state';
|
|
1587
|
+
readonly retry: 'never';
|
|
1588
|
+
readonly readConsistency: null;
|
|
1589
|
+
};
|
|
1590
|
+
readonly auth: {
|
|
1591
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1592
|
+
readonly scopes: readonly ["content:write"];
|
|
1593
|
+
readonly minimumRole: 'member';
|
|
1594
|
+
readonly ownership: 'site';
|
|
1595
|
+
};
|
|
1596
|
+
readonly request: {
|
|
1597
|
+
readonly params: z.ZodObject<{
|
|
1598
|
+
siteId: z.ZodString;
|
|
1599
|
+
}, z.core.$strict>;
|
|
1600
|
+
readonly query: null;
|
|
1601
|
+
readonly headers: null;
|
|
1602
|
+
readonly body: z.ZodObject<{
|
|
1603
|
+
keyword: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
|
|
1604
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
1605
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
1606
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
1607
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
1608
|
+
}, z.core.$strict>;
|
|
1609
|
+
};
|
|
1610
|
+
readonly responses: {
|
|
1611
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1612
|
+
data: z.ZodObject<{
|
|
1613
|
+
readonly brief: z.ZodObject<{
|
|
1614
|
+
readonly id: z.ZodString;
|
|
1615
|
+
readonly siteId: z.ZodString;
|
|
1616
|
+
readonly keyword: z.ZodString;
|
|
1617
|
+
readonly status: z.ZodEnum<{
|
|
1618
|
+
archived: "archived";
|
|
1619
|
+
failed: "failed";
|
|
1620
|
+
published: "published";
|
|
1621
|
+
queued: "queued";
|
|
1622
|
+
ready: "ready";
|
|
1623
|
+
researching: "researching";
|
|
1624
|
+
stale: "stale";
|
|
1625
|
+
written: "written";
|
|
1626
|
+
}>;
|
|
1627
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
1628
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1629
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1630
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1631
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
1632
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
1633
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
1634
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
1635
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
1636
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
1637
|
+
fetchedAt: z.ZodISODateTime;
|
|
1638
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
1639
|
+
position: z.ZodNumber;
|
|
1640
|
+
url: z.ZodURL;
|
|
1641
|
+
title: z.ZodString;
|
|
1642
|
+
domain: z.ZodString;
|
|
1643
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
1644
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
1645
|
+
}, z.core.$strip>>;
|
|
1646
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1647
|
+
question: z.ZodString;
|
|
1648
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
1649
|
+
}, z.core.$strip>>>;
|
|
1650
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
1651
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1652
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
1653
|
+
}, z.core.$strip>>;
|
|
1654
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1655
|
+
level: z.ZodEnum<{
|
|
1656
|
+
h1: "h1";
|
|
1657
|
+
h2: "h2";
|
|
1658
|
+
h3: "h3";
|
|
1659
|
+
}>;
|
|
1660
|
+
heading: z.ZodString;
|
|
1661
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
1662
|
+
"from-aio": "from-aio";
|
|
1663
|
+
"from-paa": "from-paa";
|
|
1664
|
+
gap: "gap";
|
|
1665
|
+
"intent-match": "intent-match";
|
|
1666
|
+
"your-strength": "your-strength";
|
|
1667
|
+
}>>;
|
|
1668
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
1669
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
1670
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
1671
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
1672
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
1673
|
+
}, z.core.$strip>>>;
|
|
1674
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1675
|
+
url: z.ZodURL;
|
|
1676
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
1677
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
1678
|
+
reasoning: z.ZodString;
|
|
1679
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
1680
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
1681
|
+
}, z.core.$strip>>>;
|
|
1682
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
1683
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1684
|
+
}, z.core.$strip>>;
|
|
1685
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1686
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1687
|
+
}, z.core.$strip>;
|
|
1688
|
+
readonly created: z.ZodBoolean;
|
|
1689
|
+
}, z.core.$strip>;
|
|
1690
|
+
meta: z.ZodObject<{
|
|
1691
|
+
requestId: z.ZodString;
|
|
1692
|
+
version: z.ZodLiteral<"1.0">;
|
|
1693
|
+
}, z.core.$strict>;
|
|
1694
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1695
|
+
data: z.ZodObject<{
|
|
1696
|
+
readonly brief: z.ZodObject<{
|
|
1697
|
+
readonly id: z.ZodString;
|
|
1698
|
+
readonly siteId: z.ZodString;
|
|
1699
|
+
readonly keyword: z.ZodString;
|
|
1700
|
+
readonly status: z.ZodEnum<{
|
|
1701
|
+
archived: "archived";
|
|
1702
|
+
failed: "failed";
|
|
1703
|
+
published: "published";
|
|
1704
|
+
queued: "queued";
|
|
1705
|
+
ready: "ready";
|
|
1706
|
+
researching: "researching";
|
|
1707
|
+
stale: "stale";
|
|
1708
|
+
written: "written";
|
|
1709
|
+
}>;
|
|
1710
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
1711
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1712
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1713
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1714
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
1715
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
1716
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
1717
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
1718
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
1719
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
1720
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1721
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
1722
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
1723
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
1724
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1725
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
1726
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
1727
|
+
position: z.ZodNumber;
|
|
1728
|
+
url: z.ZodURL;
|
|
1729
|
+
title: z.ZodString;
|
|
1730
|
+
domain: z.ZodString;
|
|
1731
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
1732
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
1733
|
+
}, z.core.$strip>>;
|
|
1734
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1735
|
+
question: z.ZodString;
|
|
1736
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
1737
|
+
}, z.core.$strip>>>;
|
|
1738
|
+
}, z.core.$strip>>;
|
|
1739
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1740
|
+
level: z.ZodEnum<{
|
|
1741
|
+
h1: "h1";
|
|
1742
|
+
h2: "h2";
|
|
1743
|
+
h3: "h3";
|
|
1744
|
+
}>;
|
|
1745
|
+
heading: z.ZodString;
|
|
1746
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
1747
|
+
"from-aio": "from-aio";
|
|
1748
|
+
"from-paa": "from-paa";
|
|
1749
|
+
gap: "gap";
|
|
1750
|
+
"intent-match": "intent-match";
|
|
1751
|
+
"your-strength": "your-strength";
|
|
1752
|
+
}>>;
|
|
1753
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
1754
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
1755
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
1756
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
1757
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
1758
|
+
}, z.core.$strip>>>;
|
|
1759
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1760
|
+
url: z.ZodURL;
|
|
1761
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
1762
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
1763
|
+
reasoning: z.ZodString;
|
|
1764
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
1765
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
1766
|
+
}, z.core.$strip>>>;
|
|
1767
|
+
}, z.core.$strip>>;
|
|
1768
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1769
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1770
|
+
}, z.core.$strip>;
|
|
1771
|
+
readonly created: z.ZodBoolean;
|
|
1772
|
+
}, z.core.$strip>;
|
|
1773
|
+
meta: z.ZodObject<{
|
|
1774
|
+
requestId: z.ZodString;
|
|
1775
|
+
version: z.ZodLiteral<"1.0">;
|
|
1776
|
+
}, z.core.$loose>;
|
|
1777
|
+
}, z.core.$strip>>;
|
|
1778
|
+
};
|
|
1779
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error", "entitlement_required", "conflict", "quota_exhausted"];
|
|
1780
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1781
|
+
readonly error: z.ZodObject<{
|
|
1782
|
+
code: z.ZodEnum<{
|
|
1783
|
+
auth_expired: "auth_expired";
|
|
1784
|
+
conflict: "conflict";
|
|
1785
|
+
contract_violation: "contract_violation";
|
|
1786
|
+
entitlement_required: "entitlement_required";
|
|
1787
|
+
forbidden: "forbidden";
|
|
1788
|
+
internal_error: "internal_error";
|
|
1789
|
+
invalid_request: "invalid_request";
|
|
1790
|
+
not_found: "not_found";
|
|
1791
|
+
provider_unavailable: "provider_unavailable";
|
|
1792
|
+
quota_exhausted: "quota_exhausted";
|
|
1793
|
+
rate_limited: "rate_limited";
|
|
1794
|
+
site_ambiguous: "site_ambiguous";
|
|
1795
|
+
stale_evidence: "stale_evidence";
|
|
1796
|
+
unauthorized: "unauthorized";
|
|
1797
|
+
}>;
|
|
1798
|
+
message: z.ZodString;
|
|
1799
|
+
requestId: z.ZodString;
|
|
1800
|
+
retryable: z.ZodBoolean;
|
|
1801
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1802
|
+
}, z.core.$strict>;
|
|
1803
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1804
|
+
readonly error: z.ZodObject<{
|
|
1805
|
+
code: z.ZodEnum<{
|
|
1806
|
+
auth_expired: "auth_expired";
|
|
1807
|
+
conflict: "conflict";
|
|
1808
|
+
contract_violation: "contract_violation";
|
|
1809
|
+
entitlement_required: "entitlement_required";
|
|
1810
|
+
forbidden: "forbidden";
|
|
1811
|
+
internal_error: "internal_error";
|
|
1812
|
+
invalid_request: "invalid_request";
|
|
1813
|
+
not_found: "not_found";
|
|
1814
|
+
provider_unavailable: "provider_unavailable";
|
|
1815
|
+
quota_exhausted: "quota_exhausted";
|
|
1816
|
+
rate_limited: "rate_limited";
|
|
1817
|
+
site_ambiguous: "site_ambiguous";
|
|
1818
|
+
stale_evidence: "stale_evidence";
|
|
1819
|
+
unauthorized: "unauthorized";
|
|
1820
|
+
}>;
|
|
1821
|
+
message: z.ZodString;
|
|
1822
|
+
requestId: z.ZodString;
|
|
1823
|
+
retryable: z.ZodBoolean;
|
|
1824
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1825
|
+
}, z.core.$loose>;
|
|
1826
|
+
}, z.core.$strip>>;
|
|
1827
|
+
readonly resources: {
|
|
1828
|
+
readonly reads: readonly [{
|
|
1829
|
+
readonly type: 'site.content';
|
|
1830
|
+
readonly idFrom: 'params.siteId';
|
|
1831
|
+
}];
|
|
1832
|
+
readonly changes: readonly [{
|
|
1833
|
+
readonly type: 'site.content';
|
|
1834
|
+
readonly idFrom: 'params.siteId';
|
|
1835
|
+
}];
|
|
1836
|
+
};
|
|
1837
|
+
readonly policy: {
|
|
1838
|
+
readonly rate: {
|
|
1839
|
+
readonly name: 'public-v1-fixed-window';
|
|
1840
|
+
readonly limit: 50;
|
|
1841
|
+
readonly windowSeconds: 60;
|
|
1842
|
+
};
|
|
1843
|
+
readonly idempotency: {
|
|
1844
|
+
readonly _tag: 'none';
|
|
1845
|
+
};
|
|
1846
|
+
readonly entitlement: 'pro';
|
|
1847
|
+
readonly meter: null;
|
|
1848
|
+
};
|
|
1849
|
+
readonly lifecycle: {
|
|
1850
|
+
readonly introduced: '1.0.0';
|
|
1851
|
+
};
|
|
1852
|
+
readonly docs: {
|
|
1853
|
+
readonly summary: 'Create a Content Brief';
|
|
1854
|
+
readonly description: 'Creates or returns the existing Site-owned Content Brief for a canonical target keyword.';
|
|
1855
|
+
readonly tags: readonly ["Content"];
|
|
1856
|
+
readonly examples: readonly [{
|
|
1857
|
+
readonly request: {
|
|
1858
|
+
readonly params: {
|
|
1859
|
+
readonly siteId: 'site_01JXYZ';
|
|
1860
|
+
};
|
|
1861
|
+
readonly body: {
|
|
1862
|
+
readonly keyword: 'nuxt seo';
|
|
1863
|
+
readonly targetPage: 'https://example.com/guide';
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
readonly response: {
|
|
1867
|
+
readonly status: 200;
|
|
1868
|
+
readonly body: {
|
|
1869
|
+
readonly data: {
|
|
1870
|
+
readonly brief: {
|
|
1871
|
+
id: string;
|
|
1872
|
+
siteId: string;
|
|
1873
|
+
keyword: string;
|
|
1874
|
+
status: 'ready';
|
|
1875
|
+
error: null;
|
|
1876
|
+
generatedAt: string;
|
|
1877
|
+
markedPublishedAt: null;
|
|
1878
|
+
updatedAt: string;
|
|
1879
|
+
createdAt: string;
|
|
1880
|
+
markedWrittenAt: null;
|
|
1881
|
+
payload: {
|
|
1882
|
+
targetPage: string;
|
|
1883
|
+
outline: {
|
|
1884
|
+
level: 'h1';
|
|
1885
|
+
heading: string;
|
|
1886
|
+
}[];
|
|
1887
|
+
internalLinks: never[];
|
|
1888
|
+
};
|
|
1889
|
+
};
|
|
1890
|
+
readonly created: true;
|
|
1891
|
+
};
|
|
1892
|
+
readonly meta: {
|
|
1893
|
+
readonly requestId: 'req_01JXYZ';
|
|
1894
|
+
readonly version: '1.0';
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
}];
|
|
1899
|
+
};
|
|
1900
|
+
};
|
|
1901
|
+
export declare const contentV1Registry: import("./core.js").PublicV1Registry<{
|
|
1902
|
+
readonly listBriefs: {
|
|
1903
|
+
readonly id: 'content.briefs.list';
|
|
1904
|
+
readonly method: 'GET';
|
|
1905
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs';
|
|
1906
|
+
readonly visibility: 'public';
|
|
1907
|
+
readonly semantics: {
|
|
1908
|
+
readonly kind: 'query';
|
|
1909
|
+
readonly sideEffects: 'none';
|
|
1910
|
+
readonly retry: 'idempotent';
|
|
1911
|
+
readonly readConsistency: 'primary';
|
|
1912
|
+
};
|
|
1913
|
+
readonly auth: {
|
|
1914
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
1915
|
+
readonly scopes: readonly ["content:read"];
|
|
1916
|
+
readonly minimumRole: 'viewer';
|
|
1917
|
+
readonly ownership: 'site';
|
|
1918
|
+
};
|
|
1919
|
+
readonly request: {
|
|
1920
|
+
readonly params: z.ZodObject<{
|
|
1921
|
+
siteId: z.ZodString;
|
|
1922
|
+
}, z.core.$strict>;
|
|
1923
|
+
readonly query: z.ZodObject<{
|
|
1924
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
1925
|
+
archived: "archived";
|
|
1926
|
+
failed: "failed";
|
|
1927
|
+
published: "published";
|
|
1928
|
+
queued: "queued";
|
|
1929
|
+
ready: "ready";
|
|
1930
|
+
researching: "researching";
|
|
1931
|
+
stale: "stale";
|
|
1932
|
+
written: "written";
|
|
1933
|
+
}>>;
|
|
1934
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
1935
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
1936
|
+
}, z.core.$strict>;
|
|
1937
|
+
readonly headers: null;
|
|
1938
|
+
readonly body: null;
|
|
1939
|
+
};
|
|
1940
|
+
readonly responses: {
|
|
1941
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
1942
|
+
data: z.ZodObject<{
|
|
1943
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
1944
|
+
id: z.ZodString;
|
|
1945
|
+
siteId: z.ZodString;
|
|
1946
|
+
keyword: z.ZodString;
|
|
1947
|
+
status: z.ZodEnum<{
|
|
1948
|
+
archived: "archived";
|
|
1949
|
+
failed: "failed";
|
|
1950
|
+
published: "published";
|
|
1951
|
+
queued: "queued";
|
|
1952
|
+
ready: "ready";
|
|
1953
|
+
researching: "researching";
|
|
1954
|
+
stale: "stale";
|
|
1955
|
+
written: "written";
|
|
1956
|
+
}>;
|
|
1957
|
+
error: z.ZodNullable<z.ZodString>;
|
|
1958
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1959
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1960
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1961
|
+
}, z.core.$strip>>;
|
|
1962
|
+
readonly page: z.ZodObject<{
|
|
1963
|
+
total: z.ZodNumber;
|
|
1964
|
+
limit: z.ZodNumber;
|
|
1965
|
+
offset: z.ZodNumber;
|
|
1966
|
+
hasMore: z.ZodBoolean;
|
|
1967
|
+
}, z.core.$strip>;
|
|
1968
|
+
}, z.core.$strip>;
|
|
1969
|
+
meta: z.ZodObject<{
|
|
1970
|
+
requestId: z.ZodString;
|
|
1971
|
+
version: z.ZodLiteral<"1.0">;
|
|
1972
|
+
}, z.core.$strict>;
|
|
1973
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1974
|
+
data: z.ZodObject<{
|
|
1975
|
+
readonly briefs: z.ZodArray<z.ZodObject<{
|
|
1976
|
+
id: z.ZodString;
|
|
1977
|
+
siteId: z.ZodString;
|
|
1978
|
+
keyword: z.ZodString;
|
|
1979
|
+
status: z.ZodEnum<{
|
|
1980
|
+
archived: "archived";
|
|
1981
|
+
failed: "failed";
|
|
1982
|
+
published: "published";
|
|
1983
|
+
queued: "queued";
|
|
1984
|
+
ready: "ready";
|
|
1985
|
+
researching: "researching";
|
|
1986
|
+
stale: "stale";
|
|
1987
|
+
written: "written";
|
|
1988
|
+
}>;
|
|
1989
|
+
error: z.ZodNullable<z.ZodString>;
|
|
1990
|
+
generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1991
|
+
markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1992
|
+
updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1993
|
+
}, z.core.$strip>>;
|
|
1994
|
+
readonly page: z.ZodObject<{
|
|
1995
|
+
total: z.ZodNumber;
|
|
1996
|
+
limit: z.ZodNumber;
|
|
1997
|
+
offset: z.ZodNumber;
|
|
1998
|
+
hasMore: z.ZodBoolean;
|
|
1999
|
+
}, z.core.$strip>;
|
|
2000
|
+
}, z.core.$strip>;
|
|
2001
|
+
meta: z.ZodObject<{
|
|
2002
|
+
requestId: z.ZodString;
|
|
2003
|
+
version: z.ZodLiteral<"1.0">;
|
|
2004
|
+
}, z.core.$loose>;
|
|
2005
|
+
}, z.core.$strip>>;
|
|
2006
|
+
};
|
|
2007
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
2008
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2009
|
+
readonly error: z.ZodObject<{
|
|
2010
|
+
code: z.ZodEnum<{
|
|
2011
|
+
auth_expired: "auth_expired";
|
|
2012
|
+
conflict: "conflict";
|
|
2013
|
+
contract_violation: "contract_violation";
|
|
2014
|
+
entitlement_required: "entitlement_required";
|
|
2015
|
+
forbidden: "forbidden";
|
|
2016
|
+
internal_error: "internal_error";
|
|
2017
|
+
invalid_request: "invalid_request";
|
|
2018
|
+
not_found: "not_found";
|
|
2019
|
+
provider_unavailable: "provider_unavailable";
|
|
2020
|
+
quota_exhausted: "quota_exhausted";
|
|
2021
|
+
rate_limited: "rate_limited";
|
|
2022
|
+
site_ambiguous: "site_ambiguous";
|
|
2023
|
+
stale_evidence: "stale_evidence";
|
|
2024
|
+
unauthorized: "unauthorized";
|
|
2025
|
+
}>;
|
|
2026
|
+
message: z.ZodString;
|
|
2027
|
+
requestId: z.ZodString;
|
|
2028
|
+
retryable: z.ZodBoolean;
|
|
2029
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2030
|
+
}, z.core.$strict>;
|
|
2031
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2032
|
+
readonly error: z.ZodObject<{
|
|
2033
|
+
code: z.ZodEnum<{
|
|
2034
|
+
auth_expired: "auth_expired";
|
|
2035
|
+
conflict: "conflict";
|
|
2036
|
+
contract_violation: "contract_violation";
|
|
2037
|
+
entitlement_required: "entitlement_required";
|
|
2038
|
+
forbidden: "forbidden";
|
|
2039
|
+
internal_error: "internal_error";
|
|
2040
|
+
invalid_request: "invalid_request";
|
|
2041
|
+
not_found: "not_found";
|
|
2042
|
+
provider_unavailable: "provider_unavailable";
|
|
2043
|
+
quota_exhausted: "quota_exhausted";
|
|
2044
|
+
rate_limited: "rate_limited";
|
|
2045
|
+
site_ambiguous: "site_ambiguous";
|
|
2046
|
+
stale_evidence: "stale_evidence";
|
|
2047
|
+
unauthorized: "unauthorized";
|
|
2048
|
+
}>;
|
|
2049
|
+
message: z.ZodString;
|
|
2050
|
+
requestId: z.ZodString;
|
|
2051
|
+
retryable: z.ZodBoolean;
|
|
2052
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2053
|
+
}, z.core.$loose>;
|
|
2054
|
+
}, z.core.$strip>>;
|
|
2055
|
+
readonly resources: {
|
|
2056
|
+
readonly reads: readonly [{
|
|
2057
|
+
readonly type: 'site.content';
|
|
2058
|
+
readonly idFrom: 'params.siteId';
|
|
2059
|
+
}];
|
|
2060
|
+
readonly changes: readonly [];
|
|
2061
|
+
};
|
|
2062
|
+
readonly policy: {
|
|
2063
|
+
readonly rate: {
|
|
2064
|
+
readonly name: 'public-v1-fixed-window';
|
|
2065
|
+
readonly limit: 50;
|
|
2066
|
+
readonly windowSeconds: 60;
|
|
2067
|
+
};
|
|
2068
|
+
readonly idempotency: {
|
|
2069
|
+
readonly _tag: 'none';
|
|
2070
|
+
};
|
|
2071
|
+
readonly entitlement: null;
|
|
2072
|
+
readonly meter: null;
|
|
2073
|
+
};
|
|
2074
|
+
readonly lifecycle: {
|
|
2075
|
+
readonly introduced: '1.0.0';
|
|
2076
|
+
};
|
|
2077
|
+
readonly docs: {
|
|
2078
|
+
readonly summary: 'List Content Briefs';
|
|
2079
|
+
readonly description: 'Lists one page of Content Brief summaries owned by a NuxtSEO Site.';
|
|
2080
|
+
readonly tags: readonly ["Content"];
|
|
2081
|
+
readonly examples: readonly [{
|
|
2082
|
+
readonly request: {
|
|
2083
|
+
readonly params: {
|
|
2084
|
+
readonly siteId: 'site_01JXYZ';
|
|
2085
|
+
};
|
|
2086
|
+
readonly query: {
|
|
2087
|
+
readonly limit: 25;
|
|
2088
|
+
readonly offset: 0;
|
|
2089
|
+
};
|
|
2090
|
+
};
|
|
2091
|
+
readonly response: {
|
|
2092
|
+
readonly status: 200;
|
|
2093
|
+
readonly body: {
|
|
2094
|
+
readonly data: {
|
|
2095
|
+
readonly briefs: readonly [{
|
|
2096
|
+
readonly id: 'brief_01JXYZ';
|
|
2097
|
+
readonly siteId: 'site_01JXYZ';
|
|
2098
|
+
readonly keyword: 'nuxt seo';
|
|
2099
|
+
readonly status: 'ready';
|
|
2100
|
+
readonly error: null;
|
|
2101
|
+
readonly generatedAt: '2026-08-10T00:00:00.000Z';
|
|
2102
|
+
readonly markedPublishedAt: null;
|
|
2103
|
+
readonly updatedAt: '2026-08-10T00:00:00.000Z';
|
|
2104
|
+
}];
|
|
2105
|
+
readonly page: {
|
|
2106
|
+
readonly total: 1;
|
|
2107
|
+
readonly limit: 25;
|
|
2108
|
+
readonly offset: 0;
|
|
2109
|
+
readonly hasMore: false;
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
readonly meta: {
|
|
2113
|
+
readonly requestId: 'req_01JXYZ';
|
|
2114
|
+
readonly version: '1.0';
|
|
2115
|
+
};
|
|
2116
|
+
};
|
|
2117
|
+
};
|
|
2118
|
+
}];
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
readonly showBrief: {
|
|
2122
|
+
readonly id: 'content.briefs.show';
|
|
2123
|
+
readonly method: 'GET';
|
|
2124
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs/{briefId}';
|
|
2125
|
+
readonly visibility: 'public';
|
|
2126
|
+
readonly semantics: {
|
|
2127
|
+
readonly kind: 'query';
|
|
2128
|
+
readonly sideEffects: 'none';
|
|
2129
|
+
readonly retry: 'idempotent';
|
|
2130
|
+
readonly readConsistency: 'primary';
|
|
2131
|
+
};
|
|
2132
|
+
readonly auth: {
|
|
2133
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
2134
|
+
readonly scopes: readonly ["content:read"];
|
|
2135
|
+
readonly minimumRole: 'viewer';
|
|
2136
|
+
readonly ownership: 'site';
|
|
2137
|
+
};
|
|
2138
|
+
readonly request: {
|
|
2139
|
+
readonly params: z.ZodObject<{
|
|
2140
|
+
siteId: z.ZodString;
|
|
2141
|
+
briefId: z.ZodString;
|
|
2142
|
+
}, z.core.$strict>;
|
|
2143
|
+
readonly query: null;
|
|
2144
|
+
readonly headers: null;
|
|
2145
|
+
readonly body: null;
|
|
2146
|
+
};
|
|
2147
|
+
readonly responses: {
|
|
2148
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2149
|
+
data: z.ZodObject<{
|
|
2150
|
+
readonly id: z.ZodString;
|
|
2151
|
+
readonly siteId: z.ZodString;
|
|
2152
|
+
readonly keyword: z.ZodString;
|
|
2153
|
+
readonly status: z.ZodEnum<{
|
|
2154
|
+
archived: "archived";
|
|
2155
|
+
failed: "failed";
|
|
2156
|
+
published: "published";
|
|
2157
|
+
queued: "queued";
|
|
2158
|
+
ready: "ready";
|
|
2159
|
+
researching: "researching";
|
|
2160
|
+
stale: "stale";
|
|
2161
|
+
written: "written";
|
|
2162
|
+
}>;
|
|
2163
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
2164
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2165
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2166
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2167
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
2168
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
2169
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
2170
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
2171
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
2172
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
2173
|
+
fetchedAt: z.ZodISODateTime;
|
|
2174
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
2175
|
+
position: z.ZodNumber;
|
|
2176
|
+
url: z.ZodURL;
|
|
2177
|
+
title: z.ZodString;
|
|
2178
|
+
domain: z.ZodString;
|
|
2179
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
2180
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
2181
|
+
}, z.core.$strip>>;
|
|
2182
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2183
|
+
question: z.ZodString;
|
|
2184
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
2185
|
+
}, z.core.$strip>>>;
|
|
2186
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
2187
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2188
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
2189
|
+
}, z.core.$strip>>;
|
|
2190
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2191
|
+
level: z.ZodEnum<{
|
|
2192
|
+
h1: "h1";
|
|
2193
|
+
h2: "h2";
|
|
2194
|
+
h3: "h3";
|
|
2195
|
+
}>;
|
|
2196
|
+
heading: z.ZodString;
|
|
2197
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
2198
|
+
"from-aio": "from-aio";
|
|
2199
|
+
"from-paa": "from-paa";
|
|
2200
|
+
gap: "gap";
|
|
2201
|
+
"intent-match": "intent-match";
|
|
2202
|
+
"your-strength": "your-strength";
|
|
2203
|
+
}>>;
|
|
2204
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
2205
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
2206
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
2207
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
2208
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
2209
|
+
}, z.core.$strip>>>;
|
|
2210
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2211
|
+
url: z.ZodURL;
|
|
2212
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
2213
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
2214
|
+
reasoning: z.ZodString;
|
|
2215
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
2216
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
2217
|
+
}, z.core.$strip>>>;
|
|
2218
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
2219
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2220
|
+
}, z.core.$strip>>;
|
|
2221
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2222
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2223
|
+
}, z.core.$strip>;
|
|
2224
|
+
meta: z.ZodObject<{
|
|
2225
|
+
requestId: z.ZodString;
|
|
2226
|
+
version: z.ZodLiteral<"1.0">;
|
|
2227
|
+
}, z.core.$strict>;
|
|
2228
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2229
|
+
data: z.ZodObject<{
|
|
2230
|
+
readonly id: z.ZodString;
|
|
2231
|
+
readonly siteId: z.ZodString;
|
|
2232
|
+
readonly keyword: z.ZodString;
|
|
2233
|
+
readonly status: z.ZodEnum<{
|
|
2234
|
+
archived: "archived";
|
|
2235
|
+
failed: "failed";
|
|
2236
|
+
published: "published";
|
|
2237
|
+
queued: "queued";
|
|
2238
|
+
ready: "ready";
|
|
2239
|
+
researching: "researching";
|
|
2240
|
+
stale: "stale";
|
|
2241
|
+
written: "written";
|
|
2242
|
+
}>;
|
|
2243
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
2244
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2245
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2246
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2247
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
2248
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
2249
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
2250
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
2251
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
2252
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
2253
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2254
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
2255
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
2256
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
2257
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2258
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
2259
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
2260
|
+
position: z.ZodNumber;
|
|
2261
|
+
url: z.ZodURL;
|
|
2262
|
+
title: z.ZodString;
|
|
2263
|
+
domain: z.ZodString;
|
|
2264
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
2265
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
2266
|
+
}, z.core.$strip>>;
|
|
2267
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2268
|
+
question: z.ZodString;
|
|
2269
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
2270
|
+
}, z.core.$strip>>>;
|
|
2271
|
+
}, z.core.$strip>>;
|
|
2272
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2273
|
+
level: z.ZodEnum<{
|
|
2274
|
+
h1: "h1";
|
|
2275
|
+
h2: "h2";
|
|
2276
|
+
h3: "h3";
|
|
2277
|
+
}>;
|
|
2278
|
+
heading: z.ZodString;
|
|
2279
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
2280
|
+
"from-aio": "from-aio";
|
|
2281
|
+
"from-paa": "from-paa";
|
|
2282
|
+
gap: "gap";
|
|
2283
|
+
"intent-match": "intent-match";
|
|
2284
|
+
"your-strength": "your-strength";
|
|
2285
|
+
}>>;
|
|
2286
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
2287
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
2288
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
2289
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
2290
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
2291
|
+
}, z.core.$strip>>>;
|
|
2292
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2293
|
+
url: z.ZodURL;
|
|
2294
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
2295
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
2296
|
+
reasoning: z.ZodString;
|
|
2297
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
2298
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
2299
|
+
}, z.core.$strip>>>;
|
|
2300
|
+
}, z.core.$strip>>;
|
|
2301
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2302
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2303
|
+
}, z.core.$strip>;
|
|
2304
|
+
meta: z.ZodObject<{
|
|
2305
|
+
requestId: z.ZodString;
|
|
2306
|
+
version: z.ZodLiteral<"1.0">;
|
|
2307
|
+
}, z.core.$loose>;
|
|
2308
|
+
}, z.core.$strip>>;
|
|
2309
|
+
};
|
|
2310
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
2311
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2312
|
+
readonly error: z.ZodObject<{
|
|
2313
|
+
code: z.ZodEnum<{
|
|
2314
|
+
auth_expired: "auth_expired";
|
|
2315
|
+
conflict: "conflict";
|
|
2316
|
+
contract_violation: "contract_violation";
|
|
2317
|
+
entitlement_required: "entitlement_required";
|
|
2318
|
+
forbidden: "forbidden";
|
|
2319
|
+
internal_error: "internal_error";
|
|
2320
|
+
invalid_request: "invalid_request";
|
|
2321
|
+
not_found: "not_found";
|
|
2322
|
+
provider_unavailable: "provider_unavailable";
|
|
2323
|
+
quota_exhausted: "quota_exhausted";
|
|
2324
|
+
rate_limited: "rate_limited";
|
|
2325
|
+
site_ambiguous: "site_ambiguous";
|
|
2326
|
+
stale_evidence: "stale_evidence";
|
|
2327
|
+
unauthorized: "unauthorized";
|
|
2328
|
+
}>;
|
|
2329
|
+
message: z.ZodString;
|
|
2330
|
+
requestId: z.ZodString;
|
|
2331
|
+
retryable: z.ZodBoolean;
|
|
2332
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2333
|
+
}, z.core.$strict>;
|
|
2334
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2335
|
+
readonly error: z.ZodObject<{
|
|
2336
|
+
code: z.ZodEnum<{
|
|
2337
|
+
auth_expired: "auth_expired";
|
|
2338
|
+
conflict: "conflict";
|
|
2339
|
+
contract_violation: "contract_violation";
|
|
2340
|
+
entitlement_required: "entitlement_required";
|
|
2341
|
+
forbidden: "forbidden";
|
|
2342
|
+
internal_error: "internal_error";
|
|
2343
|
+
invalid_request: "invalid_request";
|
|
2344
|
+
not_found: "not_found";
|
|
2345
|
+
provider_unavailable: "provider_unavailable";
|
|
2346
|
+
quota_exhausted: "quota_exhausted";
|
|
2347
|
+
rate_limited: "rate_limited";
|
|
2348
|
+
site_ambiguous: "site_ambiguous";
|
|
2349
|
+
stale_evidence: "stale_evidence";
|
|
2350
|
+
unauthorized: "unauthorized";
|
|
2351
|
+
}>;
|
|
2352
|
+
message: z.ZodString;
|
|
2353
|
+
requestId: z.ZodString;
|
|
2354
|
+
retryable: z.ZodBoolean;
|
|
2355
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2356
|
+
}, z.core.$loose>;
|
|
2357
|
+
}, z.core.$strip>>;
|
|
2358
|
+
readonly resources: {
|
|
2359
|
+
readonly reads: readonly [{
|
|
2360
|
+
readonly type: 'site.content';
|
|
2361
|
+
readonly idFrom: 'params.siteId';
|
|
2362
|
+
}];
|
|
2363
|
+
readonly changes: readonly [];
|
|
2364
|
+
};
|
|
2365
|
+
readonly policy: {
|
|
2366
|
+
readonly rate: {
|
|
2367
|
+
readonly name: 'public-v1-fixed-window';
|
|
2368
|
+
readonly limit: 50;
|
|
2369
|
+
readonly windowSeconds: 60;
|
|
2370
|
+
};
|
|
2371
|
+
readonly idempotency: {
|
|
2372
|
+
readonly _tag: 'none';
|
|
2373
|
+
};
|
|
2374
|
+
readonly entitlement: null;
|
|
2375
|
+
readonly meter: null;
|
|
2376
|
+
};
|
|
2377
|
+
readonly lifecycle: {
|
|
2378
|
+
readonly introduced: '1.0.0';
|
|
2379
|
+
};
|
|
2380
|
+
readonly docs: {
|
|
2381
|
+
readonly summary: 'Show a Content Brief';
|
|
2382
|
+
readonly description: 'Returns one Content Brief with its grounded SERP, outline, and internal-link evidence.';
|
|
2383
|
+
readonly tags: readonly ["Content"];
|
|
2384
|
+
readonly examples: readonly [{
|
|
2385
|
+
readonly request: {
|
|
2386
|
+
readonly params: {
|
|
2387
|
+
readonly siteId: 'site_01JXYZ';
|
|
2388
|
+
readonly briefId: 'brief_01JXYZ';
|
|
2389
|
+
};
|
|
2390
|
+
};
|
|
2391
|
+
readonly response: {
|
|
2392
|
+
readonly status: 200;
|
|
2393
|
+
readonly body: {
|
|
2394
|
+
readonly data: {
|
|
2395
|
+
id: string;
|
|
2396
|
+
siteId: string;
|
|
2397
|
+
keyword: string;
|
|
2398
|
+
status: 'ready';
|
|
2399
|
+
error: null;
|
|
2400
|
+
generatedAt: string;
|
|
2401
|
+
markedPublishedAt: null;
|
|
2402
|
+
updatedAt: string;
|
|
2403
|
+
createdAt: string;
|
|
2404
|
+
markedWrittenAt: null;
|
|
2405
|
+
payload: {
|
|
2406
|
+
targetPage: string;
|
|
2407
|
+
outline: {
|
|
2408
|
+
level: 'h1';
|
|
2409
|
+
heading: string;
|
|
2410
|
+
}[];
|
|
2411
|
+
internalLinks: never[];
|
|
2412
|
+
};
|
|
2413
|
+
};
|
|
2414
|
+
readonly meta: {
|
|
2415
|
+
readonly requestId: 'req_01JXYZ';
|
|
2416
|
+
readonly version: '1.0';
|
|
2417
|
+
};
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
}];
|
|
2421
|
+
};
|
|
2422
|
+
};
|
|
2423
|
+
readonly createBrief: {
|
|
2424
|
+
readonly id: 'content.briefs.create';
|
|
2425
|
+
readonly method: 'POST';
|
|
2426
|
+
readonly path: '/api/v1/sites/{siteId}/content/briefs';
|
|
2427
|
+
readonly visibility: 'public';
|
|
2428
|
+
readonly semantics: {
|
|
2429
|
+
readonly kind: 'mutation';
|
|
2430
|
+
readonly sideEffects: 'state';
|
|
2431
|
+
readonly retry: 'never';
|
|
2432
|
+
readonly readConsistency: null;
|
|
2433
|
+
};
|
|
2434
|
+
readonly auth: {
|
|
2435
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
2436
|
+
readonly scopes: readonly ["content:write"];
|
|
2437
|
+
readonly minimumRole: 'member';
|
|
2438
|
+
readonly ownership: 'site';
|
|
2439
|
+
};
|
|
2440
|
+
readonly request: {
|
|
2441
|
+
readonly params: z.ZodObject<{
|
|
2442
|
+
siteId: z.ZodString;
|
|
2443
|
+
}, z.core.$strict>;
|
|
2444
|
+
readonly query: null;
|
|
2445
|
+
readonly headers: null;
|
|
2446
|
+
readonly body: z.ZodObject<{
|
|
2447
|
+
keyword: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
|
|
2448
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
2449
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
2450
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
2451
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
2452
|
+
}, z.core.$strict>;
|
|
2453
|
+
};
|
|
2454
|
+
readonly responses: {
|
|
2455
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2456
|
+
data: z.ZodObject<{
|
|
2457
|
+
readonly brief: z.ZodObject<{
|
|
2458
|
+
readonly id: z.ZodString;
|
|
2459
|
+
readonly siteId: z.ZodString;
|
|
2460
|
+
readonly keyword: z.ZodString;
|
|
2461
|
+
readonly status: z.ZodEnum<{
|
|
2462
|
+
archived: "archived";
|
|
2463
|
+
failed: "failed";
|
|
2464
|
+
published: "published";
|
|
2465
|
+
queued: "queued";
|
|
2466
|
+
ready: "ready";
|
|
2467
|
+
researching: "researching";
|
|
2468
|
+
stale: "stale";
|
|
2469
|
+
written: "written";
|
|
2470
|
+
}>;
|
|
2471
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
2472
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2473
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2474
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2475
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
2476
|
+
targetPage: z.ZodOptional<z.ZodURL>;
|
|
2477
|
+
currentRank: z.ZodOptional<z.ZodNumber>;
|
|
2478
|
+
currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
2479
|
+
currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
2480
|
+
serp: z.ZodOptional<z.ZodObject<{
|
|
2481
|
+
fetchedAt: z.ZodISODateTime;
|
|
2482
|
+
topResults: z.ZodArray<z.ZodObject<{
|
|
2483
|
+
position: z.ZodNumber;
|
|
2484
|
+
url: z.ZodURL;
|
|
2485
|
+
title: z.ZodString;
|
|
2486
|
+
domain: z.ZodString;
|
|
2487
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
2488
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
2489
|
+
}, z.core.$strip>>;
|
|
2490
|
+
paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2491
|
+
question: z.ZodString;
|
|
2492
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
2493
|
+
}, z.core.$strip>>>;
|
|
2494
|
+
aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
2495
|
+
serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2496
|
+
medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
2497
|
+
}, z.core.$strip>>;
|
|
2498
|
+
outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2499
|
+
level: z.ZodEnum<{
|
|
2500
|
+
h1: "h1";
|
|
2501
|
+
h2: "h2";
|
|
2502
|
+
h3: "h3";
|
|
2503
|
+
}>;
|
|
2504
|
+
heading: z.ZodString;
|
|
2505
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
2506
|
+
"from-aio": "from-aio";
|
|
2507
|
+
"from-paa": "from-paa";
|
|
2508
|
+
gap: "gap";
|
|
2509
|
+
"intent-match": "intent-match";
|
|
2510
|
+
"your-strength": "your-strength";
|
|
2511
|
+
}>>;
|
|
2512
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
2513
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
2514
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
2515
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
2516
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
2517
|
+
}, z.core.$strip>>>;
|
|
2518
|
+
internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2519
|
+
url: z.ZodURL;
|
|
2520
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
2521
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
2522
|
+
reasoning: z.ZodString;
|
|
2523
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
2524
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
2525
|
+
}, z.core.$strip>>>;
|
|
2526
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
2527
|
+
notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2528
|
+
}, z.core.$strip>>;
|
|
2529
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2530
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2531
|
+
}, z.core.$strip>;
|
|
2532
|
+
readonly created: z.ZodBoolean;
|
|
2533
|
+
}, z.core.$strip>;
|
|
2534
|
+
meta: z.ZodObject<{
|
|
2535
|
+
requestId: z.ZodString;
|
|
2536
|
+
version: z.ZodLiteral<"1.0">;
|
|
2537
|
+
}, z.core.$strict>;
|
|
2538
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2539
|
+
data: z.ZodObject<{
|
|
2540
|
+
readonly brief: z.ZodObject<{
|
|
2541
|
+
readonly id: z.ZodString;
|
|
2542
|
+
readonly siteId: z.ZodString;
|
|
2543
|
+
readonly keyword: z.ZodString;
|
|
2544
|
+
readonly status: z.ZodEnum<{
|
|
2545
|
+
archived: "archived";
|
|
2546
|
+
failed: "failed";
|
|
2547
|
+
published: "published";
|
|
2548
|
+
queued: "queued";
|
|
2549
|
+
ready: "ready";
|
|
2550
|
+
researching: "researching";
|
|
2551
|
+
stale: "stale";
|
|
2552
|
+
written: "written";
|
|
2553
|
+
}>;
|
|
2554
|
+
readonly error: z.ZodNullable<z.ZodString>;
|
|
2555
|
+
readonly generatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2556
|
+
readonly markedPublishedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2557
|
+
readonly updatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2558
|
+
readonly payload: z.ZodNullable<z.ZodObject<{
|
|
2559
|
+
readonly targetPage: z.ZodOptional<z.ZodURL>;
|
|
2560
|
+
readonly currentRank: z.ZodOptional<z.ZodNumber>;
|
|
2561
|
+
readonly currentImpressions: z.ZodOptional<z.ZodNumber>;
|
|
2562
|
+
readonly currentClicks: z.ZodOptional<z.ZodNumber>;
|
|
2563
|
+
readonly summary: z.ZodOptional<z.ZodString>;
|
|
2564
|
+
readonly notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2565
|
+
readonly serp: z.ZodOptional<z.ZodObject<{
|
|
2566
|
+
readonly fetchedAt: z.ZodISODateTime;
|
|
2567
|
+
readonly aiOverviewPresent: z.ZodOptional<z.ZodBoolean>;
|
|
2568
|
+
readonly serpFeatures: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2569
|
+
readonly medianWordCount: z.ZodOptional<z.ZodNumber>;
|
|
2570
|
+
readonly topResults: z.ZodArray<z.ZodObject<{
|
|
2571
|
+
position: z.ZodNumber;
|
|
2572
|
+
url: z.ZodURL;
|
|
2573
|
+
title: z.ZodString;
|
|
2574
|
+
domain: z.ZodString;
|
|
2575
|
+
snippet: z.ZodOptional<z.ZodString>;
|
|
2576
|
+
wordCount: z.ZodOptional<z.ZodNumber>;
|
|
2577
|
+
}, z.core.$strip>>;
|
|
2578
|
+
readonly paa: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2579
|
+
question: z.ZodString;
|
|
2580
|
+
answer: z.ZodOptional<z.ZodString>;
|
|
2581
|
+
}, z.core.$strip>>>;
|
|
2582
|
+
}, z.core.$strip>>;
|
|
2583
|
+
readonly outline: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2584
|
+
level: z.ZodEnum<{
|
|
2585
|
+
h1: "h1";
|
|
2586
|
+
h2: "h2";
|
|
2587
|
+
h3: "h3";
|
|
2588
|
+
}>;
|
|
2589
|
+
heading: z.ZodString;
|
|
2590
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
2591
|
+
"from-aio": "from-aio";
|
|
2592
|
+
"from-paa": "from-paa";
|
|
2593
|
+
gap: "gap";
|
|
2594
|
+
"intent-match": "intent-match";
|
|
2595
|
+
"your-strength": "your-strength";
|
|
2596
|
+
}>>;
|
|
2597
|
+
annotation: z.ZodOptional<z.ZodString>;
|
|
2598
|
+
wordCountTarget: z.ZodOptional<z.ZodNumber>;
|
|
2599
|
+
sourceResultUrls: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
2600
|
+
existingCoverageExcerpt: z.ZodOptional<z.ZodString>;
|
|
2601
|
+
existingCoverageUrl: z.ZodOptional<z.ZodURL>;
|
|
2602
|
+
}, z.core.$strip>>>;
|
|
2603
|
+
readonly internalLinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2604
|
+
url: z.ZodURL;
|
|
2605
|
+
impressions: z.ZodOptional<z.ZodNumber>;
|
|
2606
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
2607
|
+
reasoning: z.ZodString;
|
|
2608
|
+
anchorSuggestion: z.ZodOptional<z.ZodString>;
|
|
2609
|
+
excerpt: z.ZodOptional<z.ZodString>;
|
|
2610
|
+
}, z.core.$strip>>>;
|
|
2611
|
+
}, z.core.$strip>>;
|
|
2612
|
+
readonly createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2613
|
+
readonly markedWrittenAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2614
|
+
}, z.core.$strip>;
|
|
2615
|
+
readonly created: z.ZodBoolean;
|
|
2616
|
+
}, z.core.$strip>;
|
|
2617
|
+
meta: z.ZodObject<{
|
|
2618
|
+
requestId: z.ZodString;
|
|
2619
|
+
version: z.ZodLiteral<"1.0">;
|
|
2620
|
+
}, z.core.$loose>;
|
|
2621
|
+
}, z.core.$strip>>;
|
|
2622
|
+
};
|
|
2623
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error", "entitlement_required", "conflict", "quota_exhausted"];
|
|
2624
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2625
|
+
readonly error: z.ZodObject<{
|
|
2626
|
+
code: z.ZodEnum<{
|
|
2627
|
+
auth_expired: "auth_expired";
|
|
2628
|
+
conflict: "conflict";
|
|
2629
|
+
contract_violation: "contract_violation";
|
|
2630
|
+
entitlement_required: "entitlement_required";
|
|
2631
|
+
forbidden: "forbidden";
|
|
2632
|
+
internal_error: "internal_error";
|
|
2633
|
+
invalid_request: "invalid_request";
|
|
2634
|
+
not_found: "not_found";
|
|
2635
|
+
provider_unavailable: "provider_unavailable";
|
|
2636
|
+
quota_exhausted: "quota_exhausted";
|
|
2637
|
+
rate_limited: "rate_limited";
|
|
2638
|
+
site_ambiguous: "site_ambiguous";
|
|
2639
|
+
stale_evidence: "stale_evidence";
|
|
2640
|
+
unauthorized: "unauthorized";
|
|
2641
|
+
}>;
|
|
2642
|
+
message: z.ZodString;
|
|
2643
|
+
requestId: z.ZodString;
|
|
2644
|
+
retryable: z.ZodBoolean;
|
|
2645
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2646
|
+
}, z.core.$strict>;
|
|
2647
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2648
|
+
readonly error: z.ZodObject<{
|
|
2649
|
+
code: z.ZodEnum<{
|
|
2650
|
+
auth_expired: "auth_expired";
|
|
2651
|
+
conflict: "conflict";
|
|
2652
|
+
contract_violation: "contract_violation";
|
|
2653
|
+
entitlement_required: "entitlement_required";
|
|
2654
|
+
forbidden: "forbidden";
|
|
2655
|
+
internal_error: "internal_error";
|
|
2656
|
+
invalid_request: "invalid_request";
|
|
2657
|
+
not_found: "not_found";
|
|
2658
|
+
provider_unavailable: "provider_unavailable";
|
|
2659
|
+
quota_exhausted: "quota_exhausted";
|
|
2660
|
+
rate_limited: "rate_limited";
|
|
2661
|
+
site_ambiguous: "site_ambiguous";
|
|
2662
|
+
stale_evidence: "stale_evidence";
|
|
2663
|
+
unauthorized: "unauthorized";
|
|
2664
|
+
}>;
|
|
2665
|
+
message: z.ZodString;
|
|
2666
|
+
requestId: z.ZodString;
|
|
2667
|
+
retryable: z.ZodBoolean;
|
|
2668
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2669
|
+
}, z.core.$loose>;
|
|
2670
|
+
}, z.core.$strip>>;
|
|
2671
|
+
readonly resources: {
|
|
2672
|
+
readonly reads: readonly [{
|
|
2673
|
+
readonly type: 'site.content';
|
|
2674
|
+
readonly idFrom: 'params.siteId';
|
|
2675
|
+
}];
|
|
2676
|
+
readonly changes: readonly [{
|
|
2677
|
+
readonly type: 'site.content';
|
|
2678
|
+
readonly idFrom: 'params.siteId';
|
|
2679
|
+
}];
|
|
2680
|
+
};
|
|
2681
|
+
readonly policy: {
|
|
2682
|
+
readonly rate: {
|
|
2683
|
+
readonly name: 'public-v1-fixed-window';
|
|
2684
|
+
readonly limit: 50;
|
|
2685
|
+
readonly windowSeconds: 60;
|
|
2686
|
+
};
|
|
2687
|
+
readonly idempotency: {
|
|
2688
|
+
readonly _tag: 'none';
|
|
2689
|
+
};
|
|
2690
|
+
readonly entitlement: 'pro';
|
|
2691
|
+
readonly meter: null;
|
|
2692
|
+
};
|
|
2693
|
+
readonly lifecycle: {
|
|
2694
|
+
readonly introduced: '1.0.0';
|
|
2695
|
+
};
|
|
2696
|
+
readonly docs: {
|
|
2697
|
+
readonly summary: 'Create a Content Brief';
|
|
2698
|
+
readonly description: 'Creates or returns the existing Site-owned Content Brief for a canonical target keyword.';
|
|
2699
|
+
readonly tags: readonly ["Content"];
|
|
2700
|
+
readonly examples: readonly [{
|
|
2701
|
+
readonly request: {
|
|
2702
|
+
readonly params: {
|
|
2703
|
+
readonly siteId: 'site_01JXYZ';
|
|
2704
|
+
};
|
|
2705
|
+
readonly body: {
|
|
2706
|
+
readonly keyword: 'nuxt seo';
|
|
2707
|
+
readonly targetPage: 'https://example.com/guide';
|
|
2708
|
+
};
|
|
2709
|
+
};
|
|
2710
|
+
readonly response: {
|
|
2711
|
+
readonly status: 200;
|
|
2712
|
+
readonly body: {
|
|
2713
|
+
readonly data: {
|
|
2714
|
+
readonly brief: {
|
|
2715
|
+
id: string;
|
|
2716
|
+
siteId: string;
|
|
2717
|
+
keyword: string;
|
|
2718
|
+
status: 'ready';
|
|
2719
|
+
error: null;
|
|
2720
|
+
generatedAt: string;
|
|
2721
|
+
markedPublishedAt: null;
|
|
2722
|
+
updatedAt: string;
|
|
2723
|
+
createdAt: string;
|
|
2724
|
+
markedWrittenAt: null;
|
|
2725
|
+
payload: {
|
|
2726
|
+
targetPage: string;
|
|
2727
|
+
outline: {
|
|
2728
|
+
level: 'h1';
|
|
2729
|
+
heading: string;
|
|
2730
|
+
}[];
|
|
2731
|
+
internalLinks: never[];
|
|
2732
|
+
};
|
|
2733
|
+
};
|
|
2734
|
+
readonly created: true;
|
|
2735
|
+
};
|
|
2736
|
+
readonly meta: {
|
|
2737
|
+
readonly requestId: 'req_01JXYZ';
|
|
2738
|
+
readonly version: '1.0';
|
|
2739
|
+
};
|
|
2740
|
+
};
|
|
2741
|
+
};
|
|
2742
|
+
}];
|
|
2743
|
+
};
|
|
2744
|
+
};
|
|
2745
|
+
}>;
|