{"_id":"@adveron/sdk","_rev":"4-c8824b9c3ef798f5d8c645a410dadc40","name":"@adveron/sdk","dist-tags":{"latest":"0.4.0"},"versions":{"0.1.0":{"name":"@adveron/sdk","version":"0.1.0","keywords":["adveron","brand-intelligence","api","sdk","openapi"],"license":"UNLICENSED","_id":"@adveron/sdk@0.1.0","maintainers":[{"name":"waldofyi","email":"eng@waldo.fyi"},{"name":"jesse.rogers","email":"jesse@waldo.fyi"}],"homepage":"https://github.com/waldo-fyi/waldo-agentic#readme","bugs":{"url":"https://github.com/waldo-fyi/waldo-agentic/issues"},"dist":{"shasum":"444bf72bddaa47e449fe235c1a448f325b094032","tarball":"https://registry.npmjs.org/@adveron/sdk/-/sdk-0.1.0.tgz","fileCount":74,"integrity":"sha512-aFNPmOOp2Vw/1sFTPUohETd37F4jV3WxTekkjVP/azoRXBOD4X5QZ1qO8NHVJaSJOx/stc8aaCpA3zrzwz7SsQ==","signatures":[{"sig":"MEYCIQCNLgT7+5eZC5rBzU9N5prduiURiqKso6f8+9zMbOE6RgIhAK4leZ2Psjkt4U6QEapWWsYD8dk9aVSHCcIZq993YjkV","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1171878},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"test":"vitest","build":"tsc","smoke":"node --input-type=module -e 'import \"./dist/index.js\"'","codegen":"openapi-ts","test:ci":"vitest run","sdk:check":"pnpm codegen:refresh && pnpm sdk:assert-clean","spec:pull":"pnpm --filter @adveron/api sdk:spec","type-check":"tsc --noEmit && tsc -p tsconfig.test.json","prepublishOnly":"pnpm sdk:check && pnpm build && pnpm smoke","codegen:refresh":"pnpm spec:pull && pnpm codegen","sdk:assert-clean":"git diff --exit-code HEAD -- openapi.json openapi.sha256 src/generated && { test -z \"$(git status --porcelain -- openapi.json openapi.sha256 src/generated)\" || { echo 'sdk:check: regeneration produced files that are not committed:'; git status --porcelain -- openapi.json openapi.sha256 src/generated; exit 1; }; }"},"_npmUser":{"name":"waldofyi","email":"eng@waldo.fyi"},"repository":{"url":"git+https://github.com/waldo-fyi/waldo-agentic.git","type":"git","directory":"packages/adveron-sdk"},"_npmVersion":"10.8.2","description":"TypeScript client for the Adveron public API — generated from the OpenAPI spec","directories":{},"_nodeVersion":"20.19.2","dependencies":{"@hey-api/client-fetch":"^0.10.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"dotenv":"^17.2.3","vitest":"^3.2.4","postgres":"^3.4.7","typescript":"5.7.3","drizzle-orm":"^0.45.2","@hey-api/openapi-ts":"^0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.0_1787623502549_0.7977804133221134","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@adveron/sdk","version":"0.2.0","keywords":["adveron","brand-intelligence","api","sdk","openapi"],"license":"UNLICENSED","_id":"@adveron/sdk@0.2.0","maintainers":[{"name":"waldofyi","email":"eng@waldo.fyi"},{"name":"jesse.rogers","email":"jesse@waldo.fyi"}],"homepage":"https://github.com/waldo-fyi/waldo-agentic#readme","bugs":{"url":"https://github.com/waldo-fyi/waldo-agentic/issues"},"dist":{"shasum":"febf7a940fb475486f259e5cedaa6f16c9fe1638","tarball":"https://registry.npmjs.org/@adveron/sdk/-/sdk-0.2.0.tgz","fileCount":74,"integrity":"sha512-ap78kb28BRjK7NpF9ktNVvyP/l/qx7XG4fr5sL1nxZVnS0hodi8q8ZiUYsATF6PsRj9Rp9eI8W4YffzNuqvuZQ==","signatures":[{"sig":"MEUCIQCn2Fcw9GjgVOVESv3OhmNLrV7fNk6J6LSMkZeokCBULgIgdUfClmToA8Ci0Lxb4pLld3nii6FGSTVdNMWLwvcigGg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1132290},"main":"dist/index.js","type":"module","_from":"file:adveron-sdk-0.2.0.tgz","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"test":"vitest","build":"tsc","smoke":"node --input-type=module -e 'import \"./dist/index.js\"'","codegen":"openapi-ts","test:ci":"vitest run","sdk:check":"pnpm codegen:refresh && pnpm sdk:assert-clean","spec:pull":"pnpm --filter @adveron/api sdk:spec","type-check":"tsc --noEmit && tsc -p tsconfig.test.json","codegen:refresh":"pnpm spec:pull && pnpm codegen","sdk:assert-clean":"git diff --exit-code HEAD -- openapi.json openapi.sha256 src/generated && { test -z \"$(git status --porcelain -- openapi.json openapi.sha256 src/generated)\" || { echo 'sdk:check: regeneration produced files that are not committed:'; git status --porcelain -- openapi.json openapi.sha256 src/generated; exit 1; }; }"},"_npmUser":{"name":"waldofyi","email":"eng@waldo.fyi"},"_resolved":"/private/var/folders/xn/c1xrrw591n702_1m2b9y8xwh0000gn/T/f41a17b817e7ebc94d39e59430804278/adveron-sdk-0.2.0.tgz","_integrity":"sha512-ap78kb28BRjK7NpF9ktNVvyP/l/qx7XG4fr5sL1nxZVnS0hodi8q8ZiUYsATF6PsRj9Rp9eI8W4YffzNuqvuZQ==","repository":{"url":"git+https://github.com/waldo-fyi/waldo-agentic.git","type":"git","directory":"packages/adveron-sdk"},"_npmVersion":"10.8.2","description":"TypeScript client for the Adveron public API — generated from the OpenAPI spec","directories":{},"_nodeVersion":"20.19.2","dependencies":{"@hey-api/client-fetch":"^0.10.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"dotenv":"^17.2.3","vitest":"^3.2.4","postgres":"^3.4.7","typescript":"5.7.3","drizzle-orm":"^0.45.2","@hey-api/openapi-ts":"^0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.0_1788903280020_0.27219659769612337","host":"s3://npm-registry-packages-npm-production"}},"0.3.0":{"name":"@adveron/sdk","version":"0.3.0","keywords":["adveron","brand-intelligence","api","sdk","openapi"],"license":"MIT","_id":"@adveron/sdk@0.3.0","maintainers":[{"name":"waldofyi","email":"eng@waldo.fyi"},{"name":"jesse.rogers","email":"jesse@waldo.fyi"}],"homepage":"https://github.com/waldo-fyi/waldo-agentic#readme","bugs":{"url":"https://github.com/waldo-fyi/waldo-agentic/issues"},"dist":{"shasum":"c2f7aeb5d4f95fbf68b96176e34c420f3780ab13","tarball":"https://registry.npmjs.org/@adveron/sdk/-/sdk-0.3.0.tgz","fileCount":75,"integrity":"sha512-iRzEL9Xc5SNAA3xanV89cxvKfkcpfNVnTWVO2BYa/icSN3gIQpikyfvXgoqFUqyd2bfkSlWnre8CRRU+kzqsVg==","signatures":[{"sig":"MEQCIBB3DnM0t5fjQdKDDbIZVJDxTRk2ha6NCGteNBnq7dVBAiAgkjAXBWe0UYb9nKI5JZk9wZ8Mv4XNcnt73iGUrTP11A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIE+FtxPTVPj42fOTLNyJVVJiUq2GUgJHZ3eMLc571g/UAiAuE2cZBqiM88EczNgA8H5TSCRMi8qdGWVYMU/ueIUknA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1570298},"main":"dist/index.js","type":"module","_from":"file:/home/runner/work/_temp/tarball/adveron-sdk-0.3.0.tgz","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"test":"vitest","build":"tsc","smoke":"node --input-type=module -e 'import \"./dist/index.js\"'","codegen":"openapi-ts","test:ci":"vitest run","sdk:check":"pnpm codegen:refresh && pnpm sdk:assert-clean","spec:pull":"pnpm --filter @adveron/api sdk:spec","type-check":"tsc --noEmit && tsc -p tsconfig.test.json","codegen:refresh":"pnpm spec:pull && pnpm codegen","sdk:assert-clean":"git diff --exit-code HEAD -- openapi.json openapi.sha256 src/generated && { test -z \"$(git status --porcelain -- openapi.json openapi.sha256 src/generated)\" || { echo 'sdk:check: regeneration produced files that are not committed:'; git status --porcelain -- openapi.json openapi.sha256 src/generated; exit 1; }; }"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:4ef31d0a-552e-4cb3-ac66-e15e1900a56f"}},"_resolved":"/home/runner/work/_temp/tarball/adveron-sdk-0.3.0.tgz","_integrity":"sha512-iRzEL9Xc5SNAA3xanV89cxvKfkcpfNVnTWVO2BYa/icSN3gIQpikyfvXgoqFUqyd2bfkSlWnre8CRRU+kzqsVg==","repository":{"url":"git+https://github.com/waldo-fyi/waldo-agentic.git","type":"git","directory":"packages/adveron-sdk"},"_npmVersion":"11.19.1","description":"TypeScript client for the Adveron public API — generated from the OpenAPI spec","directories":{},"_nodeVersion":"24.20.0","dependencies":{"@hey-api/client-fetch":"^0.10.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"dotenv":"^17.2.3","vitest":"^3.2.4","postgres":"^3.4.7","typescript":"5.7.3","drizzle-orm":"^0.45.2","@hey-api/openapi-ts":"^0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.0_1789859433148_0.9816952455623882","host":"s3://npm-registry-packages-npm-production"}},"0.4.0":{"_id":"@adveron/sdk@0.4.0","bugs":{"url":"https://github.com/waldo-fyi/waldo-agentic/issues"},"dist":{"shasum":"7aba583f84c77fd1ff784446bf7c36a7b2c20f18","tarball":"https://registry.npmjs.org/@adveron/sdk/-/sdk-0.4.0.tgz","fileCount":75,"integrity":"sha512-rhpTyxKLxJkRh1g7jwU0yhd3GGzGl0gsWmmU57syb5FkrvyK78BjGOCn6RYYpDjO8+V6GLH7K0SZY6BYswygIQ==","signatures":[{"sig":"MEQCIC42E7Lsweib7ZFQY3bthmZ3bxsIZFX6jDl0NzQZWoEqAiAiDi4LkriSrvIPH5EtOov1uXbeD7/KpweYb6mcxoObCA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGkj7cf10MBWgmJZp4zN3d+hqBS9BrawwD3t6UMOWFaxAiEAhCBpDotfOiWRtPDL53SeSiPdNQSSsuhwbPgll4gWH40="}],"unpackedSize":1588274},"main":"dist/index.js","name":"@adveron/sdk","type":"module","_from":"file:/home/runner/work/_temp/tarball/adveron-sdk-0.4.0.tgz","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"license":"MIT","scripts":{"test":"vitest","build":"tsc","smoke":"node --input-type=module -e 'import \"./dist/index.js\"'","codegen":"openapi-ts","test:ci":"vitest run","sdk:check":"pnpm codegen:refresh && pnpm sdk:assert-clean","spec:pull":"pnpm --filter @adveron/api sdk:spec","type-check":"tsc --noEmit && tsc -p tsconfig.test.json","codegen:refresh":"pnpm spec:pull && pnpm codegen","sdk:assert-clean":"git diff --exit-code HEAD -- openapi.json openapi.sha256 src/generated && { test -z \"$(git status --porcelain -- openapi.json openapi.sha256 src/generated)\" || { echo 'sdk:check: regeneration produced files that are not committed:'; git status --porcelain -- openapi.json openapi.sha256 src/generated; exit 1; }; }"},"version":"0.4.0","_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:4ef31d0a-552e-4cb3-ac66-e15e1900a56f"}},"homepage":"https://github.com/waldo-fyi/waldo-agentic#readme","keywords":["adveron","brand-intelligence","api","sdk","openapi"],"_resolved":"/home/runner/work/_temp/tarball/adveron-sdk-0.4.0.tgz","_integrity":"sha512-rhpTyxKLxJkRh1g7jwU0yhd3GGzGl0gsWmmU57syb5FkrvyK78BjGOCn6RYYpDjO8+V6GLH7K0SZY6BYswygIQ==","repository":{"url":"git+https://github.com/waldo-fyi/waldo-agentic.git","type":"git","directory":"packages/adveron-sdk"},"_npmVersion":"11.19.1","description":"TypeScript client for the Adveron public API — generated from the OpenAPI spec","directories":{},"maintainers":[{"name":"waldofyi","email":"eng@waldo.fyi"},{"name":"jesse.rogers","email":"jesse@waldo.fyi"}],"_nodeVersion":"24.20.0","dependencies":{"@hey-api/client-fetch":"^0.10.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"dotenv":"^17.2.3","vitest":"^3.2.4","postgres":"^3.4.7","typescript":"5.7.3","drizzle-orm":"^0.45.2","@hey-api/openapi-ts":"^0.99.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.4.0_1790098222374_0.05492685185417101"}}},"time":{"created":"2026-08-25T02:05:02.268Z","modified":"2026-09-22T17:30:22.689Z","0.1.0":"2026-08-25T02:05:02.677Z","0.2.0":"2026-09-08T21:34:40.154Z","0.3.0":"2026-09-19T23:10:33.228Z","0.4.0":"2026-09-22T17:30:22.495Z"},"bugs":{"url":"https://github.com/waldo-fyi/waldo-agentic/issues"},"license":"MIT","homepage":"https://github.com/waldo-fyi/waldo-agentic#readme","keywords":["adveron","brand-intelligence","api","sdk","openapi"],"repository":{"url":"git+https://github.com/waldo-fyi/waldo-agentic.git","type":"git","directory":"packages/adveron-sdk"},"description":"TypeScript client for the Adveron public API — generated from the OpenAPI spec","maintainers":[{"name":"waldofyi","email":"eng@waldo.fyi"},{"name":"jesse.rogers","email":"jesse@waldo.fyi"}],"readme":"# @adveron/sdk\n\nTypeScript client for the Adveron public API — the tenant `/v1` surface, generated from the API's own OpenAPI document. Runs in Node (18+) and the browser; the transport is `fetch`.\n\nThe client is **generated, not hand-written**. Every operation, every request shape, and every response type comes from the same registered operations the server dispatches, so the client cannot describe a surface the API does not serve.\n\n## Install\n\n```bash\npnpm add @adveron/sdk\n```\n\n## Authentication\n\nEvery call authenticates with a workspace API key as a bearer token. Configure the shared client once:\n\n```ts\nimport { client } from \"@adveron/sdk\";\n\nclient.setConfig({\n  baseUrl: \"https://api.adveron.com\",\n  auth: () => process.env.ADVERON_API_KEY!,\n});\n```\n\nOr build an isolated client (useful when one process serves several workspaces):\n\n```ts\nimport { createClient, createConfig } from \"@adveron/sdk\";\n\nconst adveron = createClient(\n  createConfig({ baseUrl: \"https://api.adveron.com\", auth: () => apiKey })\n);\n```\n\nEvery operation accepts a `client` option, so a per-request client needs no global state.\n\n## Responses\n\nOperations return `{ data, error }` — never a throw on an HTTP status. A successful body is `{ data, meta }`, where `meta` always carries the `request_id` that also rides the `X-Request-Id` response header.\n\nFailures carry the house envelope, `{ error: { code, message, request_id, details? } }`. `isAdveronError` narrows it:\n\n```ts\nimport { brandGet, isAdveronError } from \"@adveron/sdk\";\n\nconst { data, error } = await brandGet({ path: { id: brandId } });\nif (isAdveronError(error)) {\n  // error.error.code is one of the stable machine codes — e.g.\n  // \"resource_not_activated\", \"insufficient_credits\", \"rate_limited\"\n  console.error(error.error.code, error.error.request_id);\n}\n```\n\nQuote `request_id` in a support request: it joins our logs, traces, and the credit ledger.\n\n## One example per group\n\n**Brands** — search first; every other brand operation takes an id, not a name.\n\n```ts\nimport { brandSearch, brandGet } from \"@adveron/sdk\";\n\nconst { data: found } = await brandSearch({ query: { q: \"nike\", limit: 5 } });\nconst { data: brand } = await brandGet({\n  path: { id: found!.data.items[0].id },\n});\n```\n\n**Categories**\n\n```ts\nimport { categoryList } from \"@adveron/sdk\";\n\nconst { data } = await categoryList();\n// data.data.items[0].subcategories — the launched children under each category\n```\n\n**Audiences**\n\n```ts\nimport { audienceGet } from \"@adveron/sdk\";\n\nconst { data } = await audienceGet({ path: { id: \"AUD123\" } });\n```\n\n**Balance & usage**\n\n```ts\nimport { balanceGet, usageSummary } from \"@adveron/sdk\";\n\nconst { data: balance } = await balanceGet();\nconst { data: usage } = await usageSummary({\n  query: { group_by: \"WORKSPACE\" },\n});\n```\n\n## Metering headers\n\nSuccessful responses carry `X-Credits-Charged` / `X-Credits-Reason` and the organization's purchased throughput as `RateLimit-*`. Reads answer `Cache-Control: no-store`. Send an `Idempotency-Key` header to make a call safe to retry — recommended on metered `GET`s, where an auto-retried read would otherwise double-charge.\n\n## Reference\n\nThe full operation reference, with request and response shapes for every `/v1` endpoint, is the API's own interactive documentation at `https://api.adveron.com/v1/docs` — the same OpenAPI document this client is generated from.\n","readmeFilename":"README.md"}