@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,715 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
export declare const usageMeterGroupSchema: z.ZodEnum<{
|
|
3
|
+
capacity: "capacity";
|
|
4
|
+
compute: "compute";
|
|
5
|
+
integrations: "integrations";
|
|
6
|
+
}>;
|
|
7
|
+
export declare const usageUpgradeTierSchema: z.ZodEnum<{
|
|
8
|
+
agency: "agency";
|
|
9
|
+
free: "free";
|
|
10
|
+
full: "full";
|
|
11
|
+
lifetime: "lifetime";
|
|
12
|
+
pro: "pro";
|
|
13
|
+
search: "search";
|
|
14
|
+
}>;
|
|
15
|
+
export declare const usagePlanSchema: z.ZodEnum<{
|
|
16
|
+
agency: "agency";
|
|
17
|
+
free: "free";
|
|
18
|
+
full: "full";
|
|
19
|
+
lifetime: "lifetime";
|
|
20
|
+
pro: "pro";
|
|
21
|
+
search: "search";
|
|
22
|
+
}>;
|
|
23
|
+
export declare const accountUsageQuerySchema: z.ZodObject<{
|
|
24
|
+
group: z.ZodOptional<z.ZodEnum<{
|
|
25
|
+
capacity: "capacity";
|
|
26
|
+
compute: "compute";
|
|
27
|
+
integrations: "integrations";
|
|
28
|
+
}>>;
|
|
29
|
+
}, z.core.$strict>;
|
|
30
|
+
export declare const usageMeterProducerSchema: z.ZodObject<{
|
|
31
|
+
key: z.ZodString;
|
|
32
|
+
label: z.ZodString;
|
|
33
|
+
description: z.ZodString;
|
|
34
|
+
group: z.ZodEnum<{
|
|
35
|
+
capacity: "capacity";
|
|
36
|
+
compute: "compute";
|
|
37
|
+
integrations: "integrations";
|
|
38
|
+
}>;
|
|
39
|
+
unit: z.ZodString;
|
|
40
|
+
used: z.ZodNumber;
|
|
41
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
42
|
+
blocked: z.ZodBoolean;
|
|
43
|
+
overCap: z.ZodBoolean;
|
|
44
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
45
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
46
|
+
tier: z.ZodEnum<{
|
|
47
|
+
agency: "agency";
|
|
48
|
+
free: "free";
|
|
49
|
+
full: "full";
|
|
50
|
+
lifetime: "lifetime";
|
|
51
|
+
pro: "pro";
|
|
52
|
+
search: "search";
|
|
53
|
+
}>;
|
|
54
|
+
gain: z.ZodString;
|
|
55
|
+
}, z.core.$strict>>;
|
|
56
|
+
}, z.core.$strict>;
|
|
57
|
+
export declare const usageMeterClientSchema: z.ZodObject<{
|
|
58
|
+
key: z.ZodString;
|
|
59
|
+
label: z.ZodString;
|
|
60
|
+
description: z.ZodString;
|
|
61
|
+
group: z.ZodEnum<{
|
|
62
|
+
capacity: "capacity";
|
|
63
|
+
compute: "compute";
|
|
64
|
+
integrations: "integrations";
|
|
65
|
+
}>;
|
|
66
|
+
unit: z.ZodString;
|
|
67
|
+
used: z.ZodNumber;
|
|
68
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
69
|
+
blocked: z.ZodBoolean;
|
|
70
|
+
overCap: z.ZodBoolean;
|
|
71
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
72
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
73
|
+
tier: z.ZodEnum<{
|
|
74
|
+
agency: "agency";
|
|
75
|
+
free: "free";
|
|
76
|
+
full: "full";
|
|
77
|
+
lifetime: "lifetime";
|
|
78
|
+
pro: "pro";
|
|
79
|
+
search: "search";
|
|
80
|
+
}>;
|
|
81
|
+
gain: z.ZodString;
|
|
82
|
+
}, z.core.$loose>>;
|
|
83
|
+
}, z.core.$loose>;
|
|
84
|
+
export declare const accountUsageDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
85
|
+
readonly plan: z.ZodEnum<{
|
|
86
|
+
agency: "agency";
|
|
87
|
+
free: "free";
|
|
88
|
+
full: "full";
|
|
89
|
+
lifetime: "lifetime";
|
|
90
|
+
pro: "pro";
|
|
91
|
+
search: "search";
|
|
92
|
+
}>;
|
|
93
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
94
|
+
key: z.ZodString;
|
|
95
|
+
label: z.ZodString;
|
|
96
|
+
description: z.ZodString;
|
|
97
|
+
group: z.ZodEnum<{
|
|
98
|
+
capacity: "capacity";
|
|
99
|
+
compute: "compute";
|
|
100
|
+
integrations: "integrations";
|
|
101
|
+
}>;
|
|
102
|
+
unit: z.ZodString;
|
|
103
|
+
used: z.ZodNumber;
|
|
104
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
105
|
+
blocked: z.ZodBoolean;
|
|
106
|
+
overCap: z.ZodBoolean;
|
|
107
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
108
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
109
|
+
tier: z.ZodEnum<{
|
|
110
|
+
agency: "agency";
|
|
111
|
+
free: "free";
|
|
112
|
+
full: "full";
|
|
113
|
+
lifetime: "lifetime";
|
|
114
|
+
pro: "pro";
|
|
115
|
+
search: "search";
|
|
116
|
+
}>;
|
|
117
|
+
gain: z.ZodString;
|
|
118
|
+
}, z.core.$strict>>;
|
|
119
|
+
}, z.core.$strict>>;
|
|
120
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
121
|
+
readonly plan: z.ZodEnum<{
|
|
122
|
+
agency: "agency";
|
|
123
|
+
free: "free";
|
|
124
|
+
full: "full";
|
|
125
|
+
lifetime: "lifetime";
|
|
126
|
+
pro: "pro";
|
|
127
|
+
search: "search";
|
|
128
|
+
}>;
|
|
129
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
130
|
+
key: z.ZodString;
|
|
131
|
+
label: z.ZodString;
|
|
132
|
+
description: z.ZodString;
|
|
133
|
+
group: z.ZodEnum<{
|
|
134
|
+
capacity: "capacity";
|
|
135
|
+
compute: "compute";
|
|
136
|
+
integrations: "integrations";
|
|
137
|
+
}>;
|
|
138
|
+
unit: z.ZodString;
|
|
139
|
+
used: z.ZodNumber;
|
|
140
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
141
|
+
blocked: z.ZodBoolean;
|
|
142
|
+
overCap: z.ZodBoolean;
|
|
143
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
144
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
145
|
+
tier: z.ZodEnum<{
|
|
146
|
+
agency: "agency";
|
|
147
|
+
free: "free";
|
|
148
|
+
full: "full";
|
|
149
|
+
lifetime: "lifetime";
|
|
150
|
+
pro: "pro";
|
|
151
|
+
search: "search";
|
|
152
|
+
}>;
|
|
153
|
+
gain: z.ZodString;
|
|
154
|
+
}, z.core.$loose>>;
|
|
155
|
+
}, z.core.$loose>>;
|
|
156
|
+
}, z.core.$strip>>;
|
|
157
|
+
export declare const accountUsageMetaSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
158
|
+
readonly requestId: z.ZodString;
|
|
159
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
160
|
+
readonly total: z.ZodNumber;
|
|
161
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
162
|
+
readonly requestId: z.ZodString;
|
|
163
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
164
|
+
readonly total: z.ZodNumber;
|
|
165
|
+
}, z.core.$strip>>;
|
|
166
|
+
export declare const accountUsageResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
167
|
+
data: z.ZodObject<{
|
|
168
|
+
readonly plan: z.ZodEnum<{
|
|
169
|
+
agency: "agency";
|
|
170
|
+
free: "free";
|
|
171
|
+
full: "full";
|
|
172
|
+
lifetime: "lifetime";
|
|
173
|
+
pro: "pro";
|
|
174
|
+
search: "search";
|
|
175
|
+
}>;
|
|
176
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
177
|
+
key: z.ZodString;
|
|
178
|
+
label: z.ZodString;
|
|
179
|
+
description: z.ZodString;
|
|
180
|
+
group: z.ZodEnum<{
|
|
181
|
+
capacity: "capacity";
|
|
182
|
+
compute: "compute";
|
|
183
|
+
integrations: "integrations";
|
|
184
|
+
}>;
|
|
185
|
+
unit: z.ZodString;
|
|
186
|
+
used: z.ZodNumber;
|
|
187
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
188
|
+
blocked: z.ZodBoolean;
|
|
189
|
+
overCap: z.ZodBoolean;
|
|
190
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
191
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
192
|
+
tier: z.ZodEnum<{
|
|
193
|
+
agency: "agency";
|
|
194
|
+
free: "free";
|
|
195
|
+
full: "full";
|
|
196
|
+
lifetime: "lifetime";
|
|
197
|
+
pro: "pro";
|
|
198
|
+
search: "search";
|
|
199
|
+
}>;
|
|
200
|
+
gain: z.ZodString;
|
|
201
|
+
}, z.core.$strict>>;
|
|
202
|
+
}, z.core.$strict>>;
|
|
203
|
+
}, z.core.$strip>;
|
|
204
|
+
meta: z.ZodObject<{
|
|
205
|
+
readonly requestId: z.ZodString;
|
|
206
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
207
|
+
readonly total: z.ZodNumber;
|
|
208
|
+
}, z.core.$strip>;
|
|
209
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
210
|
+
data: z.ZodObject<{
|
|
211
|
+
readonly plan: z.ZodEnum<{
|
|
212
|
+
agency: "agency";
|
|
213
|
+
free: "free";
|
|
214
|
+
full: "full";
|
|
215
|
+
lifetime: "lifetime";
|
|
216
|
+
pro: "pro";
|
|
217
|
+
search: "search";
|
|
218
|
+
}>;
|
|
219
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
220
|
+
key: z.ZodString;
|
|
221
|
+
label: z.ZodString;
|
|
222
|
+
description: z.ZodString;
|
|
223
|
+
group: z.ZodEnum<{
|
|
224
|
+
capacity: "capacity";
|
|
225
|
+
compute: "compute";
|
|
226
|
+
integrations: "integrations";
|
|
227
|
+
}>;
|
|
228
|
+
unit: z.ZodString;
|
|
229
|
+
used: z.ZodNumber;
|
|
230
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
231
|
+
blocked: z.ZodBoolean;
|
|
232
|
+
overCap: z.ZodBoolean;
|
|
233
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
234
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
235
|
+
tier: z.ZodEnum<{
|
|
236
|
+
agency: "agency";
|
|
237
|
+
free: "free";
|
|
238
|
+
full: "full";
|
|
239
|
+
lifetime: "lifetime";
|
|
240
|
+
pro: "pro";
|
|
241
|
+
search: "search";
|
|
242
|
+
}>;
|
|
243
|
+
gain: z.ZodString;
|
|
244
|
+
}, z.core.$loose>>;
|
|
245
|
+
}, z.core.$loose>>;
|
|
246
|
+
}, z.core.$strip>;
|
|
247
|
+
meta: z.ZodObject<{
|
|
248
|
+
readonly requestId: z.ZodString;
|
|
249
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
250
|
+
readonly total: z.ZodNumber;
|
|
251
|
+
}, z.core.$strip>;
|
|
252
|
+
}, z.core.$strip>>;
|
|
253
|
+
export type AccountUsageQuery = z.input<typeof accountUsageQuerySchema>;
|
|
254
|
+
export type AccountUsageData = z.output<typeof accountUsageDataSchema.producer>;
|
|
255
|
+
export type UsageMeterProducer = z.output<typeof usageMeterProducerSchema>;
|
|
256
|
+
export type UsageMeter = z.output<typeof usageMeterClientSchema>;
|
|
257
|
+
export type AccountUsageResponse = z.output<typeof accountUsageResponseSchema.client>;
|
|
258
|
+
export declare const accountUsageOperation: {
|
|
259
|
+
readonly id: 'account.usage';
|
|
260
|
+
readonly method: 'GET';
|
|
261
|
+
readonly path: '/api/v1/account/usage';
|
|
262
|
+
readonly visibility: 'public';
|
|
263
|
+
readonly semantics: {
|
|
264
|
+
readonly kind: 'query';
|
|
265
|
+
readonly sideEffects: 'none';
|
|
266
|
+
readonly retry: 'idempotent';
|
|
267
|
+
readonly readConsistency: 'primary';
|
|
268
|
+
};
|
|
269
|
+
readonly auth: {
|
|
270
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
271
|
+
readonly scopes: readonly ["account:read"];
|
|
272
|
+
readonly minimumRole: 'viewer';
|
|
273
|
+
readonly ownership: 'team';
|
|
274
|
+
};
|
|
275
|
+
readonly request: {
|
|
276
|
+
readonly params: null;
|
|
277
|
+
readonly query: z.ZodObject<{
|
|
278
|
+
group: z.ZodOptional<z.ZodEnum<{
|
|
279
|
+
capacity: "capacity";
|
|
280
|
+
compute: "compute";
|
|
281
|
+
integrations: "integrations";
|
|
282
|
+
}>>;
|
|
283
|
+
}, z.core.$strict>;
|
|
284
|
+
readonly headers: null;
|
|
285
|
+
readonly body: null;
|
|
286
|
+
};
|
|
287
|
+
readonly responses: {
|
|
288
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
289
|
+
data: z.ZodObject<{
|
|
290
|
+
readonly plan: z.ZodEnum<{
|
|
291
|
+
agency: "agency";
|
|
292
|
+
free: "free";
|
|
293
|
+
full: "full";
|
|
294
|
+
lifetime: "lifetime";
|
|
295
|
+
pro: "pro";
|
|
296
|
+
search: "search";
|
|
297
|
+
}>;
|
|
298
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
299
|
+
key: z.ZodString;
|
|
300
|
+
label: z.ZodString;
|
|
301
|
+
description: z.ZodString;
|
|
302
|
+
group: z.ZodEnum<{
|
|
303
|
+
capacity: "capacity";
|
|
304
|
+
compute: "compute";
|
|
305
|
+
integrations: "integrations";
|
|
306
|
+
}>;
|
|
307
|
+
unit: z.ZodString;
|
|
308
|
+
used: z.ZodNumber;
|
|
309
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
310
|
+
blocked: z.ZodBoolean;
|
|
311
|
+
overCap: z.ZodBoolean;
|
|
312
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
313
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
314
|
+
tier: z.ZodEnum<{
|
|
315
|
+
agency: "agency";
|
|
316
|
+
free: "free";
|
|
317
|
+
full: "full";
|
|
318
|
+
lifetime: "lifetime";
|
|
319
|
+
pro: "pro";
|
|
320
|
+
search: "search";
|
|
321
|
+
}>;
|
|
322
|
+
gain: z.ZodString;
|
|
323
|
+
}, z.core.$strict>>;
|
|
324
|
+
}, z.core.$strict>>;
|
|
325
|
+
}, z.core.$strip>;
|
|
326
|
+
meta: z.ZodObject<{
|
|
327
|
+
readonly requestId: z.ZodString;
|
|
328
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
329
|
+
readonly total: z.ZodNumber;
|
|
330
|
+
}, z.core.$strip>;
|
|
331
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
332
|
+
data: z.ZodObject<{
|
|
333
|
+
readonly plan: z.ZodEnum<{
|
|
334
|
+
agency: "agency";
|
|
335
|
+
free: "free";
|
|
336
|
+
full: "full";
|
|
337
|
+
lifetime: "lifetime";
|
|
338
|
+
pro: "pro";
|
|
339
|
+
search: "search";
|
|
340
|
+
}>;
|
|
341
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
342
|
+
key: z.ZodString;
|
|
343
|
+
label: z.ZodString;
|
|
344
|
+
description: z.ZodString;
|
|
345
|
+
group: z.ZodEnum<{
|
|
346
|
+
capacity: "capacity";
|
|
347
|
+
compute: "compute";
|
|
348
|
+
integrations: "integrations";
|
|
349
|
+
}>;
|
|
350
|
+
unit: z.ZodString;
|
|
351
|
+
used: z.ZodNumber;
|
|
352
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
353
|
+
blocked: z.ZodBoolean;
|
|
354
|
+
overCap: z.ZodBoolean;
|
|
355
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
356
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
357
|
+
tier: z.ZodEnum<{
|
|
358
|
+
agency: "agency";
|
|
359
|
+
free: "free";
|
|
360
|
+
full: "full";
|
|
361
|
+
lifetime: "lifetime";
|
|
362
|
+
pro: "pro";
|
|
363
|
+
search: "search";
|
|
364
|
+
}>;
|
|
365
|
+
gain: z.ZodString;
|
|
366
|
+
}, z.core.$loose>>;
|
|
367
|
+
}, z.core.$loose>>;
|
|
368
|
+
}, z.core.$strip>;
|
|
369
|
+
meta: z.ZodObject<{
|
|
370
|
+
readonly requestId: z.ZodString;
|
|
371
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
372
|
+
readonly total: z.ZodNumber;
|
|
373
|
+
}, z.core.$strip>;
|
|
374
|
+
}, z.core.$strip>>;
|
|
375
|
+
};
|
|
376
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
|
|
377
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
378
|
+
readonly error: z.ZodObject<{
|
|
379
|
+
code: z.ZodEnum<{
|
|
380
|
+
auth_expired: "auth_expired";
|
|
381
|
+
conflict: "conflict";
|
|
382
|
+
contract_violation: "contract_violation";
|
|
383
|
+
entitlement_required: "entitlement_required";
|
|
384
|
+
forbidden: "forbidden";
|
|
385
|
+
internal_error: "internal_error";
|
|
386
|
+
invalid_request: "invalid_request";
|
|
387
|
+
not_found: "not_found";
|
|
388
|
+
provider_unavailable: "provider_unavailable";
|
|
389
|
+
quota_exhausted: "quota_exhausted";
|
|
390
|
+
rate_limited: "rate_limited";
|
|
391
|
+
site_ambiguous: "site_ambiguous";
|
|
392
|
+
stale_evidence: "stale_evidence";
|
|
393
|
+
unauthorized: "unauthorized";
|
|
394
|
+
}>;
|
|
395
|
+
message: z.ZodString;
|
|
396
|
+
requestId: z.ZodString;
|
|
397
|
+
retryable: z.ZodBoolean;
|
|
398
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
399
|
+
}, z.core.$strict>;
|
|
400
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
401
|
+
readonly error: z.ZodObject<{
|
|
402
|
+
code: z.ZodEnum<{
|
|
403
|
+
auth_expired: "auth_expired";
|
|
404
|
+
conflict: "conflict";
|
|
405
|
+
contract_violation: "contract_violation";
|
|
406
|
+
entitlement_required: "entitlement_required";
|
|
407
|
+
forbidden: "forbidden";
|
|
408
|
+
internal_error: "internal_error";
|
|
409
|
+
invalid_request: "invalid_request";
|
|
410
|
+
not_found: "not_found";
|
|
411
|
+
provider_unavailable: "provider_unavailable";
|
|
412
|
+
quota_exhausted: "quota_exhausted";
|
|
413
|
+
rate_limited: "rate_limited";
|
|
414
|
+
site_ambiguous: "site_ambiguous";
|
|
415
|
+
stale_evidence: "stale_evidence";
|
|
416
|
+
unauthorized: "unauthorized";
|
|
417
|
+
}>;
|
|
418
|
+
message: z.ZodString;
|
|
419
|
+
requestId: z.ZodString;
|
|
420
|
+
retryable: z.ZodBoolean;
|
|
421
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
422
|
+
}, z.core.$loose>;
|
|
423
|
+
}, z.core.$strip>>;
|
|
424
|
+
readonly resources: {
|
|
425
|
+
readonly reads: readonly [{
|
|
426
|
+
readonly type: 'account.usage';
|
|
427
|
+
readonly idFrom: 'team.id';
|
|
428
|
+
}];
|
|
429
|
+
readonly changes: readonly [];
|
|
430
|
+
};
|
|
431
|
+
readonly policy: {
|
|
432
|
+
readonly rate: {
|
|
433
|
+
readonly name: 'public-v1-fixed-window';
|
|
434
|
+
readonly limit: 50;
|
|
435
|
+
readonly windowSeconds: 60;
|
|
436
|
+
};
|
|
437
|
+
readonly idempotency: {
|
|
438
|
+
readonly _tag: 'none';
|
|
439
|
+
};
|
|
440
|
+
readonly entitlement: null;
|
|
441
|
+
readonly meter: null;
|
|
442
|
+
};
|
|
443
|
+
readonly lifecycle: {
|
|
444
|
+
readonly introduced: '1.0.0';
|
|
445
|
+
};
|
|
446
|
+
readonly docs: {
|
|
447
|
+
readonly summary: 'Read account usage';
|
|
448
|
+
readonly description: 'Returns current Team-scoped public meter readings without spending quota.';
|
|
449
|
+
readonly tags: readonly ["Account"];
|
|
450
|
+
readonly examples: readonly [{
|
|
451
|
+
readonly request: {
|
|
452
|
+
readonly query: {};
|
|
453
|
+
};
|
|
454
|
+
readonly response: {
|
|
455
|
+
readonly status: 200;
|
|
456
|
+
readonly body: {
|
|
457
|
+
readonly data: {
|
|
458
|
+
readonly plan: 'pro';
|
|
459
|
+
readonly meters: readonly [{
|
|
460
|
+
readonly key: 'dataforseo';
|
|
461
|
+
readonly label: 'Research lookups';
|
|
462
|
+
readonly description: 'Third-party research requests used by live market analysis.';
|
|
463
|
+
readonly group: 'integrations';
|
|
464
|
+
readonly unit: 'requests';
|
|
465
|
+
readonly used: 8;
|
|
466
|
+
readonly limit: 100;
|
|
467
|
+
readonly blocked: false;
|
|
468
|
+
readonly overCap: false;
|
|
469
|
+
readonly resetsAt: '2026-09-01T00:00:00.000Z';
|
|
470
|
+
readonly upgradeCopy: readonly [{
|
|
471
|
+
readonly tier: 'agency';
|
|
472
|
+
readonly gain: 'Increase monthly research capacity.';
|
|
473
|
+
}];
|
|
474
|
+
}];
|
|
475
|
+
};
|
|
476
|
+
readonly meta: {
|
|
477
|
+
readonly requestId: 'req_01JXYZ';
|
|
478
|
+
readonly version: '1.0';
|
|
479
|
+
readonly total: 1;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
}];
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
|
|
487
|
+
readonly usage: {
|
|
488
|
+
readonly id: 'account.usage';
|
|
489
|
+
readonly method: 'GET';
|
|
490
|
+
readonly path: '/api/v1/account/usage';
|
|
491
|
+
readonly visibility: 'public';
|
|
492
|
+
readonly semantics: {
|
|
493
|
+
readonly kind: 'query';
|
|
494
|
+
readonly sideEffects: 'none';
|
|
495
|
+
readonly retry: 'idempotent';
|
|
496
|
+
readonly readConsistency: 'primary';
|
|
497
|
+
};
|
|
498
|
+
readonly auth: {
|
|
499
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
500
|
+
readonly scopes: readonly ["account:read"];
|
|
501
|
+
readonly minimumRole: 'viewer';
|
|
502
|
+
readonly ownership: 'team';
|
|
503
|
+
};
|
|
504
|
+
readonly request: {
|
|
505
|
+
readonly params: null;
|
|
506
|
+
readonly query: z.ZodObject<{
|
|
507
|
+
group: z.ZodOptional<z.ZodEnum<{
|
|
508
|
+
capacity: "capacity";
|
|
509
|
+
compute: "compute";
|
|
510
|
+
integrations: "integrations";
|
|
511
|
+
}>>;
|
|
512
|
+
}, z.core.$strict>;
|
|
513
|
+
readonly headers: null;
|
|
514
|
+
readonly body: null;
|
|
515
|
+
};
|
|
516
|
+
readonly responses: {
|
|
517
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
518
|
+
data: z.ZodObject<{
|
|
519
|
+
readonly plan: z.ZodEnum<{
|
|
520
|
+
agency: "agency";
|
|
521
|
+
free: "free";
|
|
522
|
+
full: "full";
|
|
523
|
+
lifetime: "lifetime";
|
|
524
|
+
pro: "pro";
|
|
525
|
+
search: "search";
|
|
526
|
+
}>;
|
|
527
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
528
|
+
key: z.ZodString;
|
|
529
|
+
label: z.ZodString;
|
|
530
|
+
description: z.ZodString;
|
|
531
|
+
group: z.ZodEnum<{
|
|
532
|
+
capacity: "capacity";
|
|
533
|
+
compute: "compute";
|
|
534
|
+
integrations: "integrations";
|
|
535
|
+
}>;
|
|
536
|
+
unit: z.ZodString;
|
|
537
|
+
used: z.ZodNumber;
|
|
538
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
539
|
+
blocked: z.ZodBoolean;
|
|
540
|
+
overCap: z.ZodBoolean;
|
|
541
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
542
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
543
|
+
tier: z.ZodEnum<{
|
|
544
|
+
agency: "agency";
|
|
545
|
+
free: "free";
|
|
546
|
+
full: "full";
|
|
547
|
+
lifetime: "lifetime";
|
|
548
|
+
pro: "pro";
|
|
549
|
+
search: "search";
|
|
550
|
+
}>;
|
|
551
|
+
gain: z.ZodString;
|
|
552
|
+
}, z.core.$strict>>;
|
|
553
|
+
}, z.core.$strict>>;
|
|
554
|
+
}, z.core.$strip>;
|
|
555
|
+
meta: z.ZodObject<{
|
|
556
|
+
readonly requestId: z.ZodString;
|
|
557
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
558
|
+
readonly total: z.ZodNumber;
|
|
559
|
+
}, z.core.$strip>;
|
|
560
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
561
|
+
data: z.ZodObject<{
|
|
562
|
+
readonly plan: z.ZodEnum<{
|
|
563
|
+
agency: "agency";
|
|
564
|
+
free: "free";
|
|
565
|
+
full: "full";
|
|
566
|
+
lifetime: "lifetime";
|
|
567
|
+
pro: "pro";
|
|
568
|
+
search: "search";
|
|
569
|
+
}>;
|
|
570
|
+
readonly meters: z.ZodArray<z.ZodObject<{
|
|
571
|
+
key: z.ZodString;
|
|
572
|
+
label: z.ZodString;
|
|
573
|
+
description: z.ZodString;
|
|
574
|
+
group: z.ZodEnum<{
|
|
575
|
+
capacity: "capacity";
|
|
576
|
+
compute: "compute";
|
|
577
|
+
integrations: "integrations";
|
|
578
|
+
}>;
|
|
579
|
+
unit: z.ZodString;
|
|
580
|
+
used: z.ZodNumber;
|
|
581
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
582
|
+
blocked: z.ZodBoolean;
|
|
583
|
+
overCap: z.ZodBoolean;
|
|
584
|
+
resetsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
585
|
+
upgradeCopy: z.ZodArray<z.ZodObject<{
|
|
586
|
+
tier: z.ZodEnum<{
|
|
587
|
+
agency: "agency";
|
|
588
|
+
free: "free";
|
|
589
|
+
full: "full";
|
|
590
|
+
lifetime: "lifetime";
|
|
591
|
+
pro: "pro";
|
|
592
|
+
search: "search";
|
|
593
|
+
}>;
|
|
594
|
+
gain: z.ZodString;
|
|
595
|
+
}, z.core.$loose>>;
|
|
596
|
+
}, z.core.$loose>>;
|
|
597
|
+
}, z.core.$strip>;
|
|
598
|
+
meta: z.ZodObject<{
|
|
599
|
+
readonly requestId: z.ZodString;
|
|
600
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
601
|
+
readonly total: z.ZodNumber;
|
|
602
|
+
}, z.core.$strip>;
|
|
603
|
+
}, z.core.$strip>>;
|
|
604
|
+
};
|
|
605
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
|
|
606
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
607
|
+
readonly error: z.ZodObject<{
|
|
608
|
+
code: z.ZodEnum<{
|
|
609
|
+
auth_expired: "auth_expired";
|
|
610
|
+
conflict: "conflict";
|
|
611
|
+
contract_violation: "contract_violation";
|
|
612
|
+
entitlement_required: "entitlement_required";
|
|
613
|
+
forbidden: "forbidden";
|
|
614
|
+
internal_error: "internal_error";
|
|
615
|
+
invalid_request: "invalid_request";
|
|
616
|
+
not_found: "not_found";
|
|
617
|
+
provider_unavailable: "provider_unavailable";
|
|
618
|
+
quota_exhausted: "quota_exhausted";
|
|
619
|
+
rate_limited: "rate_limited";
|
|
620
|
+
site_ambiguous: "site_ambiguous";
|
|
621
|
+
stale_evidence: "stale_evidence";
|
|
622
|
+
unauthorized: "unauthorized";
|
|
623
|
+
}>;
|
|
624
|
+
message: z.ZodString;
|
|
625
|
+
requestId: z.ZodString;
|
|
626
|
+
retryable: z.ZodBoolean;
|
|
627
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
628
|
+
}, z.core.$strict>;
|
|
629
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
630
|
+
readonly error: z.ZodObject<{
|
|
631
|
+
code: z.ZodEnum<{
|
|
632
|
+
auth_expired: "auth_expired";
|
|
633
|
+
conflict: "conflict";
|
|
634
|
+
contract_violation: "contract_violation";
|
|
635
|
+
entitlement_required: "entitlement_required";
|
|
636
|
+
forbidden: "forbidden";
|
|
637
|
+
internal_error: "internal_error";
|
|
638
|
+
invalid_request: "invalid_request";
|
|
639
|
+
not_found: "not_found";
|
|
640
|
+
provider_unavailable: "provider_unavailable";
|
|
641
|
+
quota_exhausted: "quota_exhausted";
|
|
642
|
+
rate_limited: "rate_limited";
|
|
643
|
+
site_ambiguous: "site_ambiguous";
|
|
644
|
+
stale_evidence: "stale_evidence";
|
|
645
|
+
unauthorized: "unauthorized";
|
|
646
|
+
}>;
|
|
647
|
+
message: z.ZodString;
|
|
648
|
+
requestId: z.ZodString;
|
|
649
|
+
retryable: z.ZodBoolean;
|
|
650
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
651
|
+
}, z.core.$loose>;
|
|
652
|
+
}, z.core.$strip>>;
|
|
653
|
+
readonly resources: {
|
|
654
|
+
readonly reads: readonly [{
|
|
655
|
+
readonly type: 'account.usage';
|
|
656
|
+
readonly idFrom: 'team.id';
|
|
657
|
+
}];
|
|
658
|
+
readonly changes: readonly [];
|
|
659
|
+
};
|
|
660
|
+
readonly policy: {
|
|
661
|
+
readonly rate: {
|
|
662
|
+
readonly name: 'public-v1-fixed-window';
|
|
663
|
+
readonly limit: 50;
|
|
664
|
+
readonly windowSeconds: 60;
|
|
665
|
+
};
|
|
666
|
+
readonly idempotency: {
|
|
667
|
+
readonly _tag: 'none';
|
|
668
|
+
};
|
|
669
|
+
readonly entitlement: null;
|
|
670
|
+
readonly meter: null;
|
|
671
|
+
};
|
|
672
|
+
readonly lifecycle: {
|
|
673
|
+
readonly introduced: '1.0.0';
|
|
674
|
+
};
|
|
675
|
+
readonly docs: {
|
|
676
|
+
readonly summary: 'Read account usage';
|
|
677
|
+
readonly description: 'Returns current Team-scoped public meter readings without spending quota.';
|
|
678
|
+
readonly tags: readonly ["Account"];
|
|
679
|
+
readonly examples: readonly [{
|
|
680
|
+
readonly request: {
|
|
681
|
+
readonly query: {};
|
|
682
|
+
};
|
|
683
|
+
readonly response: {
|
|
684
|
+
readonly status: 200;
|
|
685
|
+
readonly body: {
|
|
686
|
+
readonly data: {
|
|
687
|
+
readonly plan: 'pro';
|
|
688
|
+
readonly meters: readonly [{
|
|
689
|
+
readonly key: 'dataforseo';
|
|
690
|
+
readonly label: 'Research lookups';
|
|
691
|
+
readonly description: 'Third-party research requests used by live market analysis.';
|
|
692
|
+
readonly group: 'integrations';
|
|
693
|
+
readonly unit: 'requests';
|
|
694
|
+
readonly used: 8;
|
|
695
|
+
readonly limit: 100;
|
|
696
|
+
readonly blocked: false;
|
|
697
|
+
readonly overCap: false;
|
|
698
|
+
readonly resetsAt: '2026-09-01T00:00:00.000Z';
|
|
699
|
+
readonly upgradeCopy: readonly [{
|
|
700
|
+
readonly tier: 'agency';
|
|
701
|
+
readonly gain: 'Increase monthly research capacity.';
|
|
702
|
+
}];
|
|
703
|
+
}];
|
|
704
|
+
};
|
|
705
|
+
readonly meta: {
|
|
706
|
+
readonly requestId: 'req_01JXYZ';
|
|
707
|
+
readonly version: '1.0';
|
|
708
|
+
readonly total: 1;
|
|
709
|
+
};
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
}];
|
|
713
|
+
};
|
|
714
|
+
};
|
|
715
|
+
}>;
|