@nuxtseo/protocol 0.1.0

package/dist/v1/account.js

@@ -0,0 +1,123 @@
+import { z as schema } from 'zod';
+import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1MetaClientSchema, publicV1MetaProducerSchema, publicV1StandardRatePolicy, } from './core.js';
+export const usageMeterGroupSchema = schema.enum(['integrations', 'compute', 'capacity']);
+export const usageUpgradeTierSchema = schema.enum(['free', 'search', 'full', 'pro', 'agency', 'lifetime']);
+export const usagePlanSchema = usageUpgradeTierSchema;
+export const accountUsageQuerySchema = schema.strictObject({
+    group: usageMeterGroupSchema.optional(),
+});
+export const usageMeterProducerSchema = schema.strictObject({
+    key: schema.string().min(1),
+    label: schema.string().min(1),
+    description: schema.string().min(1),
+    group: usageMeterGroupSchema,
+    unit: schema.string().min(1),
+    used: schema.number().nonnegative(),
+    limit: schema.number().nonnegative().nullable(),
+    blocked: schema.boolean(),
+    overCap: schema.boolean(),
+    resetsAt: schema.iso.datetime().nullable(),
+    upgradeCopy: schema.array(schema.strictObject({
+        tier: usageUpgradeTierSchema,
+        gain: schema.string().min(1),
+    })),
+});
+export const usageMeterClientSchema = schema.looseObject({
+    key: schema.string().min(1),
+    label: schema.string().min(1),
+    description: schema.string().min(1),
+    group: usageMeterGroupSchema,
+    unit: schema.string().min(1),
+    used: schema.number().nonnegative(),
+    limit: schema.number().nonnegative().nullable(),
+    blocked: schema.boolean(),
+    overCap: schema.boolean(),
+    resetsAt: schema.iso.datetime().nullable(),
+    upgradeCopy: schema.array(schema.looseObject({
+        tier: usageUpgradeTierSchema,
+        gain: schema.string().min(1),
+    })),
+});
+export const accountUsageDataSchema = defineResponseObject({
+    plan: usagePlanSchema,
+    meters: schema.array(usageMeterProducerSchema),
+}, {
+    plan: usagePlanSchema,
+    meters: schema.array(usageMeterClientSchema),
+});
+export const accountUsageMetaSchema = defineResponseObject({ ...publicV1MetaProducerSchema.shape, total: schema.number().int().nonnegative() }, { ...publicV1MetaClientSchema.shape, total: schema.number().int().nonnegative() });
+export const accountUsageResponseSchema = defineSuccessEnvelope(accountUsageDataSchema, accountUsageMetaSchema);
+export const accountUsageOperation = defineOperation({
+    id: 'account.usage',
+    method: 'GET',
+    path: '/api/v1/account/usage',
+    visibility: 'public',
+    semantics: {
+        kind: 'query',
+        sideEffects: 'none',
+        retry: 'idempotent',
+        readConsistency: 'primary',
+    },
+    auth: {
+        credentials: ['session', 'api_token'],
+        scopes: ['account:read'],
+        minimumRole: 'viewer',
+        ownership: 'team',
+    },
+    request: {
+        params: null,
+        query: accountUsageQuerySchema,
+        headers: null,
+        body: null,
+    },
+    responses: { 200: accountUsageResponseSchema },
+    errors: ['invalid_request', 'unauthorized', 'auth_expired', 'forbidden', 'rate_limited', 'contract_violation', 'internal_error'],
+    errorResponse: publicV1ErrorEnvelope,
+    resources: {
+        reads: [{ type: 'account.usage', idFrom: 'team.id' }],
+        changes: [],
+    },
+    policy: {
+        rate: publicV1StandardRatePolicy,
+        idempotency: { _tag: 'none' },
+        entitlement: null,
+        meter: null,
+    },
+    lifecycle: { introduced: '1.0.0' },
+    docs: {
+        summary: 'Read account usage',
+        description: 'Returns current Team-scoped public meter readings without spending quota.',
+        tags: ['Account'],
+        examples: [{
+                request: { query: {} },
+                response: {
+                    status: 200,
+                    body: {
+                        data: {
+                            plan: 'pro',
+                            meters: [{
+                                    key: 'dataforseo',
+                                    label: 'Research lookups',
+                                    description: 'Third-party research requests used by live market analysis.',
+                                    group: 'integrations',
+                                    unit: 'requests',
+                                    used: 8,
+                                    limit: 100,
+                                    blocked: false,
+                                    overCap: false,
+                                    resetsAt: '2026-09-01T00:00:00.000Z',
+                                    upgradeCopy: [{ tier: 'agency', gain: 'Increase monthly research capacity.' }],
+                                }],
+                        },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0', total: 1 },
+                    },
+                },
+            }],
+    },
+});
+export const accountV1Registry = defineRegistry({
+    feature: 'account',
+    operations: {
+        usage: accountUsageOperation,
+    },
+});